REST API - relocate_placement

vcenter VM: relocate placement spec

The relocate_placement_spec structure contains information used to change the placement of an existing virtual machine 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 virtual machine should be placed. This attribute was added in vSphere API 7.0.0.0. Optional. If this field is unset, the virtual machine will stay in the current folder.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 virtual machine should be placed. This attribute was added in vSphere API 7.0.0.0. Optional. If this field is unset, the virtual machine will stay in the current resource pool.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`. . This attribute was added in vSphere API 7.0.0.0. Optional. If this field is unset, if `resource_pool` is unset, the virtual machine will remain on the current host. 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 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 virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are associated with the virtual machine, unless individually overridden. This attribute was added in vSphere API 7.0.0.0. Optional. If this field is unset, the virtual machine will remain on the current datastore.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`.