Data Object - VirtualMachineRelocateSpec

Property of
VirtualMachineCloneSpec
Parameter to
CheckRelocate_Task, RelocateVM_Task
Extends
DynamicData
See also
Datastore, HostSystem, ResourcePool, VirtualMachineRelocateSpecDiskLocator, VirtualMachineRelocateTransformation

Data Object Description

Specification for moving or copying a virtual machine to a different datastore or host.

Properties

Name Type Description
datastore*ManagedObjectReference
to a Datastore

The datastore where the virtual machine should be located. If not specified, the current datastore is used.
disk*VirtualMachineRelocateSpecDiskLocator[]

An optional list that allows specifying the datastore location for each virtual disk.
diskMoveType*xsd:string

Manner in which to move the virtual disk to the target datastore. The set of possible values is described in VirtualMachineRelocateDiskMoveOptions.

This property applies to all the disks which the virtual machine has, but can be overridden on a per-disk basis using diskMoveType. This property can only be set if deltaDiskBackingsSupported is true.

If left unset then moveAllDiskBackingsAndDisallowSharing is assumed.

Since vSphere API 4.0
host*ManagedObjectReference
to a HostSystem

The target host for the virtual machine. If not specified,
  • if resource pool is not specified, current host is used.
  • if resource pool is specified, and the target pool represents a stand-alone host, the host is used.
  • if resource pool is specified, and the target pool represents a DRS-enabled cluster, a host selected by DRS is used.
  • if resource pool is specified and the target pool represents a cluster without DRS enabled, an InvalidArgument exception be thrown.

pool*ManagedObjectReference
to a ResourcePool

The resource pool to which this virtual machine should be attached. For a relocate or clone operation to a virtual machine, if the argument is not supplied, the current resource pool of virtual machine is used. For a clone operation to a template, this argument is ignored. For a clone operation from a template to a virtual machine, this argument is required.
transform*VirtualMachineRelocateTransformationDeprecated. as of vSphere API 5.0. Use diskBackingInfo instead for disk format conversions. This setting will be ignored for disks with the above property set.

Transformation to perform on the disks. The backend is free to ignore this hint if it is not valid for the current operation. This can be used by clients, for example, to create sparse disks for templates.
See VirtualMachineRelocateTransformation
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set