REST API - set-task

esx settings clusters software solutions: set-task

Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Request:

HTTP request

PUT https://{server}/api/esx/settings/clusters/{cluster}/software/solutions/{solution}

?vmw-task=true

{
    "components" : [
        {
            "component" : "obj-103"
        },
        {
            "component" : "obj-103"
        }
    ],
    "version" : "string"
}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier of the cluster.
solution	string	Identifier of the solution.

Body Parameters:

Name	Type	Description
bold = required
-	solution_spec	Registered solution specification.
-.version	string	Version of the solution.
-.components	solution_component_spec[]	Components registered by the solution.
-.components[].component	string	Identifier of the component. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.esx.settings.component`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.esx.settings.component`.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name	Type	Description
bold = required
-	string	ID of the newly created commit.

Errors:

HTTP Status Code	Type	Description
500	error	If there is unknown internal error. The accompanying error message will give more details about the failure.
400	invalid_argument	if validation of the software document fails. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in ValidateResult.
404	not_found	If there is no cluster associated with `cluster` or no solution associated with `solution` in the system.
503	service_unavailable	If the service is not available.
401	unauthenticated	if the caller is not authenticated.