pve_backup_job_update
Update a Proxmox VE cluster backup job configuration. Dry-run mode returns a plan; use confirm=true to apply changes.
Instructions
MUTATION: update a PVE cluster backup job. Dry-run by default — the PLAN captures current config so you can revert manually; confirm=True to execute and returns synchronously (no task UPID). Config-only; no impact on existing backups. To create a new job use pve_backup_job_create; to remove one use pve_backup_job_delete.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | New backup mode: snapshot | suspend | stop; omit to leave unchanged. | |
| vmid | No | New CSV of guest IDs the job covers; omit to leave unchanged. | |
| job_id | Yes | ID of the existing PVE backup job to update. | |
| comment | No | New free-text note; omit to leave unchanged. | |
| confirm | No | Gate: false returns a dry-run PLAN, true executes the update. | |
| enabled | No | Whether the job is active; omit to leave unchanged. | |
| storage | No | New storage ID for the job's backups; omit to leave unchanged. | |
| compress | No | New compression algorithm, e.g. zstd, gzip, lzo, or 0 (no compression); omit to leave unchanged. | |
| schedule | No | New Proxmox calendar-event schedule string; omit to leave unchanged. | |
| 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 |