Files
deb-python-pyvmomi/docs/vim/host/SystemSwapConfiguration.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
1.2 KiB
ReStructuredText

.. _InvalidArgument: ../../vmodl/fault/InvalidArgument.rst
.. _vSphere API 5.1: ../../vim/version.rst#vimversionversion8
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _UpdateSystemSwapConfiguration: ../../vim/HostSystem.rst#updateSystemSwapConfiguration
.. _HostSystemSwapConfigurationDisabledOption: ../../vim/host/SystemSwapConfiguration/DisabledOption.rst
.. _vim.host.SystemSwapConfiguration.SystemSwapOption: ../../vim/host/SystemSwapConfiguration/SystemSwapOption.rst
vim.host.SystemSwapConfiguration
================================
Information and specification for control of the system swap configuration on the current host.
:extends: vmodl.DynamicData_
:since: `vSphere API 5.1`_
Attributes:
option (`vim.host.SystemSwapConfiguration.SystemSwapOption`_, optional):
The currently enabled options. When this property contains only one value and this value is `HostSystemSwapConfigurationDisabledOption`_ , this indicates that the system swap is disabled.If the `HostSystemSwapConfigurationDisabledOption`_ option is used toghether with some other option in call to `UpdateSystemSwapConfiguration`_ , a `InvalidArgument`_ is thrown.It is not allowed to have duplicate values in this array. If so a `InvalidArgument`_ is thrown.