VmTemplate_LibraryItems_DeployPlacementSpec

The LibraryItems.DeployPlacementSpec structure contains information used to place a virtual machine onto resources within the vCenter inventory.

JSON Example

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

string

folder

Required

Virtual machine folder into which the deployed virtual machine should be placed. This field is currently required. If unset, the system will attempt to choose a suitable folder for the virtual machine; if a folder cannot be chosen, the virtual machine deployment 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.

string

resource_pool

Optional

Resource pool into which the deployed 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 virtual machine deployment 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 LibraryItems.DeployPlacementSpec.host and LibraryItems.DeployPlacementSpec.resource-pool are both specified, LibraryItems.DeployPlacementSpec.resource-pool must belong to LibraryItems.DeployPlacementSpec.host. If LibraryItems.DeployPlacementSpec.host and LibraryItems.DeployPlacementSpec.cluster are both specified, LibraryItems.DeployPlacementSpec.host must be a member of LibraryItems.DeployPlacementSpec.cluster. This field may be unset if LibraryItems.DeployPlacementSpec.resource-pool or LibraryItems.DeployPlacementSpec.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 virtual machine deployment 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 deployed virtual machine should be placed. If LibraryItems.DeployPlacementSpec.cluster and LibraryItems.DeployPlacementSpec.resource-pool are both specified, LibraryItems.DeployPlacementSpec.resource-pool must belong to LibraryItems.DeployPlacementSpec.cluster. If LibraryItems.DeployPlacementSpec.cluster and LibraryItems.DeployPlacementSpec.host are both specified, LibraryItems.DeployPlacementSpec.host must be a member of LibraryItems.DeployPlacementSpec.cluster. If LibraryItems.DeployPlacementSpec.resource-pool or LibraryItems.DeployPlacementSpec.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.