Generate Clusters Software Recommendations 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/recommendations?action=generate&vmw-task=true
Path Parameters
Path 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
SettingsClustersSoftwareRecommendationsFilterSpec of mimetype application/json
Optional
Specification on how to filter recommendations based on a specified base image version. If unset, latest and current series recommendations are generated.
{
"base_image_version": "string"
}
string
base_image_version
Optional
Base image version string is used in generating the specified base image recommendations. Default recommendations are generated when the value is empty.
Authentication
This operation uses the following authentication methods.
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.
Code Samples
PowerCLI Client SDK Example
$SettingsClustersSoftwareRecommendationsFilterSpec = Initialize-SettingsClustersSoftwareRecommendationsFilterSpec -BaseImageVersion "MyBaseImageVersion"
Invoke-GenerateClusterSoftwareRecommendationsAsync -Cluster "MyCluster" -SettingsClustersSoftwareRecommendationsFilterSpec $SettingsClustersSoftwareRecommendationsFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"base_image_version":"string"}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/recommendations?action=generate&vmw-task=true
Errors
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.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: generate_task
Availability
Added in 7.0.0
