Managed Object - Profile

Property of
ComplianceResult, ProfileEventArgument, ProfileManager
Parameter to
CheckCompliance_Task, ClearComplianceStatus, QueryComplianceStatus
Returned by
CreateProfile, FindAssociatedProfile
Extended by
ClusterProfile, HostProfile
See also
ComplianceResult, ManagedEntity, ProfileConfigInfo, ProfileDescription
Since
vSphere API 4.0


Managed Object Description

Properties

Name Type Description
complianceStatusxsd:string

Overall compliance of entities associated with this profile. If one of the entities is out of compliance, profile is out of compliance. If all entities are in compliance, profile is in compliance. If compliance status of one of the entities is unknown, compliance status of the profile is unknown. See
configProfileConfigInfo

Configuration of the profile
createdTimexsd:dateTime

Time at which the profile was created
description*ProfileDescription

Localizeable Description of the Profile
entity*ManagedObjectReference[]
to a ManagedEntity[]

List of ManagedEntities associated with the Profile
modifiedTimexsd:dateTime

Time at which the profile was last modified
namexsd:string

Name of the Profile
*May not be present

Methods

Methods defined in this Managed Object
AssociateProfile, CheckProfileCompliance_Task, DestroyProfile, DissociateProfile, ExportProfile

AssociateProfile

Associate a profile with a managed entity.
Required Privileges
Profile.Edit

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Profile used to make the method call.
entityManagedObjectReference[]
to a ManagedEntity[]

The entity(s) to associate with the profile. If entity is already associted with the profile, association is maintained and operation is treated as a no-op. throws InvalidType If the entity is of an unexpeted type. throws InvalidArgument If the association conflicts with existing association.

Return Value

Type Description
None

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.

Show WSDL type definition



CheckProfileCompliance_Task

Check compliance of an entity against a Profile.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Profile used to make the method call.
entity*ManagedObjectReference[]
to a ManagedEntity[]

If specified, the compliance check is done against this entity. If the entity is not specified, a compliance check will be run on all the entities associated with the profile. Entity need not be associated with the profile.
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task

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.



DestroyProfile

Destory the Profile
Required Privileges
Profile.Delete

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Profile used to make the method call.

Return Value

Type Description
None

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.

Show WSDL type definition



DissociateProfile

Dissociate a profile from a managed entity.
Required Privileges
Profile.Edit

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Profile used to make the method call.
entity*ManagedObjectReference[]
to a ManagedEntity[]

Entity(s) from which to dissociate the profile. If unset, the profile is dissociated from all managed entities it is currently associated with. If the specified entity is not associated with the profile, the operation is a no-op. throws InvalidArgument If the dissociation conflicts with existing association.
*Need not be set

Return Value

Type Description
None

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.

Show WSDL type definition



ExportProfile

Export the profile into a serialized form. The serialized string can then be used to create a profile using SerializedCreateSpec
Required Privileges
Profile.Export

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Profile used to make the method call.

Return Value

Type Description
xsd:stringSerialized form of the 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.

Show WSDL type definition