Proxmox VE Restore

Proxmox VE Restore

Certified

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.

yaml
type: io.kestra.plugin.proxmox.backup.Restore

Restore a VM backup

yaml
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

Backup archive volid

Volume ID of the backup, e.g. local: backup/vzdump-....vma.zst.

Proxmox host

Hostname or IP address of the Proxmox VE node (no scheme, no port).

Proxmox node name

Name of the cluster node that scopes all API calls (e.g. pve, node1).

Target storage

Storage where the restored disk images are placed.

New VM or container ID to assign

Integer VMID to assign to the restored resource. Must be unique in the cluster.

Password

Password for ticket-based authentication.

Reference (ref) of the pluginDefaults to apply to this task.

Default8006

API port

Defaults to 8006.

DefaultVM
Possible Values
VMCONTAINER

Resource type

Resource type: vm or container.

DefaultPT1H

Task timeout

Maximum time to wait for the restore operation to complete. Defaults to 1 hour.

API token ID

Full token identifier in the form user@realm!tokenname (e.g. root@pam!mytoken). Use together with tokenSecret.

API token secret

The UUID secret associated with the token ID.

Username

PAM or PVE user in the form user@realm (e.g. root@pam). Required when using ticket-based auth.

Defaulttrue

Verify SSL

Validate the server TLS certificate. Defaults to true; set to false only for trusted networks with self-signed Proxmox certificates.