Generate Task Clusters Software Recommendations
Released in v7.0.0 DescriptionGenerates recommended software image spec(s) based on current desired software 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/recommendations?action=generate&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 |
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.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/recommendations?action=generate&vmw-task=true
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.error : If there is unknown internal 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. |
| 409 | Error | com.vmware.vapi.std.errors.concurrent_change : If a new desired image is committed in parallel via a different client while recommendation is being generated. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
