15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
2.6 KiB
vim.vm.check.CompatibilityChecker
A singleton managed object that can answer questions about compatibility of a virtual machine with a host.
- since
Attributes
Methods
- CheckCompatibility(vm, host, pool, testType):
-
Tests whether or not a virtual machine could be placed on the given host in the given resource pool.
- Privilege:
-
System.View
- Args:
-
- vm (vim.VirtualMachine):
-
The virtual machine we'd like to place.
- host (vim.HostSystem, optional):
-
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 (vim.ResourcePool, optional):
-
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 (str, optional):
-
The set of tests to run. If this argument is not set, all tests will be run. See CheckTestType for possible values.
- Returns:
-
- vim.Task:
-
The potential problems associated with placing this virtual machine in the proposed location. If multiple hosts are tested against a CheckResult is returned for each host.
Raises:
- vim.fault.InvalidState:
-
vim.fault.InvalidState
- vim.fault.NoActiveHostInCluster:
-
vim.fault.NoActiveHostInCluster
- vmodl.fault.InvalidArgument:
-
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.