Get Hosts Compatibility Report
Returns 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
string
host
Required
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
HclHostsCompatibilityReportResult
of type application/json
{
"identifier": "string",
"report": {
"devices_hcl": [
{
"compatibility": "COMPATIBLE",
"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"
},
"notes": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
],
"notes": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"supported_releases": [
"string"
],
"vcg_link": "string"
}
],
"generated_at": "string",
"host": "string",
"notifications": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"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": "SHORT_DATE",
"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": "SHORT_DATE",
"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": "SHORT_DATE",
"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": "SHORT_DATE",
"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": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
]
},
"server_hcl": {
"matches": [
{
"bios_constraints": [
{
"bios": {
"vendor": "string",
"version": "string"
},
"notes": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
],
"cpu_series": "string",
"notes": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"supported_releases": [
"string"
],
"vcg_link": "string"
}
],
"model_compatibility": "COMPATIBLE",
"server": {
"bios": {
"vendor": "string",
"version": "string"
},
"cpu_features": "string",
"cpu_series": "string",
"model_name": "string",
"vendor": "string"
}
},
"target_release": "string"
}
}
string
identifier
Optional
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
404
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.
500
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.
Code Samples
PowerCLI Client SDK Example
Invoke-GetHostHclCompatibilityReport -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-report
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
