VMware vCenter VMs and Templates RestoreVmFromSnapshot
CertifiedEnterprise EditionRestore a VM to a snapshot via vCenter
VMware vCenter VMs and Templates RestoreVmFromSnapshot
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).
type: io.kestra.plugin.ee.vmware.vcenter.RestoreVmFromSnapshotExamples
Restore a VM to a named snapshot
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"
Installation
This Enterprise plugin requires an Enterprise image and access to the plugin registry. Install it with the following command:
kestractl plugins get io.kestra.plugin.ee:plugin-ee-vmware --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.
Properties
password *string
Password
server *string
Server hostname or IP
FQDN or IP of the vCenter or ESXi endpoint (no scheme or port).
snapshotName *string
Snapshot name
username *string
Username
e.g. Administrator@vsphere.local for vCenter or root for ESXi.
vmName *string
VM name
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150port integerstring
443Server port
Defaults to 443.
suppressPowerOn booleanstring
trueSuppress power-on after restore
Default: true. If false, the VM is powered on once the snapshot revert completes.
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.
