Files
deb-python-pyvmomi/docs/vim/vsan/host/DecommissionMode.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

28 lines
1.2 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vsanMode: ../../../vim/host/MaintenanceSpec.rst#vsanMode
.. _vSphere API 5.5: ../../../vim/version.rst#vimversionversion9
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
.. _VsanHostDecommissionMode: ../../../vim/vsan/host/DecommissionMode.rst
.. _EnterMaintenanceMode_Task: ../../../vim/HostSystem.rst#enterMaintenanceMode
.. _ensureObjectAccessibility: ../../../vim/vsan/host/DecommissionMode/ObjectAction.rst#ensureObjectAccessibility
.. _VsanHostDecommissionModeObjectAction: ../../../vim/vsan/host/DecommissionMode/ObjectAction.rst
vim.vsan.host.DecommissionMode
==============================
A `VsanHostDecommissionMode`_ defines an action to take upon decommissioning a host from use with the VSAN service. If the VSAN service DecommissionMode is omitted in a call to `EnterMaintenanceMode_Task`_ , the default action chosen will be `ensureObjectAccessibility`_ .See `EnterMaintenanceMode_Task`_ See `vsanMode`_
:extends: vmodl.DynamicData_
:since: `vSphere API 5.5`_
Attributes:
objectAction (`str`_):
Specifies an action to take with regard to the VSAN service upon putting a host into maintenance mode.See `VsanHostDecommissionModeObjectAction`_