Files
deb-python-pyvmomi/docs/vim/HostSystem/ConnectionState.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

25 lines
885 B
ReStructuredText

.. _vim.HostSystem: ../../vim/HostSystem.rst
.. _vim.HostSystem.ConnectionState: ../../vim/HostSystem/ConnectionState.rst
vim.HostSystem.ConnectionState
==============================
Defines a host's connection state.
:contained by: `vim.HostSystem`_
:type: `vim.HostSystem.ConnectionState`_
:name: disconnected
values:
--------
connected
Connected to the server. For ESX Server, this is always the setting.
disconnected
The user has explicitly taken the host down. VirtualCenter does not expect to receive heartbeats from the host. The next time a heartbeat is received, the host is moved to the connected state again and an event is logged.
notResponding
VirtualCenter is not receiving heartbeats from the server. The state automatically changes to connected once heartbeats are received again. This state is typically used to trigger an alarm on the host.