Check Clusters Enablement Software Task
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
Parameters
Parameters
string
cluster
Required
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
SettingsClustersEnablementSoftwareCheckSpec of type application/json (optional){
"checks_to_skip": "enum"
}
checks_to_skip
Required
Specifies the checks that should be skipped. If the set is empty, all checks will be performed.
Possible values are:
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
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If the feature is already enabled for the given cluster.
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system.
500
com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
