VMware RestoreVmFromSnapshot

VMware RestoreVmFromSnapshot

Certified
Enterprise Edition

Restore a VM to a snapshot via vCenter

Reverts the VM to the specified snapshot. By default the VM stays powered off after restore (suppressPowerOn=true).

yaml
type: io.kestra.plugin.ee.vmware.vcenter.RestoreVmFromSnapshot

Restore a VM to a named snapshot

yaml
id: restore_vm_snapshot
namespace: company.team

tasks:
  - id: restore_snapshot
    type: io.kestra.plugin.ee.vmware.vcenter.RestoreVmFromSnapshot
    server: "vcenter.mycompany.com"
    username: "{{ secret('VMWARE_VCENTER_USERNAME') }}"
    password: "{{ secret('VMWARE_VCENTER_PASSWORD') }}"
    vmName: "my-vm"
    snapshotName: "daily-backup-2025-07-18"
Properties

Password

Server hostname or IP

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

Snapshot name

Username

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

VM name

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

Default443

Server port

Defaults to 443.

Defaulttrue

Suppress power-on after restore

Default: true. If false, the VM is powered on once the snapshot revert completes.

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.