VMware SuspendVm

VMware SuspendVm

Certified
Enterprise Edition

Suspend a VM on an ESXi host

Suspends a powered-on VM, saving its state to disk for later resume. Fails if the VM is not powered on.

yaml
type: io.kestra.plugin.ee.vmware.esxi.SuspendVm

Suspend a VM by name

yaml
id: suspend_vm
namespace: company.team

tasks:
  - id: suspend
    type: io.kestra.plugin.ee.vmware.esxi.SuspendVm
    server: "esxi.mycompany.com"
    username: "{{ secret('VMWARE_ESXI_USERNAME') }}"
    password: "{{ secret('VMWARE_ESXI_PASSWORD') }}"
    vmName: "vm-to-suspend"
Properties

Password

Server hostname or IP

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

Username

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

VM name

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Default443

Server port

Defaults to 443.

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.