VMware CreateVmSnapshot

VMware CreateVmSnapshot

Certified
Enterprise Edition

Create a snapshot for a VM on ESXi

Takes a snapshot of the specified VM. Optional memory capture and quiesce flags default to false.

yaml
type: io.kestra.plugin.ee.vmware.esxi.CreateVmSnapshot

Create a snapshot of a VM by name

yaml
id: create_vm_snapshot
namespace: company.team

tasks:
  - id: create_snapshot
    type: io.kestra.plugin.ee.vmware.esxi.CreateVmSnapshot
    server: "esxi.mycompany.com"
    username: "{{ secret('VMWARE_ESXI_USERNAME') }}"
    password: "{{ secret('VMWARE_ESXI_PASSWORD') }}"
    vmName: "vm-to-snapshot"
    snapshotName: "daily-backup-2025-07-18"
    description: "Daily automated backup"
Properties

Password

Server hostname or IP

FQDN or IP of the vCenter or ESXi endpoint (no scheme or port).

Snapshot description

Snapshot name

Username

e.g. Administrator@vsphere.local for vCenter or root for ESXi.

VM name

Defaultfalse

Capture VM memory

Default: false. If true, includes RAM for exact resume; otherwise only disk state is saved.

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

Default443

Server port

Defaults to 443.

Defaultfalse

Quiesce guest before snapshot

Default: false. Requires VMware Tools; pauses disk I/O to improve filesystem consistency.

Trust store path

Optional path to a PKCS12 trust store containing the CA certificate(s) used to validate the vCenter/ESXi server's TLS certificate. If omitted (or if the path does not exist), the JVM's default trust store (system CA certificates) is used instead. Certificate validation is always enforced; this plugin never disables TLS certificate validation.