
Proxmox VE Create
CertifiedCreate a backup of a VM or container on Proxmox VE
Proxmox VE Create
Create a backup of a VM or container on Proxmox VE
Creates a vzdump backup via POST /nodes/{node}/vzdump. Supports snapshot, suspend, and stop modes. Compress defaults to zstd.
type: io.kestra.plugin.proxmox.backup.CreateExamples
Backup a VM to local storage
id: create_backup
namespace: company.team
tasks:
- id: backup
type: io.kestra.plugin.proxmox.backup.Create
host: "{{ secret('PROXMOX_HOST') }}"
username: "{{ secret('PROXMOX_USERNAME') }}"
password: "{{ secret('PROXMOX_PASSWORD') }}"
node: pve
vmName: my-vm
storage: local
mode: snapshot
compress: zstd
Properties
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 ID where the backup is written.
vmName *Requiredstring
VM or container name or ID
VM or container name (resolved at runtime) or integer VMID.
compress string
zstdCompression
Compression algorithm: 0 (none), lzo, gzip, or zstd. Defaults to zstd.
mode string
snapshotBackup mode
snapshot, suspend, or stop. Defaults to snapshot.
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.
timeout string
PT1HTask timeout
Maximum time to wait for the backup 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.