Esx. Settings. Clusters. Software. Recommendations Get

Esx. Settings. Clusters. Software. Recommendations Get

Returns Information about the most recent recommendation generation result.

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.Read.
  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.
Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/software/recommendations
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

Authentication
This operation uses the following authentication methods.
Responses
200

Information about the most recent recommendation generation result.

Returns Esx.Settings.Clusters.Software.Recommendations.Info of type(s) application/json 
"Esx.Settings.Clusters.Software.Recommendations.Info Object"

404

If there is no cluster associated with cluster in the system or recommendation is non-existing for the cluster due to either it is never generated or deleted due to changes in cluster state such as a new desired image spec being committed.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

If there is unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/clusters/{cluster}/software/recommendations
On This Page
Esx.settings.clusters.software.recommendations Operations
GET
Esx. Settings. Clusters. Software. Recommendations Get
POST
Esx. Settings. Clusters. Software. Recommendations Generate$ Task