Managed Object - HostProfileManager(vim.profile.host.ProfileManager)

Property of: ServiceContent
Extends: ProfileManager
See also: AnswerFile, AnswerFileCreateSpec, AnswerFileStatusResult, ApplyHostProfileConfigurationResult, ApplyHostProfileConfigurationSpec, ApplyProfile, HostApplyProfile, HostConfigSpec, HostProfileManagerCompositionResult, HostProfileManagerCompositionValidationResult, HostProfileManagerConfigTaskList, HostProfileManagerHostToConfigSpecMap, HostSystem, Profile, ProfileDeferredPolicyOptionParameter, ProfileMetadata, ProfileProfileStructure, StructuredCustomizations
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
ApplyEntitiesConfig_Task, ApplyHostConfig_Task, CheckAnswerFileStatus_Task, CompositeHostProfile_Task, CreateDefaultProfile, ExportAnswerFile_Task, GenerateConfigTaskList, GenerateHostConfigTaskSpec_Task, GenerateHostProfileTaskList_Task, QueryAnswerFileStatus, QueryHostProfileMetadata, QueryProfileStructure, RetrieveAnswerFile, RetrieveAnswerFileForProfile, RetrieveHostCustomizations, RetrieveHostCustomizationsForProfile, UpdateAnswerFile_Task, UpdateHostCustomizations_Task, ValidateHostProfileComposition_Task
Methods inherited from ProfileManager
CreateProfile, FindAssociatedProfile, QueryPolicyMetadata

ApplyEntitiesConfig_Task(applyEntitiesConfiguration)

The task for applying host configuration on a list of hosts. This is the batch version of applyHostConfiguration. The implementation of this method will: When a host is in a DRS cluster but doesn't satisfy the state requirement such as that the host is not in the required maintenance mode, this method uses DRS feature to put the host into maintenance mode. This method will apply a host profile to a stateful host or stateless host; or apply a host profile to a stateless host by reboot. After a host is reboot, a check compliance is done to update the latest compliance status.

Required Privileges: None
Since: vSphere API 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

applyConfigSpecs* P

ApplyHostProfileConfigurationSpec[]

An array of ApplyHostProfileConfigurationSpec objects. Each applyConfigSpecs object contains the data objects required to remediate a host. The API caller should expand a cluster to all its hosts for the purpose of providing the required data object for configuration apply of each host.

Since vSphere API 6.5

*Need not be set P Required privilege: applyConfigSpecs

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 an array of ApplyHostProfileConfigurationResult objects. Each ApplyHostProfileConfigurationResult is for each host in the provided host list.

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

ApplyHostConfig_Task(applyHostConfiguration)

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: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
host P	ManagedObjectReference to a HostSystem	Host to be updated. User must have sufficient credentials and privileges to satisfy the contents of the `configSpec`. *Since* vSphere API 4.0
configSpec P	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. *Since* vSphere API 4.0
userInput* P	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 4.0

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

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(checkAnswerFileStatus)

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 P

ManagedObjectReference[]
to a HostSystem[]

Set of hosts for which the answer file status will be checked.

Since vSphere API 5.0

P Required privilege: host

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
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

CompositeHostProfile_Task(compositeProfile)

Composes (merge, replace, delete, disable) the selected configurations into the target host profiles.

Required Privileges: Profile.Edit
Since: vSphere API 6.7

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
source P	ManagedObjectReference to a Profile	*Since* vSphere API 6.5
targets* P	ManagedObjectReference[] to a Profile[]	*Since* vSphere API 6.5
toBeMerged* P	HostApplyProfile	*Since* vSphere API 6.5
toBeReplacedWith* P	HostApplyProfile	*Since* vSphere API 6.5
toBeDeleted* P	HostApplyProfile	*Since* vSphere API 6.5
enableStatusToBeCopied* P	HostApplyProfile	*Since* vSphere API 6.5

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

Return Value

Type	Description
ManagedObjectReference to a Task	This method will returns a Task object with which to monitor the operation. The Task.Info.result will contain a HostProfileManagerCompositionResult object containing the status of the operation, and details about any composition errors. The definitions of all the parameters are same as those in ValidateHostProfileComposition_Task.

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

CreateDefaultProfile(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 P	xsd:string	Type of profile to create. The profile types are system-defined (ApplyProfile.profileTypeName). *Since* vSphere API 4.0
profileTypeName* P	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 4.0
profile* P	ManagedObjectReference to a Profile	Base profile used during the operation. *Since* vSphere API 4.0

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

Return Value

Type	Description
ApplyProfile	Derived subprofile of type `profileType`.

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="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(exportAnswerFile)

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 P

ManagedObjectReference
to a HostSystem

Host with which the answer file is associated.

Since vSphere API 5.0

P Required privilege: host

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(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 P

HostConfigSpec

ConfigSpec which was proposed by ExecuteHostProfile method.

Since vSphere API 4.0

host P

ManagedObjectReference
to a HostSystem

Host on which the HostProfile application needs to be carried out.

Since vSphere API 4.0

PRequired privilege - see tooltip for details

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>

GenerateHostConfigTaskSpec_Task(generateHostConfigTaskSpec)

This method generates ApplyHostConfigSpec data object for each host which can be passed as input to ApplyEntitiesConfig_Task to configure that host. For each host, this method goes through two stages, ExecuteHostProfile stage GenerateHostProfileTaskList_Task stage. If the ExecuteHostProfile stage completes successfully then the method invokes the GenerateHostProfileTaskList_Task stage to generate the list of configuration tasks that are needed to configure the host. This method will return a task to monitor the progress of the operation.

Required Privileges: System.View
Since: vSphere API 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

hostsInfo* P

StructuredCustomizations[]

List of host data for which configuration task list needs to be generated. The StructuredCustomizations#customizations value should be provided only if the host customization data for that host is invalid. If this property is not provided, the API will use the host customization data stored in VC and generate task list.

Since vSphere API 6.5

*Need not be set P Required privilege: hostsInfo

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 ApplyHostProfileConfigurationSpec 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

GenerateHostProfileTaskList_Task(generateTaskList)

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 P

HostConfigSpec

ConfigSpec which was proposed by ExecuteHostProfile method.

Since vSphere API 5.5

host P

ManagedObjectReference
to a HostSystem

Host on which the HostProfile application needs to be carried out.

Since vSphere API 5.5

PRequired privilege - see tooltip for details

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(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 P

ManagedObjectReference[]
to a HostSystem[]

The hosts the answer file is associated with.

Since vSphere API 5.0

P Required privilege: host

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(queryProfileMetadata)

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* P

xsd:string[]

Names of the profiles for which metadata is requested. If not set, the method returns metadata for all the profiles.

Since vSphere API 4.0

profile* P

ManagedObjectReference
to a Profile

Base profile whose context needs to be used during the operation

Since vSphere API 4.0

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

Return Value

Type	Description
ProfileMetadata[]	List of profile metadata 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="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(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* P

ManagedObjectReference
to a Profile

Base profile whose context needs to be used during the operation

Since vSphere API 5.0

*Need not be set P Required privilege: profile

Return Value

Type	Description
ProfileProfileStructure	The profile structure.

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="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(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.

Since vSphere API 5.0

P Required privilege: host

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(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.

Since vSphere API 5.1

applyProfile P

HostApplyProfile

Profile configuration used to generate answer file

Since vSphere API 5.1

PRequired privilege - see tooltip for details

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>

RetrieveHostCustomizations(retrieveHostCustomizations)

This is the batch version of vim.profile.host.ProfileManager@retrieveAnswerFile. Returns a map that contains the hosts and their answer file data objects.

Required Privileges: None
Since: vSphere API 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

hosts* P

ManagedObjectReference[]
to a HostSystem[]

Hosts with which the answer files are associated.

Since vSphere API 6.5

*Need not be set P Required privilege: hosts

Return Value

Type	Description
StructuredCustomizations[]	A map that contains the hosts and their answer files.

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

RetrieveHostCustomizationsForProfile(retrieveHostCustomizationsForProfile)

This is the batch version of vim.profile.host.ProfileManager@retrieveAnswerFileForProfile. Returns a map that contains the hosts and their answer files associated with these hosts, augmented with whatever answer file values are required for the supplied host profile.

Required Privileges: None
Since: vSphere API 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

hosts* P

ManagedObjectReference[]
to a HostSystem[]

Hosts with which the answer files are associated.

Since vSphere API 6.5

applyProfile P

HostApplyProfile

Profile configuration used to generate answer file

Since vSphere API 6.5

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

Return Value

Type	Description
StructuredCustomizations[]	A map contains the hosts and their answer files.

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

UpdateAnswerFile_Task(updateAnswerFile)

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 P

ManagedObjectReference
to a HostSystem

Host with which the answer file is associated.

Since vSphere API 5.0

configSpec P

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.

Since vSphere API 5.0

PRequired privilege - see tooltip for details

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.
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

UpdateHostCustomizations_Task(updateHostCustomizations)

This is the batch version of vim.profile.host.ProfileManager@updateAnswerFile.

Required Privileges: Profile.Edit
Since: vSphere API 6.5

Parameters

Name Type Description

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

hostToConfigSpecMap* P

HostProfileManagerHostToConfigSpecMap[]

A map that contains the hosts with which the answer files are associated and the corresponding 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.

Since vSphere API 6.5

*Need not be set P Required privilege: hostToConfigSpecMap

Return Value

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

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

ValidateHostProfileComposition_Task(validateComposition)

Validates the proposed host profile composition.

Required Privileges: Profile.Edit
Since: vSphere API 6.7

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostProfileManager used to make the method call.
source P	ManagedObjectReference to a Profile	The source host profile of the configurations for composition. *Since* vSphere API 6.5
targets* P	ManagedObjectReference[] to a Profile[]	The array of target host profiles that the configurations composite into. *Since* vSphere API 6.5
toBeMerged* P	HostApplyProfile	A HostApplyProfile object contains the sub profiles that will be merged from the source to the target host profiles, and all the ancestors of these sub profiles. For singleton sub profile, it will be added into a target host profile if it doesn't exist in the target; otherwise, it replaces the one in the target. The member variable toBeMerged of these sub profiles should have a value of `true`. The member variables toBeMerged toReplaceWith, toBeDeleted of the ancestors should have a value of `false`. *Since* vSphere API 6.5
toReplaceWith* P	HostApplyProfile	A HostApplyProfile object contains the sub profiles that will be used to replace the array in the target host profiles, and all the ancestors of these sub profiles. Similar to above except that the member variable toReplaceWith is turned on. *Since* vSphere API 6.5
toBeDeleted* P	HostApplyProfile	A HostApplyProfile object contains the sub profiles that will be deleted from the source and the target host profiles, and all the ancestors of these sub profiles. Similar to above except that the member variable toBeDeleted is turned on. *Since* vSphere API 6.5
enableStatusToBeCopied* P	HostApplyProfile	A HostApplyProfile object contains the sub profiles that the member variable enabled will be copied from the source host profile to all the target host profiles, and all the ancestors of these sub profiles. The member variable copyEnableStatus of these sub profiles is turned on. The member variable copyEnableStatus of the copyEnableStatus of the ancestors should have a value of `false`. *Since* vSphere API 6.5
errorOnly* P	xsd:boolean	Indicates that the validation result for each target don't contain the source-target difference. *Since* vSphere API 6.5

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

Return Value

Type	Description
ManagedObjectReference to a Task	This method will returns a Task object with which to monitor the operation. The Task.Info.result will contain a HostProfileManagerCompositionValidationResult object containing the status of the operation, any validation errors and the validation results.

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