Host Profile Manager Apply Host Config Task

Host Profile Manager Apply Host Config Task

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.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostProfileManager/{moId}/ApplyHostConfig_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
ApplyHostConfigRequestType of type(s) application/json
Required 
"ApplyHostConfigRequestType Object"
object
host
Required

Reference to an instance of the HostSystem managed object.

object
configSpec
Required

The HostConfigSpec data object provides access to data objects that specify configuration changes to be applied to an ESX host.

array of object
userInput
Optional

Additional host-specific data to be applied to the host. This data is the complete list of deferred parameters verified by the HostProfile.HostProfile.ExecuteHostProfile method, contained in the ProfileExecuteResult object returned by the method.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

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

500

InvalidState: if the host is not in maintenance mode and the configuration specification requires it.

HostConfigFailed: if the ESX Server cannot apply the configuration changes.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostProfileManager/{moId}/ApplyHostConfig_Task
On This Page
Host Profile Manager Operations
POST
Host Profile Manager Apply Entities Config Task
POST
Host Profile Manager Apply Host Config Task
POST
Host Profile Manager Check Answer File Status Task
POST
Host Profile Manager Composite Host Profile Task
POST
Host Profile Manager Create Default Profile
POST
Host Profile Manager Create Profile
POST
Host Profile Manager Export Answer File Task
POST
Host Profile Manager Find Associated Profile
POST
Host Profile Manager Generate Config Task List
Deprecated
POST
Host Profile Manager Generate Host Config Task Spec Task
POST
Host Profile Manager Generate Host Profile Task List Task
POST
Host Profile Manager Query Answer File Status
POST
Host Profile Manager Query Policy Metadata
POST
Host Profile Manager Query Host Profile Metadata
POST
Host Profile Manager Query Profile Structure
POST
Host Profile Manager Retrieve Answer File
POST
Host Profile Manager Retrieve Answer File For Profile
POST
Host Profile Manager Retrieve Host Customizations
POST
Host Profile Manager Retrieve Host Customizations For Profile
POST
Host Profile Manager Update Answer File Task
POST
Host Profile Manager Update Host Customizations Task
POST
Host Profile Manager Validate Host Profile Composition Task
GET
Host Profile Manager Get Profile