Managed Object - HostProfileManager

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

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

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

Since vSphere API 6.5

*Need not be set P Required privilege: applyConfigSpecs

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

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	*Since* vSphere API 4.0
configSpec P	HostConfigSpec	*Since* vSphere API 4.0
userInput* P	ProfileDeferredPolicyOptionParameter[]	*Since* vSphere API 4.0

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

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
HostConfigFailed
InvalidState
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

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

Since vSphere API 5.0

P Required privilege: host

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

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 ConverterTask

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

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	*Since* vSphere API 4.0
profileTypeName* P	xsd:string	*Since* vSphere API 4.0
profile* P	ManagedObjectReference to a Profile	*Since* vSphere API 4.0

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

Return Value

Type	Description
ApplyProfile

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

ExportAnswerFile_Task

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

Since vSphere API 5.0

P Required privilege: host

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

configSpec P

HostConfigSpec

Since vSphere API 4.0

host P

ManagedObjectReference
to a HostSystem

Since vSphere API 4.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
HostProfileManagerConfigTaskList

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

GenerateHostConfigTaskSpec_Task

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

Since vSphere API 6.5

*Need not be set P Required privilege: hostsInfo

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

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

Since vSphere API 5.5

host P

ManagedObjectReference
to a HostSystem

Since vSphere API 5.5

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

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

Since vSphere API 5.0

P Required privilege: host

Return Value

Type	Description
AnswerFileStatusResult[]

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

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

Since vSphere API 4.0

profile* P

ManagedObjectReference
to a Profile

Since vSphere API 4.0

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

Return Value

Type	Description
ProfileMetadata[]

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

QueryProfileStructure

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

Since vSphere API 5.0

*Need not be set P Required privilege: profile

Return Value

Type	Description
ProfileProfileStructure

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

RetrieveAnswerFile

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

Since vSphere API 5.0

P Required privilege: host

Return Value

Type	Description
AnswerFile

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

RetrieveAnswerFileForProfile

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

Since vSphere API 5.1

applyProfile P

HostApplyProfile

Since vSphere API 5.1

PRequired privilege - see tooltip for details

Return Value

Type	Description
AnswerFile

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

RetrieveHostCustomizations

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

Since vSphere API 6.5

*Need not be set P Required privilege: hosts

Return Value

Type	Description
StructuredCustomizations[]

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

RetrieveHostCustomizationsForProfile

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

Since vSphere API 6.5

applyProfile P

HostApplyProfile

Since vSphere API 6.5

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

Return Value

Type	Description
StructuredCustomizations[]

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

UpdateAnswerFile_Task

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

Since vSphere API 5.0

configSpec P

AnswerFileCreateSpec

Since vSphere API 5.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

Faults

Type	Description
AnswerFileUpdateFailed
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

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

Since vSphere API 6.5

*Need not be set P Required privilege: hostToConfigSpecMap

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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

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
toReplaceWith* P	HostApplyProfile	*Since* vSphere API 6.5
toBeDeleted* P	HostApplyProfile	*Since* vSphere API 6.5
enableStatusToBeCopied* P	HostApplyProfile	*Since* vSphere API 6.5
errorOnly* P	xsd:boolean	*Since* vSphere API 6.5

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

Return Value

Type	Description
ManagedObjectReference to a ConverterTask

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