Managed Object - HostProfile

Extends
Profile
See also
HostProfileConfigSpec, HostSystem, ProfileDeferredPolicyOptionParameter, ProfileExecuteResult
Since
vSphere API 4.0


Managed Object Description

This data object type represents a profile for configuring the host.

Properties

Name Type Description
referenceHost*ManagedObjectReference
to a HostSystem

Reference host in use for this HostProfile
Properties inherited from Profile
complianceStatus, config, createdTime, description, entity, modifiedTime, name
*May not be present

Methods

Methods defined in this Managed Object
ExecuteHostProfile, UpdateHostProfile, UpdateReferenceHost
Methods inherited from Profile
AssociateProfile, CheckProfileCompliance_Task, DestroyProfile, DissociateProfile, ExportProfile

ExecuteHostProfile

Execute the Profile Engine to calculate the list of configuration changes needed for the host.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfile used to make the method call.
hostManagedObjectReference
to a HostSystem

The host on which to execute the profile. The host needn't be associated with the Profile.
deferredParam*ProfileDeferredPolicyOptionParameter[]

The inputs that the user has given till now. This should include all the inputs the user has given till now including the inputs from the previous round of the call.
*Need not be set

Return Value

Type Description
ProfileExecuteResultResult of the execution.

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



UpdateHostProfile

Update the HostProfile with the specified config.
Required Privileges
Profile.Edit

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfile used to make the method call.
configHostProfileConfigSpec

Specification which describes the changes.

Return Value

Type Description
None

Faults

Type Description
DuplicateNameThrown if the profile with the new name already exists.
ProfileUpdateFailedThrown if errors were encountered when updating the profile.
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



UpdateReferenceHost

Update the reference host in use by the HostProfile.
Required Privileges
Profile.Edit

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfile used to make the method call.
host*ManagedObjectReference
to a HostSystem

Reference host to use. If Unset, referenceHost is cleared.
*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