Files
deb-python-pyvmomi/docs/vim/VirtualMachine/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

31 lines
1.5 KiB
ReStructuredText

.. _vim.VirtualMachine: ../../vim/VirtualMachine.rst
.. _vim.VirtualMachine.ConnectionState: ../../vim/VirtualMachine/ConnectionState.rst
vim.VirtualMachine.ConnectionState
==================================
The connectivity state of a virtual machine. When the API is provided directly by a server product, such as ESX Server, then the disconnected state is not possible. However, when accessed through VirtualCenter, the state of a virtual machine is set to disconnected if the hosts that manage the virtual machine becomes unavailable.
:contained by: `vim.VirtualMachine`_
:type: `vim.VirtualMachine.ConnectionState`_
:name: invalid
values:
--------
inaccessible
One or more of the virtual machine configuration files are inaccessible. For example, this can be due to transient disk failures. In this case, no configuration can be returned for a virtual machine.
connected
The server has access to the virtual machine.
disconnected
The server is currently disconnected from the virtual machine, since its host is disconnected. See general comment for this enumerated type for more details.
invalid
The virtual machine configuration format is invalid. Thus, it is accessible on disk, but corrupted in a way that does not allow the server to read the content. In this case, no configuration can be returned for a virtual machine.
orphaned
The virtual machine is no longer registered on the host it is associated with. For example, a virtual machine that is unregistered or deleted directly on a host managed by VirtualCenter shows up in this state.