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 *string
Backup archive volid
Volume ID of the backup, e.g. local: backup/vzdump-....vma.zst.
host *string
Proxmox host
Hostname or IP address of the Proxmox VE node (no scheme, no port).
node *string
Proxmox node name
Name of the cluster node that scopes all API calls (e.g. pve, node1).
storage *string
Target storage
Storage where the restored disk images are placed.
vmId *integerstring
New VM or container ID to assign
Integer VMID to assign to the restored resource. Must be unique in the cluster.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150password string
Password
Password for ticket-based authentication.
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.
