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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
applyConfigSpecs* PApplyHostProfileConfigurationSpec[]

Since vSphere API 6.5
*Need not be set P Required privilege: applyConfigSpecs

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
configSpec PHostConfigSpec

Since vSphere API 4.0
userInput* PProfileDeferredPolicyOptionParameter[]

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference[]
to a HostSystem[]

Since vSphere API 5.0
P Required privilege: host

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
source PManagedObjectReference
to a Profile

Since vSphere API 6.5
targets* PManagedObjectReference[]
to a Profile[]

Since vSphere API 6.5
toBeMerged* PHostApplyProfile

Since vSphere API 6.5
toBeReplacedWith* PHostApplyProfile

Since vSphere API 6.5
toBeDeleted* PHostApplyProfile

Since vSphere API 6.5
enableStatusToBeCopied* PHostApplyProfile

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
profileType Pxsd:string

Since vSphere API 4.0
profileTypeName* Pxsd:string

Since vSphere API 4.0
profile* PManagedObjectReference
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
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference
to a HostSystem

Since vSphere API 5.0
P Required privilege: host

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
configSpec PHostConfigSpec

Since vSphere API 4.0
host PManagedObjectReference
to a HostSystem

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
HostProfileManagerConfigTaskList

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
hostsInfo* PStructuredCustomizations[]

Since vSphere API 6.5
*Need not be set P Required privilege: hostsInfo

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
configSpec PHostConfigSpec

Since vSphere API 5.5
host PManagedObjectReference
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
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference[]
to a HostSystem[]

Since vSphere API 5.0
P Required privilege: host

Return Value

Type Description
AnswerFileStatusResult[]

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
profileName* Pxsd:string[]

Since vSphere API 4.0
profile* PManagedObjectReference
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
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
profile* PManagedObjectReference
to a Profile

Since vSphere API 5.0
*Need not be set P Required privilege: profile

Return Value

Type Description
ProfileProfileStructure

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference
to a HostSystem

Since vSphere API 5.0
P Required privilege: host

Return Value

Type Description
AnswerFile

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference
to a HostSystem

Since vSphere API 5.1
applyProfile PHostApplyProfile

Since vSphere API 5.1
PRequired privilege - see tooltip for details

Return Value

Type Description
AnswerFile

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
hosts* PManagedObjectReference[]
to a HostSystem[]

Since vSphere API 6.5
*Need not be set P Required privilege: hosts

Return Value

Type Description
StructuredCustomizations[]

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
hosts* PManagedObjectReference[]
to a HostSystem[]

Since vSphere API 6.5
applyProfile PHostApplyProfile

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
StructuredCustomizations[]

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
host PManagedObjectReference
to a HostSystem

Since vSphere API 5.0
configSpec PAnswerFileCreateSpec

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
hostToConfigSpecMap* PHostProfileManagerHostToConfigSpecMap[]

Since vSphere API 6.5
*Need not be set P Required privilege: hostToConfigSpecMap

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

NameTypeDescription
_thisManagedObjectReference A reference to the HostProfileManager used to make the method call.
source PManagedObjectReference
to a Profile

Since vSphere API 6.5
targets* PManagedObjectReference[]
to a Profile[]

Since vSphere API 6.5
toBeMerged* PHostApplyProfile

Since vSphere API 6.5
toReplaceWith* PHostApplyProfile

Since vSphere API 6.5
toBeDeleted* PHostApplyProfile

Since vSphere API 6.5
enableStatusToBeCopied* PHostApplyProfile

Since vSphere API 6.5
errorOnly* Pxsd: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
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None