Host Profile Manager Apply Entities Config Task

Host Profile Manager Apply Entities Config Task

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.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostProfileManager/{moId}/ApplyEntitiesConfig_Task
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostProfileManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
ApplyEntitiesConfigRequestType of type(s) application/json
Required
"ApplyEntitiesConfigRequestType Object"
array of object
applyConfigSpecs
Optional

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.

Authentication
This operation uses the following authentication methods.
Responses
200

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.

Returns MoRefTask of type(s) application/json
"MoRefTask Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostProfileManager/{moId}/ApplyEntitiesConfig_Task