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

97 lines
1.9 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _vim.Task: ../../vim/Task.rst
.. _vSphere API 5.0: ../../vim/version.rst#vimversionversion7
.. _HostImageProfileSummary: ../../vim/host/ImageConfigManager/ImageProfileSummary.rst
.. _HostImageAcceptanceLevel: ../../vim/host/ImageConfigManager/AcceptanceLevel.rst
.. _vim.fault.HostConfigFault: ../../vim/fault/HostConfigFault.rst
.. _vim.host.ImageConfigManager.ImageProfileSummary: ../../vim/host/ImageConfigManager/ImageProfileSummary.rst
vim.host.ImageConfigManager
===========================
This managed object is the interface for configuration of the ESX software image, including properties such as acceptance level. It is currently designed to be host agent specific.
:since: `vSphere API 5.0`_
Attributes
----------
Methods
-------
HostImageConfigGetAcceptance():
Queries the current host acceptance level setting.See `HostImageAcceptanceLevel`_
Privilege:
System.Read
Args:
Returns:
`str`_:
Raises:
`vim.fault.HostConfigFault`_:
if the host acceptance setting is invalid.See `HostImageAcceptanceLevel`_
HostImageConfigGetProfile():
Queries the current host image profile information.See `HostImageProfileSummary`_
Privilege:
System.Read
Args:
Returns:
`vim.host.ImageConfigManager.ImageProfileSummary`_:
UpdateHostImageAcceptanceLevel(newAcceptanceLevel):
Sets the acceptance level of the host image profile.See `HostImageAcceptanceLevel`_
Privilege:
Host.Config.Image
Args:
newAcceptanceLevel (`str`_):
the new AcceptanceLevel to set.See `HostImageAcceptanceLevel`_
Returns:
None
Raises:
`vim.fault.HostConfigFault`_:
if the acceptance level is raised and there are VIB packages that are not permitted by the higher acceptance level.See `HostImageAcceptanceLevel`_