Check Task Clusters Enablement Software
Released in v7.0.0Checks the possibility to manage the cluster with a single software specification.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software?action=check&vmw-task=true
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains SettingsClustersEnablementSoftwareCheckSpec
of type application/json
(required)
{
"checks_to_skip": "enum"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | checks_to_skip | array of SettingsClustersEnablementSoftwareCheckType Enum |
Specifies the checks that should be skipped. If the set is empty, all checks will be performed. |
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. The result of the check operation
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"checks_to_skip":"enum"}' https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software?action=check&vmw-task=true
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system. |
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the feature is already enabled for the given cluster. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
