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

24 lines
1016 B
ReStructuredText

.. _vSphere API 5.5: ../../vim/version.rst#vimversionversion9
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _HostMaintenanceSpec: ../../vim/host/MaintenanceSpec.rst
.. _VsanHostDecommissionMode: ../../vim/vsan/host/DecommissionMode.rst
.. _EnterMaintenanceMode_Task: ../../vim/HostSystem.rst#enterMaintenanceMode
.. _vim.vsan.host.DecommissionMode: ../../vim/vsan/host/DecommissionMode.rst
vim.host.MaintenanceSpec
========================
The `HostMaintenanceSpec`_ data object may be used to specify actions to be taken by a host upon entering maintenance mode. If the `HostMaintenanceSpec`_ or any of its fields are omitted in a call to `EnterMaintenanceMode_Task`_ , default actions will be chosen as documented for each field's type.See `EnterMaintenanceMode_Task`_ See `VsanHostDecommissionMode`_
:extends: vmodl.DynamicData_
:since: `vSphere API 5.5`_
Attributes:
vsanMode (`vim.vsan.host.DecommissionMode`_, optional):
The `VsanHostDecommissionMode`_ for this MaintenanceSpec.