Managed Object - ProfileManager

Extended by
ClusterProfileManager, HostProfileManager
See also
ManagedEntity, Profile, ProfileCreateSpec, ProfilePolicyMetadata
Since
vSphere API 4.0


Managed Object Description

This Class is responsible for managing Profiles.

Properties

Name Type Description
profile* PManagedObjectReference[]
to a Profile[]

A list of profiles known to this ProfileManager.
*May not be presentP Required privilege: Profile.View

Methods

Methods defined in this Managed Object
CreateProfile, FindAssociatedProfile, QueryPolicyMetadata

CreateProfile

Create a profile from the specified CreateSpec.
Required Privileges
Profile.Create

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ProfileManager used to make the method call.
createSpecProfileCreateSpec

Specification for the profile being created. Usually a derived class CreateSpec can be used to create the Profile.

Return Value

Type Description
ManagedObjectReference
to a Profile
Profile created from the specified createSpec.

Faults

Type Description
DuplicateNameThrown if a profile with the specified name already exists.
InvalidProfileReferenceHostThrown if the specified reference host is incompatible or no reference host has been specifed.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



FindAssociatedProfile

Get the profile(s) to which this entity is associated. The list of profiles will only include profiles known to this profileManager.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ProfileManager used to make the method call.
entityManagedObjectReference
to a ManagedEntity

Entity for which profile is being looked up.

Return Value

Type Description
ManagedObjectReference[]
to a Profile[]

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



QueryPolicyMetadata

Get the Metadata information for the policyNames. PolicyNames are available with the defaultProfile obtained by invoking the method createDefaultProfile.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ProfileManager used to make the method call.
policyName*xsd:string[]

Retrieve metadata for the specified policyNames. If policyName is not specified, metadata for all policies will be returned.
profile*ManagedObjectReference
to a Profile

Base profile whose context needs to be used during the operation

Since vSphere API 5.0
*Need not be set

Return Value

Type Description
ProfilePolicyMetadata[]The metadata information for the policy.

Faults

Type Description
InvalidArgumentThrown if policyName is invalid.
InvalidProfileReferenceHostThrown if the reference host associated with the profile is incompatible or there is no reference host for the profile.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition