REST API - deploy_placement

vcenter vm template library items: deploy placement spec

The deploy_placement_spec structure contains information used to place a virtual machine onto resources within the vCenter inventory. Warning: This structure is available as technical preview. It may be changed in a future release.

Representation:

JSON

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

Attributes:

Name	Type	Description
Optional
folder	string	Virtual machine folder into which the deployed virtual machine should be placed. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. 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`.
resource_pool	string	Resource pool into which the deployed virtual machine should be placed. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. 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`.
host	string	Host onto which the 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`. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. This field may be unset if `resource_pool` or `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`.
cluster	string	Cluster onto which the deployed 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`. Warning: This attribute is available as technical preview. It may be changed in a future release. 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`.