VMware

VMware

Certified
Enterprise Edition

Tasks that automate VMware vSphere operations within Kestra workflows.

Use this plugin to orchestrate VM lifecycle, snapshotting, and template management across ESXi and vCenter from a single flow. Configure each task with your vSphere endpoint, credentials, and optional trust store so runs can safely manage infrastructure as part of data or CI/CD pipelines.

How to use the VMware plugin

Manage VMware virtual machines on vCenter and ESXi from Kestra flows.

Authentication

All tasks require server (the vCenter or ESXi hostname/IP), username, and password (all required). Optionally set port (default 443) and trustStorePath for custom TLS trust stores. Store secrets in secrets and apply connection properties globally with plugin defaults.

Tasks

Tasks are split into two sub-packages: vcenter (for vCenter-managed environments) and esxi (for direct ESXi host management). Both sub-packages share the same base authentication properties.

vCenter tasks

vcenter.CreateVm creates a VM — set vmName, hostname, networkName, isoName, and datacenter (all required). Optionally set diskSize (default 16 GB), cpuCount (default 1), memorySize (default 4096 MB), guestOsId (default ubuntu64Guest), and powerOn (default true).

vcenter.StartVm, vcenter.StopVm, vcenter.RebootVm, vcenter.ResetVm, vcenter.SuspendVm, vcenter.DeleteVm — each requires vmName.

vcenter.UpdateVm updates VM configuration — requires vmName plus the properties to modify.

vcenter.ListVms lists all VMs in the vCenter inventory.

vcenter.CreateVmSnapshot creates a snapshot — requires vmName, snapshotName, and snapshotDescription. Optionally set memory (include memory state, default false) and quiesce (quiesce guest file system, default false).

vcenter.DeleteVmSnapshot deletes a snapshot — requires vmName and snapshotName. Optionally set removeChildren (default false).

vcenter.RestoreVmFromSnapshot reverts a VM to a snapshot — requires vmName and snapshotName. Optionally set suppressPowerOn (default true).

vcenter.ListVmSnapshots lists snapshots for a VM — requires vmName.

vcenter.CloneVm clones a VM — requires vmName (source) and the target name and location properties.

vcenter.CloneTemplate clones from a template — requires template and destination properties.

vcenter.ConvertVmToTemplate converts a VM to a template — requires vmName.

vcenter.ConvertTemplateToVm converts a template to a VM — requires the template name and destination properties.

ESXi tasks

esxi tasks mirror the vCenter task set (CreateVm, StartVm, StopVm, RebootVm, ResetVm, SuspendVm, DeleteVm, UpdateVm, ListVms, CreateVmSnapshot, DeleteVmSnapshot, RestoreVmFromSnapshot, ListVmSnapshots) with the same required and optional properties. Clone and Convert tasks are not available on ESXi.

Triggers

vcenter.Trigger and esxi.Trigger fire when a VM event matching a filter is detected — set eventType and vmNameRegex (both required). Optionally set interval (polling interval, default PT2M).