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
5.5 KiB
vim.vm.check.ProvisioningChecker
A singleton managed object that can answer questions about the feasibility of certain provisioning operations.
- since
Attributes
Methods
- QueryVMotionCompatibilityEx(vm, host):
-
Investigates the general VMotion compatibility of a set of virtual machines with a set of hosts. The virtual machine may be in any power state. Hosts may be in any connection state and also may be in maintenance mode.
- Privilege:
-
System.View
- Args:
-
- vm (vim.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 (vim.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.
- Returns:
-
- vim.Task:
-
The problems associated with these potential VMotions. A CheckResult is returned for each vm/host combination.
- CheckMigrate(vm, host, pool, state, testType):
-
Tests the feasibility of a proposed MigrateVM_Task operation.
- Privilege:
-
System.View
- Args:
-
- vm (vim.VirtualMachine):
-
The virtual machine we propose to migrate.
- host (vim.HostSystem, optional):
-
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 (vim.ResourcePool, optional):
-
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.
- state (vim.VirtualMachine.PowerState, optional):
-
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 (str, optional):
-
The set of tests to run. If this argument is not set, all tests will be run.
- Returns:
-
- vim.Task:
-
The problems associated with this potential migrate. If multiple hosts are tested against a CheckResult is returned for each host.
Raises:
- vim.fault.InvalidState:
-
vim.fault.InvalidState
- vmodl.fault.InvalidArgument:
-
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.
- vim.fault.InvalidPowerState:
-
if the state argument is set and at least one of the specified virtual machines is not in that power state.
- CheckRelocate(vm, spec, testType):
-
Tests the feasibility of a proposed RelocateVM_Task operation.
- Privilege:
-
System.View
- Args:
-
- vm (vim.VirtualMachine):
-
The virtual machine we propose to relocate.
- spec (vim.vm.RelocateSpec):
-
The specification of where to relocate the virtual machine. In cases where DRS would automatically select a host, all potential hosts are tested against.
testType (str, optional):
- Returns:
-
- vim.Task:
-
The problems associated with this potential relocate. If multiple hosts are tested against a CheckResult is returned for each host.
Raises:
- vim.fault.InvalidState:
-
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.
- vmodl.fault.NotSupported:
-
if the virtual machine is marked as a template.
- vmodl.fault.InvalidArgument:
-
- in the following cases:
-
- the target host and target pool are not associated with the same compute resource
- the target pool represents a cluster without DRS enabled, and the host is not specified
- Datastore in a diskLocator entry is not specified
- the specified device ID cannot be found in the virtual machine's current configuration
- the object specified in relocate cannot be found