pve_restore
Restore a Proxmox guest from a backup archive using a dry-run plan. Confirm to execute, overwriting or creating the guest.
Instructions
MUTATION (DESTRUCTIVE if it overwrites an existing guest): restore a guest from a backup archive. Dry-run by default — the PLAN reads live guest state and states whether it CREATES or OVERWRITES. confirm=True to execute. Async — returns a task UPID. Find the archive's volid first with pve_backup_list.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | No | Guest type: lxc or qemu. | lxc |
| node | No | Proxmox node to restore onto; defaults to the configured node if omitted. | |
| pool | No | Resource pool to place the restored guest in. | |
| vmid | Yes | Numeric ID for the restored guest — new if free, existing to overwrite. | |
| force | No | If vmid already exists, overwrite/destroy the existing guest instead of failing. | |
| archive | Yes | Volume ID of the backup archive to restore from. | |
| confirm | No | Gate: false returns a dry-run PLAN, true executes the restore. | |
| storage | Yes | Storage ID to restore the guest's disks onto (LXC only; ignored for QEMU). | |
| 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 |