REST API - clone_placement

vcenter VM: clone placement spec

The clone_placement_spec structure contains information used to place a clone of a virtual machine onto resources within the vCenter inventory. This structure was added in vSphere API 7.0.0.0.

Representation:

JSON

{
    "cluster" : "obj-103",
    "folder" : "obj-103",
    "datastore" : "obj-103",
    "host" : "obj-103",
    "resource_pool" : "obj-103"
}

Attributes:

Name	Type	Description
Optional
folder	string	Virtual machine folder into which the cloned virtual machine should be placed. This attribute was added in vSphere API 7.0.0.0. Optional. If field is unset, the system will use the virtual machine folder of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Folder`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Folder`.
resource_pool	string	Resource pool into which the cloned virtual machine should be placed. This attribute was added in vSphere API 7.0.0.0. Optional. If field is unset, the system will use the resource pool of the source virtual machine. If this results in a conflict due to other placement parameters, the virtual machine clone operation will fail.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool`.
host	string	Host onto which the cloned virtual machine should be placed. If `host` and `resource_pool` are both specified, `resource_pool` must belong to `host`. If `host` and `cluster` are both specified, `host` must be a member of `cluster`. . This attribute was added in vSphere API 7.0.0.0. Optional. If this field is unset, if `resource_pool` is unset, the cloned virtual machine will use the host of the source virtual machine. if `resource_pool` is set, and the target is a standalone host, the host is used. if `resource_pool` is set, and the target is a DRS cluster, a host will be picked by DRS. if `resource_pool` is set, and the target is a cluster without DRS, InvalidArgument will be thrown.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `HostSystem`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `HostSystem`.
cluster	string	Cluster into which the cloned virtual machine should be placed. If `cluster` and `resource_pool` are both specified, `resource_pool` must belong to `cluster`. If `cluster` and `host` are both specified, `host` must be a member of `cluster`. . This attribute was added in vSphere API 7.0.0.0. Optional. If `resource_pool` or `host` is specified, it is recommended that this field be unset.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ClusterComputeResource`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ClusterComputeResource`.
datastore	string	Datastore on which the cloned virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are created as part of the virtual machine clone operation unless individually overridden. This attribute was added in vSphere API 7.0.0.0. Optional. If field is unset, the system will use the datastore of the source virtual machine.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore`.