VMware CreateVmSnapshot
CertifiedEnterprise EditionCreate a snapshot for a vCenter VM
VMware CreateVmSnapshot
Create a snapshot for a vCenter VM
Takes a snapshot of the specified VM. Optional memory capture and quiesce flags default to false.
type: io.kestra.plugin.ee.vmware.vcenter.CreateVmSnapshotExamples
Create a snapshot of a VM by name (vCenter)
id: create_vm_snapshot
namespace: company.team
tasks:
- id: create_snapshot
type: io.kestra.plugin.ee.vmware.vcenter.CreateVmSnapshot
server: "vcenter.mycompany.com"
username: "{{ secret('VMWARE_VCENTER_USERNAME') }}"
password: "{{ secret('VMWARE_VCENTER_PASSWORD') }}"
vmName: "vm-to-snapshot"
snapshotName: "daily-backup-2025-07-18"
snapshotDescription: "Daily automated backup"
memory: true
quiesce: false
Properties
password *Requiredstring
Password
server *Requiredstring
Server hostname or IP
FQDN or IP of the vCenter or ESXi endpoint (no scheme or port).
snapshotDescription *Requiredstring
Snapshot description
snapshotName *Requiredstring
Snapshot name
username *Requiredstring
Username
e.g. Administrator@vsphere.local for vCenter or root for ESXi.
vmName *Requiredstring
VM name
memory booleanstring
falseCapture VM memory
Default: false. If true, includes RAM for exact resume; otherwise only disk state is saved.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
port integerstring
443Server port
Defaults to 443.
quiesce booleanstring
falseQuiesce guest before snapshot
Default: false. Requires VMware Tools; pauses disk I/O to improve filesystem consistency.
trustStorePath string
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.
