Developer Documentation
Get Hosts Compatibility Report
Released in v7.0.0Returns the last generated hardware compatibility report for the given host.
Request
URLURL
https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-report
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The parameter must be an identifier for the resource type: HostSystem. |
Response
Response
Response BodyResponse Body
200 OK returns
CompatibilityReportResult
of type application/json
{
"identifier": "string",
"report": {
"devices_hcl": [
{
"compatibility": "enum",
"device": {
"class_code": "string",
"did": "string",
"driver": {
"name": "string",
"vendor": "string",
"version": "string"
},
"firmware": {
"vendor": "string",
"version": "string"
},
"model_name": "string",
"pci_address": "string",
"ssid": "string",
"sub_class_code": "string",
"svid": "string",
"used_by_vsan": false,
"vendor": "string",
"vid": "string"
},
"device_constraints": [
{
"driver": {
"name": "string",
"vendor": "string",
"version": "string"
},
"firmware": {
"vendor": "string",
"version": "string"
}
}
],
"supported_releases": [
"string"
],
"vcg_link": "string"
}
],
"generated_at": "string",
"host": "string",
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"server_hcl": {
"matches": [
{
"bios_constraints": [
{
"bios": {
"Hcl_Firmware": "Too large to render past this point..."
}
}
],
"cpu_series": "string",
"supported_releases": [
"string"
],
"vcg_link": "string"
}
],
"model_compatibility": "enum",
"server": {
"bios": {
"vendor": "string",
"version": "string"
},
"cpu_features": "string",
"cpu_series": "string",
"model_name": "string",
"vendor": "string"
}
},
"target_release": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| report | CompatibilityReportHclReport |
The hardware compatibility report. |
| identifier | string |
The identifier of the compatibility report. Reports.get provides location where a file based report based on the CompatibilityReport.HclReport can be downloaded using this identifier. unset in case of error reported in CompatibilityReport.HclReport.notifications. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport. |
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.not_found : if there is no report generated for the given host. This operation does not check if the host id is valid or it exists. | 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 | Error | Not available |
