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
?action=generate
&vmw-task=true
{
"base_image_version" : "string"
}
"base_image_version" : "string"
}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| cluster | string | Identifier of the cluster. |
Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | filter_spec | Optional. Specification on how to filter recommendations based on a specified base image version. Warning: This parameter is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| -.base_image_version | string | Base image version string is used in generating the specified base image recommendations. Default recommendations are generated when the value is empty. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. |
Response:
HTTP Status Code: 202
Response Body Structure:
"obj-103"
Headers:
NoneType:
| 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. |