Developer Documentation
Generate Task Clusters Software Recommendations
Released in v7.0.0Generates 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. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | vmw-task=true is set in order to call this as an async API. The return value then becomes the Task ID instead that is used to query the result from the Task API. |
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 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. |
