pbs_tape_backup_job_update
Update a PBS tape backup job's configuration parameters such as pool, drive, schedule, and filters. Supports dry-run planning before applying changes.
Instructions
MUTATION: update a PBS tape backup job.
RISK_MEDIUM: changes which drive/pool/store/schedule/filters this SCHEDULED job uses on its next run. Dry-run by default (captures current config into the PLAN); confirm=True executes (PUT /config/tape-backup-job/{id}, synchronous — PBS returns null) and returns {"status": "ok", "result": None}. Needs PROXIMO_PBS_* config.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ns | No | New namespace. | |
| pool | No | New media pool name. | |
| drive | No | New drive identifier. | |
| store | No | New datastore name. | |
| delete | No | Property names to clear. | |
| digest | No | Optimistic-lock: 64-char lowercase hex SHA-256 of the config PBS last returned. | |
| job_id | Yes | ID of the existing tape backup job to update. | |
| comment | No | New comment. | |
| confirm | No | False (default) returns a dry-run PLAN only; True executes the update. | |
| schedule | No | New calendar-event schedule. | |
| max_depth | No | New namespace depth (0-7). | |
| eject_media | No | Eject media upon job completion. | |
| latest_only | No | Back up latest snapshots only. | |
| notify_user | No | New notify-user (user@realm). | |
| group_filter | No | New group filters. | |
| 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. | |
| worker_threads | No | New worker-thread count (1-32). | |
| export_media_set | No | Export media set upon job completion. | |
| notification_mode | No | 'legacy-sendmail' or 'notification-system'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |