Snapservice.Clusters.VirtualMachines.RestorePlacementSpec

The Snapservice.Clusters.VirtualMachines.RestorePlacementSpec schema contains properties used to place restored virtual machine on to resources within the vcenter inventory.

This schema was added in vSphere API 8.0.3.0.

JSON Example

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

string

folder

Optional

Virtual machine folder into which the restored virtual machine should be placed.

This property was added in vSphere API 8.0.3.0.

If property is missing or null, 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 schema as a parameter, the property must be an identifier for the resource type: Folder. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder.

string

resource_pool

Optional

Resource pool into which the restored virtual machine should be placed.

This property was added in vSphere API 8.0.3.0.

If property is missing or null, 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 schema as a parameter, the property must be an identifier for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool.

string

host

Optional

Host onto which the restored virtual machine should be placed.

If host and resource_pool are both specified, resource_pool must belong to host.

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

This property was added in vSphere API 8.0.3.0.

If this property is unset, if resource_pool is set, and the target is a DRS cluster, a host will be picked by DRS. if resource_pool is unset, 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 schema as a parameter, the property must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the property will be an identifier for the resource type: HostSystem.