Managed Object - HostProfileManager

Property of: ServiceContent
Extends: ProfileManager
See also: AnswerFile, AnswerFileCreateSpec, AnswerFileStatusResult, ApplyProfile, HostApplyProfile, HostConfigSpec, HostProfileManagerConfigTaskList, HostSystem, Profile, ProfileDeferredPolicyOptionParameter, ProfileMetadata, ProfileProfileStructure
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, CheckAnswerFileStatus_Task, CreateDefaultProfile, ExportAnswerFile_Task, GenerateConfigTaskList, GenerateHostProfileTaskList_Task, QueryAnswerFileStatus, QueryHostProfileMetadata, QueryProfileStructure, RetrieveAnswerFile, RetrieveAnswerFileForProfile, UpdateAnswerFile_Task
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.
userInput*	ProfileDeferredPolicyOptionParameter[]	Additional host-specific data to be applied to the host. This data is the complete list of deferred parameters verified by the HostProfile.ExecuteHostProfile method, contained in the ProfileExecuteResult object returned by the method. *Since* vSphere API 5.0

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a Task	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

CheckAnswerFileStatus_Task

Check the validity of the answer files for the specified hosts. The Profile Engine uses the profile associated with a host to check the answer file.

Required Privileges: System.View
Since: vSphere API 5.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host	ManagedObjectReference[] to a HostSystem[]	Set of hosts for which the answer file status will be checked.

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. If the task is successful, the Task.info.result property contains a list of AnswerFileStatusResult objects.

Faults

Type	Description
InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for 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

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).
profileTypeName*	xsd:string	If specified, the method returns a profile object containing data for the named profile. The type name does not have to be system-defined. A user-defined profile can include various dynamically-defined profiles. *Since* vSphere API 5.0
profile*	ManagedObjectReference to a Profile	Base profile used during the operation. *Since* vSphere API 5.0

*Need not be set

Return Value

Type	Description
ApplyProfile	Derived subprofile of type `profileType`.

Faults

Type	Description
InvalidArgument	Thrown if either the profileType or profileTypeName is incorrect.
InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for 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="CreateDefaultProfile" type="vim25:CreateDefaultProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateDefaultProfileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ApplyProfile"/>
               </sequence>
            </complexType>
         </element>

ExportAnswerFile_Task

Export a host's answer file into a serialized form. The method returns a string that contains only the list of user input options. See AnswerFile.userInput.

Required Privileges: Profile.Export
Since: vSphere API 5.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host	ManagedObjectReference to a HostSystem	Host with which the answer file is associated.

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. If the task is successful, the Task.info.result property is a string that contains a serialized form of the answer file.

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

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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GenerateConfigTaskList" type="vim25:GenerateConfigTaskListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="GenerateConfigTaskListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostProfileManagerConfigTaskList"/>
               </sequence>
            </complexType>
         </element>

GenerateHostProfileTaskList_Task

Generate a list of configuration tasks that will be performed on the host during HostProfile application. This differs from the GenerateConfigTaskList method in that it returns a task to monitor the progress of the operation.

Required Privileges: System.View
Since: vSphere API 5.5

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
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. If the task is successful, the Task.info.result property is a HostProfileManagerConfigTaskList object.

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

QueryAnswerFileStatus

Returns the status of the answer files associated with specified hosts. This method returns the most recent status determined by CheckAnswerFileStatus_Task. See HostProfileManagerAnswerFileStatus for valid values.

Required Privileges: System.View
Since: vSphere API 5.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host	ManagedObjectReference[] to a HostSystem[]	The hosts the answer file is associated with.

Return Value

Type	Description
AnswerFileStatusResult[]	List of answer file status objects.

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="QueryAnswerFileStatus" type="vim25:QueryAnswerFileStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryAnswerFileStatusResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:AnswerFileStatusResult" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

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.

profile*

ManagedObjectReference
to a Profile

Base profile whose context needs to be used during the operation

Since vSphere API 5.0

*Need not be set

Return Value

Type	Description
ProfileMetadata[]	List of profile metadata objects.

Faults

Type	Description
InvalidArgument	Thrown if profileName parameter is invalid.
InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for 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="QueryHostProfileMetadata" type="vim25:QueryHostProfileMetadataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryHostProfileMetadataResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ProfileMetadata" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

QueryProfileStructure

Get information about the structure of the profile.

Required Privileges: System.View
Since: vSphere API 5.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

profile*

ManagedObjectReference
to a Profile

Base profile whose context needs to be used during the operation

Since vSphere API 5.0

*Need not be set

Return Value

Type	Description
ProfileProfileStructure	The profile structure.

Faults

Type	Description
InvalidProfileReferenceHost	Thrown if the reference host associated with the profile is incompatible or there is no reference host for 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="QueryProfileStructure" type="vim25:QueryProfileStructureRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryProfileStructureResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ProfileProfileStructure"/>
               </sequence>
            </complexType>
         </element>

RetrieveAnswerFile

Returns the answer file associated with a particular host.

Required Privileges: None
Since: vSphere API 5.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host P	ManagedObjectReference to a HostSystem	Host with which the answer file is associated.

P Required privilege: Profile.Edit

Return Value

Type	Description
AnswerFile	Answer file object will be returned if it exists.

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="RetrieveAnswerFile" type="vim25:RetrieveAnswerFileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveAnswerFileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:AnswerFile" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

RetrieveAnswerFileForProfile

Returns the answer file associated with a particular host, augmented with whatever answer file values are required for the supplied host profile.

Required Privileges: None
Since: vSphere API 5.1

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host P	ManagedObjectReference to a HostSystem	Host with which the answer file is associated.
applyProfile	HostApplyProfile	Profile configuration used to generate answer file

P Required privilege: Profile.Edit

Return Value

Type	Description
AnswerFile	Answer file object will be returned.

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="RetrieveAnswerFileForProfile" type="vim25:RetrieveAnswerFileForProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RetrieveAnswerFileForProfileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:AnswerFile" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

UpdateAnswerFile_Task

Update the AnswerFile for the specified host. If there is no answer file associated with the host, the Profile Engine uses the answer file configuration specification to create a new one.

Required Privileges: Profile.Edit
Since: vSphere API 5.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host	ManagedObjectReference to a HostSystem	Host with which the answer file is associated.
configSpec	AnswerFileCreateSpec	Host-specific configuration data. If the configuration specification does not contain any host-specific user input (`configSpec`.userInput), the method does not perform any operation on the answer file.

Return Value

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

Faults

Type	Description
AnswerFileUpdateFailed	Thrown if the answer file could not be updated.
InvalidArgument	Thrown if the input parameteres are 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