Files
deb-python-pyvmomi/docs/vim/vm/FaultToleranceSecondaryOpResult.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
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
2014-06-17 14:07:42 -04:00

2.1 KiB

vim.vm.FaultToleranceSecondaryOpResult

FaultToleranceSecondaryOpResult is a data object that reports on the outcome of the CreateSecondaryVM_Task or EnableSecondaryVM_Task operation.

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

vm (vim.VirtualMachine):

The Secondary VirtualMachine

powerOnAttempted (bool):

Whether an attempt was made to power on the secondary. If an attempt was made, powerOnResult will report the status of this attempt.

powerOnResult (vim.cluster.PowerOnVmResult, optional):

The powerOnResult property reports the outcome of powering on the Secondary VirtualMachine if a power on was required. A power on will be attempted if the Primary Virtual Machine is powered on when the operation is performed. This object is only reported if powerOnAttempted is true. If the outcome of the power-on attempt is not successful, the returned ClusterPowerOnVmResult object will include an instance of ClusterNotAttemptedVmInfo whereas if the attempt was successful, then an instance of ClusterAttemptedVmInfo is returned. When ClusterAttemptedVmInfo is returned, its task property is only set if the cluster is a HA-only cluster.