Esx. Settings. Clusters. Software. Base Image Get

Esx. Settings. Clusters. Software. Base Image Get

Returns the desired base-image specification set for given cluster

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/base-image
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

Base-image specification.

Returns Esx.Settings.BaseImageInfo of type(s) application/json 
"Esx.Settings.BaseImageInfo 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 or if desired specification is not found.

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/base-image
On This Page
Esx.settings.clusters.software.base Image Operations
GET
Esx. Settings. Clusters. Software. Base Image Get