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
32 lines
1.3 KiB
ReStructuredText
32 lines
1.3 KiB
ReStructuredText
.. _exiting: ../../vim/HostSystem/StandbyMode.rst#exiting
|
|
|
|
.. _entering: ../../vim/HostSystem/StandbyMode.rst#entering
|
|
|
|
.. _vim.HostSystem: ../../vim/HostSystem.rst
|
|
|
|
.. _vim.HostSystem.PowerState: ../../vim/HostSystem/PowerState.rst
|
|
|
|
vim.HostSystem.PowerState
|
|
=========================
|
|
Defines a host's power state.
|
|
:contained by: `vim.HostSystem`_
|
|
|
|
:type: `vim.HostSystem.PowerState`_
|
|
|
|
:name: unknown
|
|
|
|
values:
|
|
--------
|
|
|
|
standBy
|
|
The host was specifically put in standby mode, either explicitly by the user, or automatically by DPM. This state is not a cetain state, because after VirtualCenter issues the command to put the host in standby state, the host might crash, or kill all the processes but fail to power off. A host that is exiting standby mode `exiting`_ is also in this state.
|
|
|
|
unknown
|
|
If the host is disconnected, or notResponding, we cannot possibly have knowledge of its power state. Hence, the host is marked as unknown.
|
|
|
|
poweredOn
|
|
The host is powered on. A host that is entering standby mode `entering`_ is also in this state.
|
|
|
|
poweredOff
|
|
The host was specifically powered off by the user through VirtualCenter. This state is not a cetain state, because after VirtualCenter issues the command to power off the host, the host might crash, or kill all the processes but fail to power off.
|