Proxmox VE Create

Proxmox VE Create

Certified

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.

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

Backup a VM to local storage

yaml
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

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 ID where the backup is written.

VM or container name or ID

VM or container name (resolved at runtime) or integer VMID.

Defaultzstd

Compression

Compression algorithm: 0 (none), lzo, gzip, or zstd. Defaults to zstd.

Defaultsnapshot

Backup mode

snapshot, suspend, or stop. Defaults to snapshot.

Password

Password for ticket-based authentication.

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

Default8006

API port

Defaults to 8006.

DefaultPT1H

Task timeout

Maximum time to wait for the backup 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.