REST API - apply-task

esx settings clusters configuration: apply-task

Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/esx/settings/clusters/{cluster}/configuration

?action=apply
&vmw-task=true

{
    "hosts" : [
        "obj-103",
        "obj-103"
    ],
    "commit" : "obj-103"
}

Path Parameters

Name	Type	Description
Required
cluster	string

Body Parameters:

Name	Type	Description
bold = required
-	apply_spec
-.commit	string	The minimum commit identifier of the desired configuration to be used during the apply operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. if unset or empty the apply operation will use the latest commit to fetch the desired configuration.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.commit`. 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.commit`.
-.hosts	string[]	The specific hosts within the cluster to be considered during the apply operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. if unset or empty the apply operation will remediate all hosts within the cluster.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `HostSystem`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `HostSystem`.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name	Type	Description
bold = required
-	string

Errors:

HTTP Status Code	Type	Description
400	already_in_desired_state
500	error
400	invalid_argument
400	not_allowed_in_current_state
404	not_found
503	service_unavailable
500	timed_out
401	unauthenticated