Get Clusters Software Base Image
DescriptionReturns 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/base-image
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
SettingsBaseImageInfo of type application/json
Base-image specification.
{
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string"
},
"version": "string"
}
string
version
Required
Version of the base-image
details
Optional
Details about the base-image. unset if base-image is not present in the depot.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/base-image
Errors
404
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.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
Availability
Added in 7.0.0
