pve_backup_job_create
Schedule persistent vzdump backups for PVE cluster guests. Dry-run by default; confirm=True to execute and create the job synchronously.
Instructions
MUTATION: create a PVE cluster backup job — a persistent vzdump schedule, distinct from a one-off pve_backup run. Dry-run by default; confirm=True to execute and returns synchronously (no task UPID). Config-only; existing backups are NOT affected. Guest selection is mutually exclusive — pass at most one of vmid, all_guests, or pool; exclude filters all_guests. To modify an existing job use pve_backup_job_update; to remove one use pve_backup_job_delete.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Backup mode: snapshot | suspend | stop; defaults to Proxmox's own default if omitted. | |
| pool | No | Resource pool of guests to back up; mutually exclusive with vmid and all_guests. | |
| vmid | No | CSV of guest IDs to include; mutually exclusive with all_guests and pool. | |
| job_id | Yes | Unique ID for the new PVE backup job. | |
| comment | No | Free-text note stored on the job. | |
| confirm | No | Gate: false returns a dry-run PLAN, true executes the creation. | |
| enabled | No | Whether the job is active; defaults to enabled if omitted. | |
| exclude | No | CSV of guest IDs to exclude when all_guests=True. | |
| storage | Yes | Storage ID the job writes backups to. | |
| compress | No | Compression algorithm for archives, e.g. zstd, gzip, lzo, or 0 (no compression). | |
| schedule | Yes | Proxmox calendar-event schedule string, e.g. 'sat 02:00' or a systemd.time-style spec. | |
| all_guests | No | If true, back up every guest on the cluster; mutually exclusive with vmid and pool. | |
| 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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |