Host Profile Manager Generate Config Task List

Host Profile Manager Generate Config Task List

Deprecated as of vSphere API 6.0 use GenerateHostProfileTaskList_Task.

Generate a list of configuration tasks that will be performed on the host during HostProfile application.

Required privileges: System.View

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

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

object
host
Required

Reference to an instance of the HostSystem managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

List of Configuration tasks.

Returns HostProfileManagerConfigTaskList of type(s) application/json
"HostProfileManagerConfigTaskList Object"
object
configSpec
Optional

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

array of object
taskDescription
Optional

Description of tasks that will be performed on the host to carry out HostProfile application.

array of string
taskListRequirement
Optional

A set of requirements whose actions must be fulfilled before and/or after the task list is applied on an ESXi host, e.g.

whether the ESXi host must be in maintenance mode prior to applying the configSpec, or whether the host will need to be rebooted after applying the configSpec. See HostProfileManagerTaskListRequirementEnum for details of supported values.


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