
Proxmox VE Restore
CertifiedRestore a backup to a QEMU VM or LXC container on Proxmox VE
Proxmox VE Restore
Restore a backup to a QEMU VM or LXC container on Proxmox VE
Restores a vzdump backup archive to a new VM or container. Set resourceType to vm (default) for QEMU or container for LXC. The archive parameter must be a valid volid, e.g. local: backup/vzdump-qemu-100-....vma.zst.
type: io.kestra.plugin.proxmox.backup.RestoreExamples
Restore a VM backup
id: restore_backup
namespace: company.team
tasks:
- id: restore
type: io.kestra.plugin.proxmox.backup.Restore
host: "{{ secret('PROXMOX_HOST') }}"
username: "{{ secret('PROXMOX_USERNAME') }}"
password: "{{ secret('PROXMOX_PASSWORD') }}"
node: pve
vmId: 200
archive: "local:backup/vzdump-qemu-100-2024_01_01-00_00_00.vma.zst"
storage: local-lvm
resourceType: vm
Properties
archive *Requiredstring
Backup archive volid
Volume ID of the backup, e.g. local: backup/vzdump-....vma.zst.
host *Requiredstring
Proxmox host
Hostname or IP address of the Proxmox VE node (no scheme, no port).
node *Requiredstring
Proxmox node name
Name of the cluster node that scopes all API calls (e.g. pve, node1).
storage *Requiredstring
Target storage
Storage where the restored disk images are placed.
vmId *Requiredintegerstring
New VM or container ID to assign
Integer VMID to assign to the restored resource. Must be unique in the cluster.
password string
Password
Password for ticket-based authentication.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
port integerstring
8006API port
Defaults to 8006.
resourceType string
VMVMCONTAINERResource type
Resource type: vm or container.
timeout string
PT1HTask timeout
Maximum time to wait for the restore operation to complete. Defaults to 1 hour.
tokenId string
API token ID
Full token identifier in the form user@realm!tokenname (e.g. root@pam!mytoken). Use together with tokenSecret.
tokenSecret string
API token secret
The UUID secret associated with the token ID.
username string
Username
PAM or PVE user in the form user@realm (e.g. root@pam). Required when using ticket-based auth.
verifySsl booleanstring
trueVerify SSL
Validate the server TLS certificate. Defaults to true; set to false only for trusted networks with self-signed Proxmox certificates.