| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None | ||
Properties inherited from ProfileManager | ||
profile |
Methods
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfileManager used to make the method call. |
applyConfigSpecs* | 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.
|
Return Value
Type | Description |
---|---|
pbm.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 |
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 |
Return Value
Type | Description |
---|---|
pbm.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 |
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 |
---|---|
pbm.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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfileManager used to make the method call. |
source | ManagedObjectReference
to a Profile |
|
targets* | ManagedObjectReference[]
to a Profile[] |
|
toBeMerged* | HostApplyProfile |
|
toBeReplacedWith* | HostApplyProfile |
|
toBeDeleted* | HostApplyProfile |
|
enableStatusToBeCopied* | HostApplyProfile |
|
Return Value
Type | Description |
---|---|
pbm.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
method.VirtualSwitchProfile
, you would add it to the list
of virtual switches in the network profile for the configuration specification
(NetworkProfile.vswitch[]).
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 |
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 |
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 |
---|---|
pbm.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 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfileManager used to make the method call. |
hostsInfo* | 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.
|
Return Value
Type | Description |
---|---|
pbm.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 |
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 |
---|---|
pbm.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 |
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 |
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 |
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 |
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 |
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 |
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.
|
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 |
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
|
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 |
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.
|
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 |
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.
|
applyProfile | HostApplyProfile |
Profile configuration used to generate answer file
|
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 |
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 |
---|---|
pbm.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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfileManager used to make the method call. |
hostToConfigSpecMap* | 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.
|
Return Value
Type | Description |
---|---|
pbm.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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostProfileManager used to make the method call. |
source | ManagedObjectReference
to a Profile |
The source host profile of the configurations for
composition.
|
targets* | ManagedObjectReference[]
to a Profile[] |
The array of target host profiles that the configurations
composite into.
|
toBeMerged* | 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 .
|
toReplaceWith* | 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.
|
toBeDeleted* | 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.
|
enableStatusToBeCopied* | 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 .
|
errorOnly* | xsd:boolean |
Indicates that the validation result for each target
don't contain the source-target difference.
|
Return Value
Type | Description |
---|---|
pbm.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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |