VmTemplate_LibraryItems_CreatePlacementSpec

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

JSON Example

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

string

folder

Optional

Virtual machine folder into which the virtual machine template should be placed. If unset, the virtual machine template will be placed in the same folder as 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: 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 template should be placed. If unset, the system will attempt to choose a suitable resource pool for the virtual machine template; if a resource pool cannot be chosen, the library item creation 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 template should be placed. If LibraryItems.CreatePlacementSpec.host and LibraryItems.CreatePlacementSpec.resource-pool are both specified, LibraryItems.CreatePlacementSpec.resource-pool must belong to LibraryItems.CreatePlacementSpec.host. If LibraryItems.CreatePlacementSpec.host and LibraryItems.CreatePlacementSpec.cluster are both specified, LibraryItems.CreatePlacementSpec.host must be a member of LibraryItems.CreatePlacementSpec.cluster. This field may be unset if LibraryItems.CreatePlacementSpec.resource-pool or LibraryItems.CreatePlacementSpec.cluster is specified. If unset, the system will attempt to choose a suitable host for the virtual machine template; if a host cannot be chosen, the library item creation 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 template should be placed. If LibraryItems.CreatePlacementSpec.cluster and LibraryItems.CreatePlacementSpec.resource-pool are both specified, LibraryItems.CreatePlacementSpec.resource-pool must belong to LibraryItems.CreatePlacementSpec.cluster. If LibraryItems.CreatePlacementSpec.cluster and LibraryItems.CreatePlacementSpec.host are both specified, LibraryItems.CreatePlacementSpec.host must be a member of LibraryItems.CreatePlacementSpec.cluster. If LibraryItems.CreatePlacementSpec.resource-pool or LibraryItems.CreatePlacementSpec.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.