VMware CloneVm

VMware CloneVm

Certified
Enterprise Edition

Clone a VM managed by vCenter

Clones an existing VM to a target host/datastore and optionally powers it on or marks it as a template. Not supported against standalone ESXi endpoints.

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

Clone a VM from vCenter

yaml
id: clone_vm
namespace: company.team

tasks:
  - id: clone
    type: io.kestra.plugin.ee.vmware.vcenter.CloneVm
    server: "vcenter.mycompany.com"
    username: "{{ secret('VMWARE_VCENTER_USERNAME') }}"
    password: "{{ secret('VMWARE_VCENTER_PASSWORD') }}"
    sourceVmName: "base-vm"
    targetVmName: "cloned-vm"
    hostname: "esxi01.mycompany.com"
    datastoreName: "datastore1"
    powerOn: true

Clone a VM and convert it to a template

yaml
id: clone_vm_to_template
namespace: company.team

tasks:
  - id: cloneVmToTemplate
    type: io.kestra.plugin.ee.vmware.vcenter.CloneVm
    server: "vcenter.mycompany.com"
    username: "{{ secret('VMWARE_VCENTER_USERNAME') }}"
    password: "{{ secret('VMWARE_VCENTER_PASSWORD') }}"
    sourceVmName: "base-vm"
    targetVmName: "template-vm"
    hostname: "esxi01.mycompany.com"
    datastoreName: "datastore1"
    convertToTemplate: true
Properties

Target datastore

Datastore for the cloned VM files.

Target host

ESXi host where the clone will be placed.

Password

Server hostname or IP

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

Source VM name

Target VM name

Username

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

Defaultfalse

Convert clone to template

Default: false. If true, the resulting VM is marked as a template.

Custom attributes

Optional map of vCenter custom attribute name to value to set on the cloned VM after creation. If a field definition does not exist it is created automatically for the VirtualMachine type. Ignored when convertToTemplate=true.

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

Default443

Server port

Defaults to 443.

Defaultfalse

Power on after clone

Default: false. Ignored when convertToTemplate=true.

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.