REST API - generate-task
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software
  6. recommendations

esx settings clusters software recommendations: generate-task

Generates 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:

HTTP request

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

?action=generate
&vmw-task=true

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

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
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster.
409 concurrent_change If a new desired image is committed in parallel via a different client while recommendation is being generated.
503 service_unavailable If the service is not available.