List Hosts Compatibility Releases
DescriptionLists the locally available ESXi releases for a given host that can be used to generate a compatiblity report. Each host has its own list of supported releases depending on its current release. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read.
Request
URLURL
https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-releases
Parameters
Parameters
string
host
Required
Contains the MoID identifying the ESXi host.
The parameter must be an identifier for the resource type: HostSystem.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
HclHostsCompatibilityReleasesEsxiCompatibilityReleases
of type application/json
Available releases for compatibility for a specified host.
{
"current_compatibility_release": "string",
"newer_compatibility_releases": [
"string"
],
"notifications": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
]
}
}
string
current_compatibility_release
Required
The current release of the ESXi, which also can be checked for compatibility. The information for the release does not include patch information.
array of
string
newer_compatibility_releases
Required
The available ESXi releases, greater than the current one, than can be checked for compatibility.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-releases
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if there is no compatibility data on the vCenter executing the operation. | com.vmware.vapi.std.errors.unsupported : if the provided host is not supported.
500
com.vmware.vapi.std.errors.internal_server_error : If there is some internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.resource_inaccessible : if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP). | com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.