pbs_tape_drive_format
Format a tape drive's media, with dry-run planning and optional label verification to prevent accidental destruction.
Instructions
MUTATION: format (ERASE) a drive's mounted media.
RISK_HIGH: DESTROYS ALL DATA on the mounted tape, no undo. If label_text is supplied, PBS
cancels the format on a mismatch — real, but OPT-IN, protection. Omitting it formats whatever
is loaded UNCONDITIONALLY. Dry-run by default (returns a PLAN); confirm=True executes (POST
/tape/drive/{drive}/format-media) and returns {"status": "submitted", "result": ""}.
Needs PROXIMO_PBS_* config.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fast | No | Use fast erase (PBS default: True if omitted). | |
| drive | Yes | Drive identifier. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the format. | |
| label_text | No | If given, PBS cancels the format when the MOUNTED tape's own current label doesn't match this value — protects against formatting the wrong cartridge. Omit and PBS formats unconditionally. | |
| load_barcode | No | If given, PBS first loads the cartridge carrying this barcode from the changer, THEN formats it (implicit load-then-format). | |
| 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 |