Get Clusters Software
DescriptionReturns the complete desired software specification. 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
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
SettingsSoftwareInfo of type application/json
Cluster software specification.
{
"add_on": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"name": "string",
"version": "string"
},
"base_image": {
"details": {
"display_name": "string",
"display_version": "string",
"release_date": "string"
},
"version": "string"
},
"components": {
"key": {
"details": {
"display_name": "string",
"display_version": "string",
"vendor": "string"
},
"version": "string"
}
},
"hardware_support": {
"packages": {
"key": {
"pkg": "string",
"version": "string"
}
}
},
"solutions": {
"key": {
"components": [
{
"component": "string"
}
],
"details": {
"components": [
{
"component": "string",
"display_name": "string",
"display_version": "string",
"vendor": "string"
}
],
"display_name": "string",
"display_version": "string"
},
"version": "string"
}
}
}
map of
SettingsComponentInfo
components
Required
Information about the components in the software specification. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.esx.settings.component.
map of
SettingsSolutionInfo
solutions
Required
Information about the solutions in the software specification. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.esx.settings.solution.
add_on
Optional
OEM customization on top of given base-image. The components in this customization override the components in the base base-image. If unset, no OEM customization will be applied.
hardware_support
Optional
Information about the Hardware Support Packages (HSP) configured. If unset, no Hardware Support Package (HSP) is specified for the cluster.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software
Errors
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system.
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
