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

38 lines
1.3 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _datetime: https://docs.python.org/2/library/stdtypes.html
.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5
.. _vim.ManagedEntity: ../../vim/ManagedEntity.rst
.. _vmodl.DynamicData: ../../vmodl/DynamicData.rst
.. _vim.profile.Profile: ../../vim/profile/Profile.rst
.. _vim.profile.ComplianceResult.ComplianceFailure: ../../vim/profile/ComplianceResult/ComplianceFailure.rst
vim.profile.ComplianceResult
============================
DataObject representing the result from a ComplianceCheck
:extends: vmodl.DynamicData_
:since: `vSphere API 4.0`_
Attributes:
profile (`vim.profile.Profile`_, optional):
Profile for which the ComplianceResult applies
complianceStatus (`str`_):
Indicates the compliance status of the entity. See
entity (`vim.ManagedEntity`_, optional):
Entity on which the compliance check was carried out. Entity can be a Cluster, Host and so on.
checkTime (`datetime`_, optional):
Time at which compliance check was last run on the entity
failure (`vim.profile.ComplianceResult.ComplianceFailure`_, optional):
If complianceStatus is non-compliant, failure will contain additional information about the compliance errors.