| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
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.
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.
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.
userInput
parameter to the
HostProfileManager.ApplyHostConfig_Task
method.
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.
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.
Properties
Name | Type | Description |
---|---|---|
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.
|
Properties inherited from Profile | ||
complianceStatus, config, createdTime, description, entity, modifiedTime, name |
Methods
Methods defined in this Managed Object |
---|
ExecuteHostProfile, UpdateHostProfile, UpdateReferenceHost |
Methods inherited from Profile |
AssociateProfile, CheckProfileCompliance_Task, DestroyProfile, DissociateProfile, ExportProfile, RetrieveDescription |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfile used to make the method call. |
host | ManagedObjectReference
to a HostSystem |
Host on which to execute the profile.
The host does not have to be associated with the profile.
|
deferredParam* | 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.
|
Return Value
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 |
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 |
HostProfile
with the specified configuration data.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfile used to make the method call. |
config | HostProfileConfigSpec |
Specification containing the new data.
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfile used to make the method call. |
host* | ManagedObjectReference
to a HostSystem |
Reference host to use. If unset, the referenceHost
property is cleared.
|
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |