pbs_tape_drive_restore_key
Restore a tape encryption key from a drive's mounted media by providing the password used to protect the key. Supports dry-run planning before execution.
Instructions
MUTATION: try to restore a tape encryption key from a drive's mounted media.
RISK_MEDIUM: on success, changes what tape content becomes decryptable going forward — mirrors
pbs_tape_key_create's rating. SECRET CONTRACT: password is NEVER written to the audit ledger
or returned in the dry-run PLAN — forwarded RAW only to the real PBS API on confirm=True.
confirm=True executes (POST /tape/drive/{drive}/restore-key, synchronous) and returns
{"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| drive | Yes | Drive identifier. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the restore attempt. | |
| password | Yes | The password the tape encryption key was protected with. | |
| 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
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |