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
29 lines
1.3 KiB
ReStructuredText
29 lines
1.3 KiB
ReStructuredText
.. _powerState: ../../vim/vm/RuntimeInfo.rst#powerState
|
|
|
|
.. _activeTask: ../../vim/ManagedEntity.rst#recentTask
|
|
|
|
.. _vim.VirtualMachine: ../../vim/VirtualMachine.rst
|
|
|
|
.. _vim.VirtualMachine.PowerState: ../../vim/VirtualMachine/PowerState.rst
|
|
|
|
vim.VirtualMachine.PowerState
|
|
=============================
|
|
The PowerState type defines a simple set of states for a virtual machine: poweredOn, poweredOff, and suspended. This type does not model substates, such as when a task is running to change the virtual machine state. If the virtual machine is in a state with a task in progress, it transitions to a new state when the task completes. For example, a virtual machine continues to be in the poweredOn state while a suspend task is running, and changes to the suspended state once the task finishes.As a consequence of this approach, clients interested in monitoring the status of a virtual machine should typically track the `activeTask`_ data object in addition to the `powerState`_ object.
|
|
:contained by: `vim.VirtualMachine`_
|
|
|
|
:type: `vim.VirtualMachine.PowerState`_
|
|
|
|
:name: suspended
|
|
|
|
values:
|
|
--------
|
|
|
|
poweredOn
|
|
The virtual machine is currently powered on.
|
|
|
|
poweredOff
|
|
The virtual machine is currently powered off.
|
|
|
|
suspended
|
|
The virtual machine is currently suspended.
|