Host Profile Manager Generate Host Config Task Spec Task

This method generates ApplyHostProfileConfigurationSpec data object for each host which can be passed as input to ApplyEntitiesConfig_Task to configure that host.

For each host, this method goes through two stages, ExecuteHostProfile stage GenerateHostProfileTaskList_Task stage. If the ExecuteHostProfile stage completes successfully then the method invokes the GenerateHostProfileTaskList_Task stage to generate the list of configuration tasks that are needed to configure the host. This method will return a task to monitor the progress of the operation.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostProfileManager/{moId}/GenerateHostConfigTaskSpec_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.3.0 APIs.

Request Body

GenerateHostConfigTaskSpecRequestType of type(s) application/json

Required

{
    "hostsInfo": [
        {
            "_typeName": "string",
            "entity": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "customizations": {
                "_typeName": "string",
                "userInput": [
                    {
                        "_typeName": "string",
                        "inputPath": {
                            "_typeName": "string",
                            "profilePath": "string",
                            "policyId": "string",
                            "parameterId": "string",
                            "policyOptionId": "string"
                        },
                        "parameter": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ]
                    }
                ],
                "createdTime": "string",
                "modifiedTime": "string"
            }
        }
    ]
}

array of StructuredCustomizations

hostsInfo

Optional

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.

Authentication

This operation uses the following authentication methods.

Session

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 a ApplyHostProfileConfigurationSpec object.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations