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*	ManagedObjectReference[] to a Profile[]	A list of profiles known to this ProfileManager.

*May not be present

Methods

Methods defined in this Managed Object
CreateProfile, FindAssociatedProfile, QueryPolicyMetadata

CreateProfile

Create a profile from the specified CreateSpec.

Required Privileges: Profile.Create

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the ProfileManager used to make the method call.
createSpec	ProfileCreateSpec	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
DuplicateName	Thrown if a profile with the specified name already exists.
InvalidProfileReferenceHost	Thrown if the specified reference host is incompatible or no reference host has been specifed.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateProfile" type="vim25:CreateProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateProfileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the ProfileManager used to make the method call.
entity	ManagedObjectReference to a ManagedEntity	Entity for which profile is being looked up.

Return Value

Type	Description
ManagedObjectReference[] to a Profile[]

Faults

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FindAssociatedProfile" type="vim25:FindAssociatedProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="FindAssociatedProfileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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

Name

Type

Description

_this

ManagedObjectReference

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
InvalidArgument	Thrown if policyName is invalid.
InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for the profile.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryPolicyMetadata" type="vim25:QueryPolicyMetadataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryPolicyMetadataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ProfilePolicyMetadata" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>