pluginsplugin-ee-vmwarevmware-esxi

CreateVmSnapshot​Create​Vm​Snapshot

Create a snapshot of a virtual machine on an ESXi host.

This task creates a snapshot for a specified VM on an ESXi host.

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: createSnapshot
    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

The password for authentication.

The password used to authenticate with the VMware server.

The URL of the server.

The URL to connect to the VMwareserver. This is a FQDN or an IP address (eg: esxi.mycompany.com), so without any protocol nor port.

A description for the snapshot.

The name of the snapshot to be created.

The username for authentication.

The username used to authenticate with the server. It could be something like '[email protected]' for vCenter or 'root' for ESXi.

The name of the virtual machine.

Default false

Include VM memory state in the snapshot.

If true, the snapshot will include the full memory (RAM) state of the VM. This allows an exact restore of the VM as it was, with all processes and sessions. If false, only the disk state will be saved and the VM will boot normally when reverted. Default: false.

Default 443

The port for the connection.

The port to connect to the server. Default is 443.

Default false

Quiesce the VM before taking the snapshot.

If true, VMware Tools will pause disk I/O operations before taking the snapshot, ensuring file system consistency (especially useful for DBs or transactional apps). If false, no guarantee on file system consistency is provided. VMware Tools must be installed on the guest for quiescing to work. Default: false.

The path to the trust store file.

The path to the trust store file containing certificates for secure connections. If not provided, an empty keystore will be created and the connection will be insecure.