pve_backup_job_create
Set up a scheduled PVE backup job for selected guests or pools. Dry-run shows plan; confirm to apply without altering existing backups.
Instructions
MUTATION: create a PVE cluster backup job. Dry-run by default — shows the plan. confirm=True to execute. Config-only; existing backups are NOT affected. Guest selection is mutually exclusive — pass at most one of: vmid (CSV of guest IDs), all_guests=True (every guest), or pool (a resource pool); PVE requires a selection. exclude (CSV) filters all_guests.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | ||
| pool | No | ||
| vmid | No | ||
| job_id | Yes | ||
| comment | No | ||
| confirm | No | ||
| enabled | No | ||
| exclude | No | ||
| storage | Yes | ||
| compress | No | ||
| schedule | Yes | ||
| all_guests | No | ||
| 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 |