Managed Object - HostProfileManager

Property of: ServiceContent
Extends: ProfileManager
See also: ApplyProfile, HostConfigSpec, HostProfileManagerConfigTaskList, HostSystem, ProfileMetadata
Since: vSphere API 4.0

Managed Object Description

The HostProfileManager provides access to a list of HostProfiles and it defines methods to manipulate profiles and AnswerFiles.

Properties

Name	Type	Description
None
Properties inherited from ProfileManager
profile

Methods

Methods defined in this Managed Object
ApplyHostConfig_Task, CreateDefaultProfile, GenerateConfigTaskList, QueryHostProfileMetadata
Methods inherited from ProfileManager
CreateProfile, FindAssociatedProfile, QueryPolicyMetadata

ApplyHostConfig_Task

Apply the configuration to the host. If you specify any user input, the configuration will be saved in the AnswerFile associated with the host. If there is no answer file, the Profile Engine will create one.

Required Privileges: Dynamic - See discussion above

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host	ManagedObjectReference to a HostSystem	Host to be updated. User must have sufficient credentials and privileges to satisfy the contents of the `configSpec`.
configSpec	HostConfigSpec	Set of configuration changes to be applied to the host. The changes are returned by the HostProfile.ExecuteHostProfile method in the ProfileExecuteResult.configSpec property.

Return Value

Type	Description
ManagedObjectReference to a SmsTask	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
HostConfigFailed	Thrown if the ESX Server cannot apply the configuration changes.
InvalidState	Thrown if the host is not in maintenance mode and the configuration specification requires it.
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

CreateDefaultProfile

Create a default subprofile of a given type (for example, a VirtualSwitchProfile). After you create the subprofile, you can add it to a configuration specification and update the host profile:

Call the CreateDefaultProfile method.

Create a HostProfileCompleteConfigSpec object.

Copy the existing profile from the host configuration information (HostProfile.config.applyProfile) to the configuration specification.

Add the new subprofile to the configuration specification. For example, if you create a VirtualSwitchProfile, you would add it to the list of virtual switches in the network profile for the configuration specification (NetworkProfile.vswitch[]).

Call HostProfile.UpdateHostProfile to save the new subprofile.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
profileType	xsd:string	Type of profile to create. The profile types are system-defined (ApplyProfile.profileTypeName).

Return Value

Type	Description
ApplyProfile	Derived subprofile of type `profileType`.

Faults

Type	Description
vim.fault.InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for the profile.
InvalidArgument	Thrown if either the profileType or profileTypeName is incorrect.
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

GenerateConfigTaskList

Deprecated. As of vSphere API 6.0 use GenerateHostProfileTaskList_Task

Generate a list of configuration tasks that will be performed on the host during HostProfile application.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
configSpec	HostConfigSpec	ConfigSpec which was proposed by ExecuteHostProfile method.
host	ManagedObjectReference to a HostSystem	Host on which the HostProfile application needs to be carried out.

Return Value

Type	Description
HostProfileManagerConfigTaskList	List of Configuration tasks.

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

QueryHostProfileMetadata

Retrieve the metadata for a set of profiles.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
profileName*	xsd:string[]	Names of the profiles for which metadata is requested. If not set, the method returns metadata for all the profiles.

*Need not be set

Return Value

Type	Description
ProfileMetadata[]	List of profile metadata objects.

Faults

Type	Description
vim.fault.InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for the profile.
InvalidArgument	Thrown if profileName parameter is invalid.
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