pluginsplugin-ee-vmwarevmware-esxi

RestoreVmFromSnapshot​Restore​Vm​From​Snapshot

Restore a VM to a given snapshot on an ESXi host.

This task reverts a virtual machine to a specified snapshot using the ESXi API.

yaml
type: "io.kestra.plugin.ee.vmware.esxi.RestoreVmFromSnapshot"

Restore a VM to a named snapshot

yaml
id: restore_vm_snapshot
namespace: company.team

tasks:
  - id: restoreSnapshot
    type: io.kestra.plugin.ee.vmware.esxi.RestoreVmFromSnapshot
    server: "esxi.mycompany.com"
    username: "{{ secret('VMWARE_ESXI_USERNAME') }}"
    password: "{{ secret('VMWARE_ESXI_PASSWORD') }}"
    vmName: "my-vm"
    snapshotName: "daily-backup-2025-07-18"
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.

The name of the snapshot to restore.

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 443

The port for the connection.

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

Default true

Whether to suppress VM power-on after the restore.

If true (default), the VM will remain powered off after reverting to the snapshot. If false, the VM will be automatically powered on after the restore completes.

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.