Esx. Settings. Clusters. Software Get

Esx. Settings. Clusters. Software Get

Returns the complete desired software specification. In case of Single Image Cluster, the specification will contain Default Image In case of Composite Image Cluster, the specification will contain Default Image + Alternative Images

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
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

Cluster software specification.

Returns Esx.Settings.SoftwareInfo of type(s) application/json 
"Esx.Settings.SoftwareInfo Object"

401

If the caller is not authenticated.

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

404

If there is no cluster associated with cluster in the system.

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
On This Page
Esx.settings.clusters.software Operations
GET
Esx. Settings. Clusters. Software Get
GET
Esx. Settings. Clusters. Software Get Default Image
POST
Esx. Settings. Clusters. Software Export
GET
Esx. Settings. Clusters. Software Get Display Name
POST
Esx. Settings. Clusters. Software Scan$ Task
POST
Esx. Settings. Clusters. Software Stage$ Task
POST
Esx. Settings. Clusters. Software Apply$ Task
POST
Esx. Settings. Clusters. Software Check$ Task