pve_backup_create
Create a backup of a Proxmox VM or container using vzdump. Specify storage, backup mode, compression, and optional notes. Returns task status for long-running backups.
Instructions
Create a vzdump backup of a VM or container.
Applies to: QEMU VMs and LXC containers, located by ``vmid`` (``node``
optional and auto-resolved). ``storage`` is the target backup storage.
``mode``: ``snapshot`` (default, no downtime), ``suspend`` (brief
pause), or ``stop`` (guest is shut down for the backup). ``compress``
defaults to ``zstd`` (valid: 0, 1, gzip, lzo, zstd). ``notes`` attaches
a comment to the archive; ``{{...}}`` template variables (e.g.
``{{guestname}}``) are expanded by PVE.
Side effects: creates a backup archive on ``storage``; ``stop`` mode
shuts the guest down during the backup. Backups often outlast the
PVE_MCP_TASK_WAIT window — then ``task.status`` is "running" and the
``upid`` can be followed with pve_task_status. Returns JSON with
``vmid``/``node``/``type``/``storage``/``mode`` and ``task``.
Source: POST /nodes/{node}/vzdump.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | snapshot | |
| node | No | ||
| vmid | Yes | ||
| notes | No | ||
| storage | Yes | ||
| compress | No | zstd |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |