15f7be9a52
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
205 lines
5.1 KiB
ReStructuredText
205 lines
5.1 KiB
ReStructuredText
.. _str: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _vim.Task: ../../vim/Task.rst
|
|
|
|
.. _datetime: https://docs.python.org/2/library/stdtypes.html
|
|
|
|
.. _CreateProfile: ../../vim/profile/ProfileManager.rst#createProfile
|
|
|
|
.. _vSphere API 4.0: ../../vim/version.rst#vimversionversion5
|
|
|
|
.. _vSphere API 5.0: ../../vim/version.rst#vimversionversion7
|
|
|
|
.. _vim.ManagedEntity: ../../vim/ManagedEntity.rst
|
|
|
|
.. _HostProfileManager: ../../vim/profile/host/ProfileManager.rst
|
|
|
|
.. _ComplianceResultStatus: ../../vim/profile/ComplianceResult/Status.rst
|
|
|
|
.. _vmodl.fault.InvalidType: ../../vmodl/fault/InvalidType.rst
|
|
|
|
.. _CheckProfileCompliance_Task: ../../vim/profile/Profile.rst#checkCompliance
|
|
|
|
.. _ProfileSerializedCreateSpec: ../../vim/profile/Profile/SerializedCreateSpec.rst
|
|
|
|
.. _vmodl.fault.InvalidArgument: ../../vmodl/fault/InvalidArgument.rst
|
|
|
|
.. _vim.profile.ComplianceResult: ../../vim/profile/ComplianceResult.rst
|
|
|
|
.. _vim.profile.Profile.ConfigInfo: ../../vim/profile/Profile/ConfigInfo.rst
|
|
|
|
.. _vim.profile.Profile.Description: ../../vim/profile/Profile/Description.rst
|
|
|
|
.. _vim.fault.InvalidProfileReferenceHost: ../../vim/fault/InvalidProfileReferenceHost.rst
|
|
|
|
|
|
vim.profile.Profile
|
|
===================
|
|
TheProfilemanaged object is the base class for host and cluster profiles.
|
|
|
|
|
|
:since: `vSphere API 4.0`_
|
|
|
|
|
|
Attributes
|
|
----------
|
|
config (`vim.profile.Profile.ConfigInfo`_):
|
|
privilege: Profile.Edit
|
|
Configuration data for the profile.
|
|
description (`vim.profile.Profile.Description`_):
|
|
Localizable description of the profile
|
|
name (`str`_):
|
|
Name of the profile.
|
|
createdTime (`datetime`_):
|
|
Time at which the profile was created.
|
|
modifiedTime (`datetime`_):
|
|
Time at which the profile was last modified.
|
|
entity (`vim.ManagedEntity`_):
|
|
List of managed entities associated with the profile.
|
|
complianceStatus (`str`_):
|
|
Overall compliance of entities associated with this profile. If one of the entities is out of compliance, the profile isnonCompliant. If all entities are in compliance, the profile iscompliant. If the compliance status of one of the entities is not known, compliance status of the profile isunknown. See `ComplianceResultStatus`_ .
|
|
|
|
|
|
Methods
|
|
-------
|
|
|
|
|
|
RetrieveDescription():
|
|
Returns the localizable description for the profile.
|
|
since: `vSphere API 5.0`_
|
|
|
|
|
|
Privilege:
|
|
System.View
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
`vim.profile.Profile.Description`_:
|
|
Profile divided into sections containing element descriptions and messages.
|
|
|
|
Raises:
|
|
|
|
`vim.fault.InvalidProfileReferenceHost`_:
|
|
if the reference host associated with the profile is incompatible or there is no reference host for the profile.
|
|
|
|
|
|
DestroyProfile():
|
|
Destroy the profile.
|
|
|
|
|
|
Privilege:
|
|
Profile.Delete
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
|
|
AssociateProfile(entity):
|
|
Associate a profile with a managed entity. You can check the compliance of entities associated with a profile by calling the `CheckProfileCompliance_Task`_ method.
|
|
|
|
|
|
Privilege:
|
|
Profile.Edit
|
|
|
|
|
|
|
|
Args:
|
|
entity (`vim.ManagedEntity`_):
|
|
The entity(s) to associate with the profile. If an entity is already associated with the profile, the association is maintained and the vCenter Server does not perform any action.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
Raises:
|
|
|
|
`vmodl.fault.InvalidType`_:
|
|
If the entity is of an unexpeted type.
|
|
|
|
`vmodl.fault.InvalidArgument`_:
|
|
If the association conflicts with existing association.
|
|
|
|
|
|
DissociateProfile(entity):
|
|
Remove the association between a profile and a managed entity.
|
|
|
|
|
|
Privilege:
|
|
Profile.Edit
|
|
|
|
|
|
|
|
Args:
|
|
entity (`vim.ManagedEntity`_, optional):
|
|
List of entities. The vCenter Server will remove the associations that the profile has with the entities in the list. If unset, the Server removes all the associations that the profile has with any managed entities in the inventory. If the specified entity is not associated with the profile, the Server does not perform any action.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
None
|
|
|
|
|
|
Raises:
|
|
|
|
`vmodl.fault.InvalidArgument`_:
|
|
If the dissociation conflicts with existing association.
|
|
|
|
|
|
CheckProfileCompliance(entity):
|
|
Check compliance of an entity against a Profile.
|
|
|
|
|
|
Privilege:
|
|
System.View
|
|
|
|
|
|
|
|
Args:
|
|
entity (`vim.ManagedEntity`_, optional):
|
|
If specified, the compliance check is performed on this entity. If the entity is not specified, the vCenter Server runs a compliance check on all the entities associated with the profile. The entity does not have to be associated with the profile.
|
|
|
|
|
|
|
|
|
|
Returns:
|
|
`vim.Task`_:
|
|
The compliance result.
|
|
|
|
Raises:
|
|
|
|
`vim.fault.InvalidProfileReferenceHost`_:
|
|
if the reference host associated with the profile is incompatible or there is no reference host for the profile.
|
|
|
|
|
|
ExportProfile():
|
|
Export the profile in a serialized form. To use the serialized string to create a profile, specify a `ProfileSerializedCreateSpec`_ when you call the `HostProfileManager`_ . `CreateProfile`_ method.
|
|
|
|
|
|
Privilege:
|
|
Profile.Export
|
|
|
|
|
|
|
|
Args:
|
|
|
|
|
|
Returns:
|
|
`str`_:
|
|
Serialized form of the profile.
|
|
|
|
|