pbs_tape_pool_update
Update a PBS tape media pool's allocation, retention, encryption, comment, or template. Dry-run by default; confirm to apply changes that affect future backup jobs.
Instructions
MUTATION: update a PBS tape media pool.
RISK_MEDIUM: changes allocation/retention policy and/or the encryption-key association — future tape-backup jobs writing into this pool target/reuse tapes under the new policy on their next run. NO digest/optimistic-lock param exists on this endpoint at all (schema- verified — see module docstring). Dry-run by default (captures current config into the PLAN); confirm=True executes (PUT /config/media-pool/{name}, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. No snapshot primitive; re-apply the captured config to revert. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the existing media pool to update. | |
| delete | No | Property names to clear: any of allocation/retention/template/encrypt/comment. | |
| comment | No | New comment (no control characters, <=128 chars). | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the update. | |
| encrypt | No | New tape encryption key fingerprint association. | |
| template | No | New media set naming template. | |
| retention | No | New retention policy: 'overwrite', 'keep', or a time span. | |
| allocation | No | New allocation policy: 'continue', 'always', or a calendar event. | |
| 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 |