Clusters_VirtualMachines_RestorePlacementSpec

The VirtualMachines.RestorePlacementSpec structure contains fields used to place restored virtual machine on to resources within the vcenter inventory.

JSON Example

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

string

folder

Optional

Virtual machine folder into which the restored virtual machine should be placed. If field is unset, the system will use the default virtual machine folder of the datacenter. If this results in a conflict due to other placement parameters, the virtual machine restore 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 restored virtual machine should be placed. If field is unset, the system will use the other placement parameters to create virtual machine. If this results in a conflict due to other placement parameters, the virtual machine restore 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 restored virtual machine should be placed. If VirtualMachines.RestorePlacementSpec.host and VirtualMachines.RestorePlacementSpec.resource-pool are both specified, VirtualMachines.RestorePlacementSpec.resource-pool must belong to VirtualMachines.RestorePlacementSpec.host.

If VirtualMachines.RestorePlacementSpec.host is specified, VirtualMachines.RestorePlacementSpec.host must be a member of cluster.

If this field is unset, if VirtualMachines.RestorePlacementSpec.resource-pool is set, and the target is a DRS cluster, a host will be picked by DRS. if VirtualMachines.RestorePlacementSpec.resource-pool is unset, and the target is a DRS cluster, a host will be picked by DRS. if VirtualMachines.RestorePlacementSpec.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.