VM_CloneSpec

VM_CloneSpec
VM_CloneSpec

Document-based clone spec.

JSON Example
{
    "source": "string",
    "name": "string",
    "placement": {
        "folder": "string",
        "resource_pool": "string",
        "host": "string",
        "cluster": "string",
        "datastore": "string"
    },
    "disks_to_remove": [
        "string"
    ],
    "disks_to_update": {
        "disks_to_update": {
            "datastore": "string"
        }
    },
    "power_on": false,
    "guest_customization_spec": {
        "name": "string"
    }
}
string
source
Required

Virtual machine to clone from. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.

string
name
Required

Virtual machine name.

placement
Optional

The VM.ClonePlacementSpec structure contains information used to place a clone of a virtual machine onto resources within the vCenter inventory.

array of string
disks_to_remove
Optional

Set of Disks to Remove. If unset, all disks will be copied. If the same identifier is in VM.CloneSpec.disks-to-update InvalidArgument fault will be returned. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.

object
disks_to_update
Optional

Map of Disks to Update. If unset, all disks will copied to the datastore specified in the VM.ClonePlacementSpec.datastore field of VM.CloneSpec.placement. If the same identifier is in VM.CloneSpec.disks-to-remove InvalidArgument fault will be thrown. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

boolean
power_on
Optional

Attempt to perform a VM.CloneSpec.power-on after clone. If unset, the virtual machine will not be powered on.

guest_customization_spec
Optional

The VM.GuestCustomizationSpec structure contains information required to customize a virtual machine when deploying it.