Scripting Object - VcHostProfile

Scripting-object corresponding to
HostProfile

Scripting Object Description

A host profile describes ESX Server configuration. The {@link 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 {@link vim.profile.host.HostApplyProfile} data object ({@link HostProfile}.{@link vim.profile.Profile#config}.{@link vim.profile.host.HostProfile.ConfigInfo#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.

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.

The Profile Engine saves host-specific data in an {@link vim.profile.host.AnswerFile} that is stored on the vCenter Server. The {@link vim.profile.host.ProfileManager} 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.

You can also use the Profile Compliance Manager to check compliance by specifying profiles, entities (hosts), or both. See {@link vim.profile.ComplianceManager}.{@link vim.profile.ComplianceManager#checkCompliance}.

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 {@link vim.profile.ApplyProfile}.{@link vim.profile.ApplyProfile#policy}[] and {@link vim.profile.ApplyProfile}.{@link vim.profile.ApplyProfile#property}[] lists. The {@link vim.profile.host.HostApplyProfile} and its subprofiles, which collectively define host configuration data, are derived from the {@link vim.profile.ApplyProfile}.


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.

Attributes

Name Type Description
complianceStatusString

@since vSphere API 4.0
configVcProfileConfigInfo

@since vSphere API 4.0
createdTimeDate

@since vSphere API 4.0
descriptionVcProfileDescription

@since vSphere API 4.0
entityVcManagedEntity []

@since vSphere API 4.0
idString

@since Unknown
modifiedTimeDate

@since vSphere API 4.0
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
nameString

@since vSphere API 4.0
referenceHostVcHostSystem

@since vSphere API 4.0
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, associateProfile, checkProfileCompliance_Task, createTrigger, destroyProfile, dissociateProfile, executeHostProfile, exportProfile, retrieveDescription, updateHostProfile, updateReferenceHost, validateHostProfile

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

destroyProfile

Destroy the profile. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

dissociateProfile

Remove the association between a profile and a managed entity. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcManagedEntity []


Return Value

Type Description
None

exportProfile

Export the profile in a serialized form. To use the serialized string to create a profile, specify a {@link vim.profile.Profile.SerializedCreateSpec} when you call the {@link vim.profile.host.ProfileManager}.{@link vim.profile.ProfileManager#createProfile} method. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
String

executeHostProfile

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 ({@link HostProfile}.{@link vim.profile.Profile#config}.{@link HostProfile.ConfigInfo#applyProfile}.{@link vim.profile.ApplyProfile#policy}[]) to determine the required parameters ({@link vim.profile.PolicyOption}.{@link vim.profile.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 {@link vim.profile.host.AnswerFile}. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostSystem

arg1VcProfileDeferredPolicyOptionParameter []


Return Value

Type Description
VcProfileExecuteResult

validateHostProfile

Verify the HostProfile with the specified configuration data. This differs from the {@link HostProfile}.{@link HostProfile#update} method in that the verification checks will be run, but the host profile itself will not be saved. A subsequent call to {@link HostProfile}.{@link HostProfile#update} will still be required to save the host profile. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0VcHostProfileConfigSpec


Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

updateHostProfile

Update the HostProfile with the specified configuration data. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostProfileConfigSpec


Return Value

Type Description
None

updateReferenceHost

Sets the {@link HostProfile}.{@link HostProfile#referenceHost} property. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostSystem


Return Value

Type Description
None

retrieveDescription

Returns the localizable description for the profile. @since vSphere API 5.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcProfileDescription

checkProfileCompliance_Task

Check compliance of an entity against a Profile. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcManagedEntity []


Return Value

Type Description
VcTask

associateProfile

Associate a profile with a managed entity. You can check the compliance of entities associated with a profile by calling the {@link vim.profile.Profile#checkCompliance} method. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcManagedEntity []


Return Value

Type Description
None