Managed Object - VirtualMachineCompatibilityChecker

Property of
ServiceContent
See also
CheckResult, HostSystem, ResourcePool, VirtualMachine
Since
vSphere API 4.0


Managed Object Description

A singleton managed object that can answer questions about compatibility of a virtual machine with a host.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
CheckCompatibility_Task

CheckCompatibility_Task

Tests whether or not a virtual machine could be placed on the given host in the given resource pool.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachineCompatibilityChecker used to make the method call.
vmManagedObjectReference
to a VirtualMachine

The virtual machine we'd like to place.
host*ManagedObjectReference
to a HostSystem

The host we would like the virtual machine to execute on. The host parameter may be left unset if the compute resource associated with the pool represents a stand-alone host or a DRS-enabled cluster. In the former case the stand-alone host is used. In the latter case, each connected host in the cluster that is not in maintenance mode is tested. If the virtual machine is a template then either this parameter or the pool parameter must be set.
pool*ManagedObjectReference
to a ResourcePool

The resource pool we would like the virtual machine to reside in. If the pool parameter is left unset, then the virtual machine's current pool is assumed. If the virtual machine is a template then either this parameter or the host parameter must be set.
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.
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
InvalidArgumentThrown if the desired host and pool are not associated with the same compute resource, or if the host parameter is left unset when the specified pool is ssociated with a non-DRS cluster.
InvalidState
NoActiveHostInCluster
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.