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

29 lines
1.3 KiB
ReStructuredText

.. _ClusterAction: ../../vim/cluster/Action.rst
.. _vSphere API 5.0: ../../vim/version.rst#vimversionversion7
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _vim.cluster.DrsFaults: ../../vim/cluster/DrsFaults.rst
.. _EnterMaintenanceMode_Task: ../../vim/HostSystem.rst#enterMaintenanceMode
.. _vim.cluster.Recommendation: ../../vim/cluster/Recommendation.rst
.. _ClusterEnterMaintenanceMode: ../../vim/ClusterComputeResource.rst#enterMaintenanceMode
vim.cluster.EnterMaintenanceResult
==================================
EnterMaintenanceResult is the base class of the result returned to the `ClusterEnterMaintenanceMode`_ method.
:extends: vmodl.DynamicData_
:since: `vSphere API 5.0`_
Attributes:
recommendations (`vim.cluster.Recommendation`_, optional):
The list of recommendations for hosts that Virtual Center will be able to evacuate. Each recommendation consists of a host maintenance action `ClusterAction`_ for a host, along with zero or more vmotions for evacuation. Application of the recommendations is not supported currently. The client will have to put the hosts into maintenance mode by calling the separate method `EnterMaintenanceMode_Task`_ .
fault (`vim.cluster.DrsFaults`_, optional):
The faults that explain why the Virtual Center cannot evacuate some hosts.