Get Clusters Software Base Image

Released in v7.0.0

Returns the desired base-image specification set for given cluster 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

URL

GET

https://{api_host}/api/esx/settings/clusters/{cluster}/software/base-image

Path Parameters

Required	Parameter Name	Type	Description
required	cluster	string	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Response

Response Body

200 OK returns SettingsBaseImageInfo of type application/json

Base-image specification.

{
    "details": {
        "display_name": "string",
        "display_version": "string",
        "release_date": "string"
    },
    "version": "string"
}

Property Name	Type	Description
version	string	Version of the base-image
details	SettingsBaseImageDetails	Details about the base-image. unset if base-image is not present in the depot.

Errors

Code	Returns	Description
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.
404	Error	com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure. \| com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if desired specification is not found.
503	Error	com.vmware.vapi.std.errors.service_unavailable : If the service is not available.
default	Error	Not available