VmTemplate_LibraryItems_CheckOuts_PlacementSpec

The CheckOuts.PlacementSpec structure contains information used to place a checked out virtual machine onto resources within the vCenter inventory. The specified compute resource should have access to the storage associated with the checked out virtual machine.

JSON Example

{
    "folder": "string",
    "resource_pool": "string",
    "host": "string",
    "cluster": "string"
}

string

folder

Optional

Virtual machine folder into which the virtual machine should be placed. If unset, the virtual machine will be placed in the same folder as the source virtual machine template. 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.

string

resource_pool

Optional

Resource pool into which the virtual machine should be placed. If unset, the system will attempt to choose a suitable resource pool for the virtual machine; if a resource pool cannot be chosen, the 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.

string

host

Optional

Host onto which the virtual machine should be placed. If CheckOuts.PlacementSpec.host and CheckOuts.PlacementSpec.resource-pool are both specified, CheckOuts.PlacementSpec.resource-pool must belong to CheckOuts.PlacementSpec.host. If CheckOuts.PlacementSpec.host and CheckOuts.PlacementSpec.cluster are both specified, CheckOuts.PlacementSpec.host must be a member of CheckOuts.PlacementSpec.cluster. This field may be unset if CheckOuts.PlacementSpec.resource-pool or CheckOuts.PlacementSpec.cluster is specified. If unset, the system will attempt to choose a suitable host for the virtual machine; if a host cannot be chosen, the operation will fail. 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.

string

cluster

Optional

Cluster onto which the virtual machine should be placed. If CheckOuts.PlacementSpec.cluster and CheckOuts.PlacementSpec.resource-pool are both specified, CheckOuts.PlacementSpec.resource-pool must belong to CheckOuts.PlacementSpec.cluster. If CheckOuts.PlacementSpec.cluster and CheckOuts.PlacementSpec.host are both specified, CheckOuts.PlacementSpec.host must be a member of CheckOuts.PlacementSpec.cluster. If CheckOuts.PlacementSpec.resource-pool or CheckOuts.PlacementSpec.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.