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.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSoftwareSpecification.Write. - The resource
ClusterComputeResourcereferenced by the parameter cluster requiresVcIntegrity.lifecycleSoftwareSpecification.Write.
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Specification on how to filter recommendations based on a specified base image version.
This parameter was added in vSphere API 7.0.2.0.
If missing or null, latest and current series recommendations are generated.
{
"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.
This property was added in vSphere API 7.0.2.0.
Success!
If the recommendation generation is not supported.
This error was added in vSphere API 9.0.0.0.
"Vapi Std Errors Unsupported Object"If there is no cluster associated with cluster.
"Vapi Std Errors NotFound Object"If a new desired image is committed in parallel via a different client while recommendation is being generated.
"Vapi Std Errors ConcurrentChange Object"If there is unknown internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/clusters/{cluster}/software/recommendations?action=generate&vmw-task=true