Generate Clusters Software Recommendations Task
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
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
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
404
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
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.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
