pve_ceph_osd_scrub
Instruct a Ceph OSD to perform a light or deep scrub. Use dry-run to plan or confirm to execute.
Instructions
MUTATION: instruct a Ceph OSD to scrub.
RISK_LOW: no logical state change; a deep scrub is I/O-heavy while it runs. No CAPTURE — scrubbing isn't a durable state to snapshot. Runs SYNCHRONOUSLY (schema: returns null) — dry-run by default (returns a PLAN); confirm=True executes (POST /nodes/{node}/ceph/osd/{osdid}/scrub) and returns {"status": "ok", "result": None}. No rollback primitive on this plane — scrubbing is not revertible (re-issue if needed).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deep | No | If True, instructs a deep scrub (reads every object's full data, I/O-heavy) instead of a light one (metadata only). Default False. | |
| node | No | PVE node the OSD is on; defaults to the configured node if omitted. | |
| osdid | Yes | OSD ID to scrub (0 is a valid id). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the scrub. | |
| proximo_target | No | Which configured Proxmox target to run this call against — a target name from your multi-target config (a specific PVE/PBS/PMG/PDM box). Omit to use the single/default target from the environment; the selection applies only to this call. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |