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

41 lines
1.3 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _bool: https://docs.python.org/2/library/stdtypes.html
.. _vmodl.DynamicData: ../../../vmodl/DynamicData.rst
vim.host.InternetScsiHba.AuthenticationProperties
=================================================
The authentication settings for this host bus adapter or target.
:extends: vmodl.DynamicData_
Attributes:
chapAuthEnabled (`bool`_):
True if CHAP is currently enabled
chapName (`str`_, optional):
The CHAP user name if enabled
chapSecret (`str`_, optional):
The CHAP secret if enabled
chapAuthenticationType (`str`_, optional):
The preference for CHAP or non-CHAP protocol if CHAP is enabled
chapInherited (`bool`_, optional):
CHAP settings are inherited
mutualChapName (`str`_, optional):
When Mutual-CHAP is enabled, the user name that target needs to use to authenticate with the initiator
mutualChapSecret (`str`_, optional):
When Mutual-CHAP is enabled, the secret that target needs to use to authenticate with the initiator
mutualChapAuthenticationType (`str`_, optional):
The preference for CHAP or non-CHAP protocol if CHAP is enabled
mutualChapInherited (`bool`_, optional):
Mutual-CHAP settings are inherited