pve_snapshot_create
Create a snapshot restore point for a Proxmox guest. Dry-run by default; set confirm=True to execute.
Instructions
MUTATION: create a snapshot (a restore point). Dry-run by default; confirm=True to execute. Async — returns the task UPID; poll pve_task_status. Needs snapshot-capable storage (ZFS/BTRFS/LVM-thin). To restore to a snapshot use pve_rollback; to remove one use pve_snapshot_delete; to list them use pve_snapshot_list.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Guest type: `lxc` for a container or `qemu` for a VM. | lxc |
| node | No | PVE node the guest runs on. Omit to resolve it automatically from the cluster. | |
| vmid | Yes | Numeric ID of the guest — VMID for a QEMU VM or CTID for an LXC container. | |
| confirm | No | Leave `false` (default) to get a dry-run PLAN; set `true` to execute the snapshot creation. | |
| snapname | Yes | Name for the new snapshot. | |
| description | No | Optional free-text description stored on the snapshot. | |
| 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 |