Managed Object - HostProfile(vim.profile.host.HostProfile)

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

Managed Object Description

A host profile describes ESX Server configuration. The HostProfile managed object provides access to profile data and it defines methods to manipulate the profile. A host profile is a combination of subprofiles, each of which contains configuration data for a specific capability. Some examples of host capabilities are authentication, memory, networking, and security. For access to individual subprofiles, see the HostApplyProfile data object (HostProfile.Config.applyProfile).

Host profiles are part of the stateless configuration architecture. In the stateless environment, a Profile Engine runs on each ESX host, but an ESX host does not store its own configuration state. Instead, host configuration data is stored on vCenter Servers. Every time a host boots or reboots, it obtains its profile from the vCenter Server.

To create a base host profile use the HostProfileManager.CreateProfile method. To create a profile from an ESX host, specify a HostProfileHostBasedConfigSpec. To create a profile from a file, specify a HostProfileSerializedHostProfileSpec.
To create a subprofile for a particular host capability, use the HostProfileManager.CreateDefaultProfile method. After you create the default profile you can modify it and save it in the base profile.
To update an existing profile, use the HostProfile.UpdateHostProfile method.
To apply a host profile to an ESX host, use the ExecuteHostProfile method to generate configuration changes, then call the HostProfileManager.ApplyHostConfig_Task method to apply them.

Host-Specific Configuration

An individual host or a set of hosts may have some configuration settings that are different from the settings specified in the host profile. For example, the IP configuration for the host's virtual network adapters must be unique.

To verify host-specific data, use the deferredParam parameter to the ExecuteHostProfile method. The Profile Engine will determine if you have specified all of the required parameters for the host configuration. If additional data is required, call the ExecuteHostProfile method again as many times as necessary to verify a complete set of parameters.
To apply host-specific data, use the userInput parameter to the HostProfileManager.ApplyHostConfig_Task method.

The Profile Engine saves host-specific data in an AnswerFile that is stored on the vCenter Server. The HostProfileManager provides several methods to manipulate answer files.

Profile Compliance

You can create associations between hosts and profiles to support compliance checking. When you perform compliance checking, you can determine if a host configuration conforms to a host profile.

To create an association between a host and a profile, use the AssociateProfile method. The method adds the host to the HostProfile.Entity[] list.
To retrieve the list of profiles associated with a host, use the HostProfileManager.FindAssociatedProfile method.
To check host compliance, use the CheckProfileCompliance_Task method. If you do not specify any hosts, the method will check the compliance of all hosts that are associated with the profile.

You can also use the Profile Compliance Manager to check compliance by specifying profiles, entities (hosts), or both. See ProfileComplianceManager.CheckCompliance_Task.

Profile Plug-Ins

The vSphere architecture uses VMware profile plug-ins to define profile extensions. For information about using a plug-in to extend a host profile, see the VMware Technical Note Developing a Host Profile Extension Plug-in.

For access to host configuration data that is defined by plug-ins, use the ApplyProfile.policy[] and ApplyProfile.property[] lists. The HostApplyProfile and its subprofiles, which collectively define host configuration data, are derived from the ApplyProfile.

Policies store ESX configuration data in PolicyOption objects.
Profile property lists contain subprofiles defined by plug-ins. Subprofiles can be nested.
- Subprofile lists are available as an extension to the base host profile (HostProfile.Config.applyProfile.property[]).
- Subprofile lists are available as extensions to the host subprofiles - for example, the network subprofile (HostApplyProfile.network.property[]).

If you make changes to host profile data, later versions of profile plug-ins may not support the host configuration implied by the changes that you make. When a subsequent vSphere version becomes available, you must verify that the new version supports any previous configuration changes that you have made.

Properties

Name	Type	Description
complianceCheckTime*	xsd:dateTime	The latest compliance check time. *Since* 8.0.1.0
referenceHost*	ManagedObjectReference to a HostSystem	Reference host in use for this host profile. To set this property, use the UpdateReferenceHost method. If you do not specify a host for validation (HostProfileCompleteConfigSpec.validatorHost), the Profile Engine uses the reference host to validate the profile.
validationFailureInfo*	HostProfileValidationFailureInfo	This object is created or updated if the ValidationState is Failed. This object captures the most recent validation result for the host profile object in case of failure. *Since* vSphere API 6.7
validationState*	xsd:string	State of the host profile validation operation. The values of the state will be one of ValidationState enumerations. *Since* vSphere API 6.7
validationStateUpdateTime*	xsd:dateTime	Update time of the validation operation. *Since* vSphere API 6.7
Properties inherited from Profile
complianceStatus, config, createdTime, description, entity, modifiedTime, name

*May not be present

Methods

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

ExecuteHostProfile(execute)

Run the Profile Engine to determine the list of configuration changes needed for the specified host. The method generates configuration changes based on the host profile.

You can also specify deferred parameters to verify additional host-specific data. The Profile Engine uses the policy options (HostProfile.Config.applyProfile.policy[]) to determine the required parameters (PolicyOption.parameter[]) for host configuration. If you do not provide all of the required parameters, you must call the method again to provide the complete list to the Profile Engine. After successful profile execution, when you apply the profile, the Profile Engine will save the host-specific data in an AnswerFile.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostProfile used to make the method call.

host P

ManagedObjectReference
to a HostSystem

Host on which to execute the profile. The host does not have to be associated with the profile.

Since vSphere API 4.0

deferredParam* P

ProfileDeferredPolicyOptionParameter[]

Additional configuration data to be applied to the host. This should contain all of the host-specific data, including data from from previous calls to the method.

Since vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description

Type	Description
ProfileExecuteResult	Result of the execution. If the operation is successful (ProfileExecuteResult.status`=success`), the result object includes a valid host configuration specification that you can pass to the HostProfileManager.ApplyHostConfig_Task method. If the operation is not successful, the object contains error information or information about additional data required for the host configuration. If additional data is required, the required input list (ProfileExecuteResult.requireInput[]) contains both the `deferredParam` data and paths to missing parameters. After you fill in the missing parameters, pass the complete required input list via the `deferredParam` parameter in another call to the execute method to finish input verification. After successful profile execution, you can pass the verified required input list to the ApplyHostConfig_Task method.

ProfileExecuteResult

Result of the execution. If the operation is successful (ProfileExecuteResult.status=success), the result object includes a valid host configuration specification that you can pass to the HostProfileManager.ApplyHostConfig_Task method.

If the operation is not successful, the object contains error information or information about additional data required for the host configuration. If additional data is required, the required input list (ProfileExecuteResult.requireInput[]) contains both the deferredParam data and paths to missing parameters. After you fill in the missing parameters, pass the complete required input list via the deferredParam parameter in another call to the execute method to finish input verification. After successful profile execution, you can pass the verified required input list to the ApplyHostConfig_Task method.

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.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ExecuteHostProfile" type="vim25:ExecuteHostProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ExecuteHostProfileResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:ProfileExecuteResult"/>
                     </sequence>
                  </complexType>
               </element>

HostProfileResetValidationState(ResetValidationState)

This API will update the validationState to Ready from Failed, invalidate the validationFailureInfo and reset the validationStateUpdateTime. This API will return error if the validationState is Running.

Required Privileges: Profile.Edit
Since: vSphere API 6.7

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfile used to make the method call.

Return Value

Type	Description
None

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.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostProfileResetValidationState" type="vim25:HostProfileResetValidationStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostProfileResetValidationStateResponse">
                  <complexType/>
               </element>

UpdateHostProfile(update)

Update the HostProfile with the specified configuration data.

Required Privileges: Profile.Edit

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostProfile used to make the method call.

config P

HostProfileConfigSpec

Specification containing the new data.

Since vSphere API 4.0

P Required privilege: config

Return Value

Type	Description
None

Faults

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateHostProfile" type="vim25:UpdateHostProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateHostProfileResponse">
                  <complexType/>
               </element>

UpdateReferenceHost(updateReferenceHost)

Sets the HostProfile.ReferenceHost property.

Required Privileges: Profile.Edit

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostProfile used to make the method call.

host* P

ManagedObjectReference
to a HostSystem

Reference host to use. If unset, the ReferenceHost property is cleared.

Since vSphere API 4.0

*Need not be set P Required privilege: host

Return Value

Type	Description
None

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.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateReferenceHost" type="vim25:UpdateReferenceHostRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateReferenceHostResponse">
                  <complexType/>
               </element>