Vcenter VM CloneSpec

Vcenter VM CloneSpec
Vcenter VM CloneSpec

Document-based clone spec.

This schema was added in vSphere API 7.0.0.0.

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.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.

string
name
Required

Virtual machine name.

This property was added in vSphere API 7.0.0.0.

placement
Optional

Virtual machine placement information.

This property was added in vSphere API 7.0.0.0.

If this property is missing or null, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the placement values of the source virtual machine result in disjoint placement the operation will fail.

array of string
disks_to_remove
Optional

Set of Disks to Remove.

This property was added in vSphere API 7.0.0.0.

If missing or null, all disks will be copied. If the same identifier is in Vcenter VM CloneSpec.disks_to_update InvalidArgument fault will be returned.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.

object
disks_to_update
Optional

Map of Disks to Update.

This property was added in vSphere API 7.0.0.0.

If missing or null, all disks will copied to the datastore specified in the Vcenter VM ClonePlacementSpec.datastore property of Vcenter VM CloneSpec.placement. If the same identifier is in Vcenter VM CloneSpec.disks_to_remove InvalidArgument fault will be thrown.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

boolean
power_on
Optional

Attempt to perform a Vcenter VM CloneSpec.power_on after clone.

This property was added in vSphere API 7.0.0.0.

If missing or null, the virtual machine will not be powered on.

guest_customization_spec
Optional

Guest customization spec to apply to the virtual machine after the virtual machine is deployed.

This property was added in vSphere API 7.0.0.0.

If missing or null, the guest operating system is not customized after clone.

Parameter To