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
2.8 KiB
vim.profile.ProfileManager
This Class is responsible for managing Profiles.
- since
Attributes
- profile (vim.profile.Profile):
- privilege: Profile.View
A list of profiles known to this ProfileManager.
Methods
- CreateProfile(createSpec):
-
Create a profile from the specified CreateSpec.
- Privilege:
-
Profile.Create
- Args:
-
- createSpec (vim.profile.Profile.CreateSpec):
-
Specification for the profile being created. Usually a derived class CreateSpec can be used to create the Profile.
- Returns:
-
- vim.profile.Profile:
-
Profile created from the specified createSpec.
Raises:
- vim.fault.DuplicateName:
-
If a profile with the specified name already exists.
- vim.fault.InvalidProfileReferenceHost:
-
if the specified reference host is incompatible or no reference host has been specifed.
- QueryPolicyMetadata(policyName, profile):
-
Get the Metadata information for the policyNames. PolicyNames are available with the defaultProfile obtained by invoking the method createDefaultProfile.
- Privilege:
-
System.View
- Args:
-
- policyName (str, optional):
-
Retrieve metadata for the specified policyNames. If policyName is not specified, metadata for all policies will be returned.
- profile (vim.profile.Profile, optional, since vSphere API 5.0 ):
-
Base profile whose context needs to be used during the operation
- Returns:
-
- vim.profile.PolicyMetadata:
-
The metadata information for the policy.
Raises:
- vmodl.fault.InvalidArgument:
-
If policyName is invalid.
- vim.fault.InvalidProfileReferenceHost:
-
if the reference host associated with the profile is incompatible or there is no reference host for the profile.
- FindAssociatedProfile(entity):
-
Get the profile(s) to which this entity is associated. The list of profiles will only include profiles known to this profileManager.
- Privilege:
-
System.View
- Args:
-
- entity (vim.ManagedEntity):
-
Entity for which profile is being looked up.
- Returns: