Data Object - VirtualMachineCloneSpec(vim.vm.CloneSpec)

Property of
PlacementSpec, StoragePlacementSpec
Parameter to
CheckClone_Task, CloneVM_Task
See also
CustomizationSpec, VirtualMachineConfigSpec, VirtualMachineRelocateSpec, VirtualMachineSnapshot

Data Object Description

Specification for a virtual machine cloning operation.


Name Type Description

An optional specification of changes to the virtual hardware. For example, this can be used to, (but not limited to) reconfigure the networks the virtual switches are hooked up to in the cloned virtual machine. Use deviceChange in location for specifying any virtual device changes for disks and networks.

An optional guest operating system customization specification. This value is ignored if a template is being created.

A type of RelocateSpec that specifies the location of resources the newly cloned virtual machine will use. The location specifies:
  • A datastore where the virtual machine will be located on physical storage. This is always provided because it indicates where the newly created clone will be copied.
  • a resource pool and optionally a host. The resource pool determines what compute resources will be available to the clone and the host indicates which machine will host the clone.


Flag indicating whether to retain a copy of the source virtual machine's memory state in the clone. Retaining the memory state during clone results in a clone in suspended state with all network adapters removed to avoid network conflicts, except those with a VirtualEthernetCard.addressType of "manual". Users of this flag should take special care so that, when adding a network adapter back to the clone, the VM is not resumed on the same VM network as the source VM, or else MAC address conflicts could occur. When cloning between two hosts with different CPUs outside an EVC cluster, users of this flag should be aware that vCenter does not verify CPU compatibility between the clone's memory state and the target host prior to the clone operation, so the clone may fail to resume until it is migrated to a host with a compatible CPU.

This flag is ignored if the snapshot parameter is unset. This flag only applies for a snapshot taken on a running or suspended virtual machine with the 'memory' parameter set to true, because otherwise the snapshot has no memory state. This flag defaults to false.

Since vSphere API 5.5

Specifies whether or not the new VirtualMachine should be powered on after creation. As part of a customization, this flag is normally set to true, since the first power-on operation completes the customization process. This flag is ignored if a template is being created.
to a VirtualMachineSnapshot

Snapshot reference from which to base the clone.

If this parameter is set, the clone is based off of the snapshot point. This means that the newly created virtual machine will have the same configuration as the virtual machine at the time the snapshot was taken.

If this property is not set then the clone is based off of the virtual machine's current configuration.

Setting this is only supported if the host this virtual machine is currently residing on cloneFromSnapshotSupported. Such support does not need to exist on the destination host for the clone.

Setting this is only supported if the virtual machine supports reporting snapshot configuration information. See snapshotConfigSupported. Such support does not need to exist on the destination host for the clone.

Since vSphere API 4.0

Specifies whether or not the new virtual machine should be marked as a template.
Properties inherited from DynamicData
*Need not be set
Show WSDL type definition