| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
CheckMigrate_Task, CheckRelocate_Task, QueryVMotionCompatibilityEx_Task |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualMachineProvisioningChecker used to make the method call. |
vm | ManagedObjectReference
to a VirtualMachine |
The virtual machine we propose to migrate.
|
host* | ManagedObjectReference
to a HostSystem |
The target host on which the virtual machines will run. The host
parameter may be left unset if the compute resource associated with
the target pool represents a stand-alone host or a DRS-enabled
cluster. In the former case the stand-alone host is used as the
target host. In the latter case, each connected host in the cluster
that is not in maintenance mode is tested as a target host.
If the virtual machine is a template then either this
parameter or the pool parameter must be set.
|
pool* | ManagedObjectReference
to a ResourcePool |
The target resource pool for the virtual machines. If the
pool parameter is left unset, the target pool for each particular
virtual machine's migration will be that virtual machine's current
pool. If the virtual machine is a template then either this
parameter or the host parameter must be set.
The pool parameter must be set for testing the feasibility of
migration to a different datacenter or different vCenter service.
|
state* | VirtualMachinePowerState |
The power state that the virtual machines must have. If
this argument is not set, each virtual machine is evaluated
according to its current power state.
|
testType* | xsd:string[] |
The set of tests to run. If this argument is not set, all
tests will be run. See CheckTestType for possible values.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the target host(s) and target pool for a migration are not associated with the same compute resource, or if the host parameter is left unset when the target pool is associated with a non-DRS cluster. |
InvalidPowerState | Thrown if the state argument is set and at least one of the specified virtual machines is not in that power state. |
InvalidState | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualMachineProvisioningChecker used to make the method call. |
vm | ManagedObjectReference
to a VirtualMachine |
The virtual machine we propose to relocate.
|
spec | VirtualMachineRelocateSpec |
The specification of where to relocate the virtual machine.
In cases where DRS would automatically select a host, all potential
hosts are tested against.
The host parameter in the spec may be left unset for checking
feasibility of relocation to a different datacenter or different
vCenter service, if the compute resource associated with the
target pool represents a stand-alone host, the host is tested
against, otherwise each connected host in the cluster that is
not in maintenance mode represented by the target pool is tested
as a target host.
|
testType* | xsd:string[] |
The set of tests to run. If this argument is not set, all
tests will be run. See CheckTestType for possible values.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
InvalidArgument | in the following cases:
|
InvalidState | Thrown if the operation cannot be performed because of the host or virtual machine's current state. For example, if the host is in maintenance mode, or if the virtual machine's configuration information is not available. |
NotSupported | Thrown if the virtual machine is marked as a template. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualMachineProvisioningChecker used to make the method call. |
vm | ManagedObjectReference[]
to a VirtualMachine[] |
The set of virtual machines to analyze for compatibility. All
virtual machines are assumed to be powered-on for the purposes of
this operation.
|
host | ManagedObjectReference[]
to a HostSystem[] |
The set of hosts to analyze for compatibility. All hosts
are assumed to be connected and not in maintenence mode for the
purposes of this operation.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a SmsTask |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |