pbs_tape_key_update_password
Update the password and hint for a PBS tape encryption key. Provide the new password and hint; optionally supply the current password or use force to reset via the root recovery copy.
Instructions
MUTATION: change a PBS tape encryption key's password (and hint).
RISK_MEDIUM: rotates the credential protecting tape data; PBS retains a root-only recovery
copy (force=True bypasses the current-password check via it), so this is not an immediate
one-way lockout — but losing track of the new password before force is available risks
losing normal-user access to this key. SECRET CONTRACT: password/new_password are NEVER
written to the audit ledger or the dry-run PLAN. confirm=True executes (PUT
/config/tape-encryption-keys/{fingerprint}, synchronous — PBS returns null) and returns
{"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kdf | No | Key derivation function: 'none', 'scrypt' (default), or 'pbkdf2'. | |
| hint | Yes | New password hint (no control characters, 1-64 chars). REQUIRED by PBS — cannot change the password alone. | |
| force | No | Reset the passphrase using the root-only accessible copy, bypassing the current-password check. | |
| digest | No | Optimistic-lock: 64-char lowercase hex SHA-256 of the config PBS last returned. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the update. | |
| password | No | The CURRENT password — required unless force=True (which resets via PBS's root-only accessible copy). | |
| fingerprint | Yes | Fingerprint of the existing tape encryption key to update. | |
| new_password | Yes | The new password (min 5 chars). REQUIRED. | |
| 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 |