Get Clusters Software Reports Hardware Compatibility Details
Released in v7.0.0 DescriptionReturns the hcl validation check detailed results. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read. - The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details
Parameters
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
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
SettingsClustersSoftwareReportsCheckResult
of type application/json
CheckResult hcl validation result.
{
"base_image_version": "string",
"commit": "string",
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"pci_device_compliance": {
"compatible_devices": [
{
"compatibility_guide_link": "string",
"compatible_versions": [
"string"
],
"device": {
"did": "string",
"display_name": "string",
"driver_name": "string",
"ssid": "string",
"svid": "string",
"vendor": "string",
"vid": "string"
},
"host_info": {
"key": {
"name": "string"
}
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"supported": [
{
"driver_name": "string",
"driver_version": "string",
"firmware_version": "string"
}
],
"target": {
"driver_name": "string",
"driver_version": "string",
"firmware_version": "string"
}
}
],
"incompatible_devices": [
{
"compatibility_guide_link": "string",
"compatible_versions": [
"string"
],
"device": {
"did": "string",
"display_name": "string",
"driver_name": "string",
"ssid": "string",
"svid": "string",
"vendor": "string",
"vid": "string"
},
"host_info": {
"key": {
"name": "string"
}
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"supported": [
{
"driver_name": "string",
"driver_version": "string",
"firmware_version": "string"
}
],
"target": {
"driver_name": "string",
"driver_version": "string",
"firmware_version": "string"
}
}
],
"incompatible_driver_firmware": [
{
"compatibility_guide_link": "string",
"compatible_versions": [
"string"
],
"device": {
"did": "string",
"display_name": "string",
"driver_name": "string",
"ssid": "string",
"svid": "string",
"vendor": "string",
"vid": "string"
},
"host_info": {
"key": {
"name": "string"
}
},
"notifications": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"status": "enum",
"supported": [
{
"driver_name": "string",
"driver_version": "string",
"firmware_version": "string"
}
],
"target": {
"driver_name": "string",
"driver_version": "string",
"firmware_version": "string"
}
}
],
"status": "enum"
},
"scan_time": "string",
"status": "enum",
"v_san_data_only": false
}
string
base_image_version
Required
Target base image version E.g., version = BaseImageSpec->Version BaseImageSpec.version structure
Std_LocalizableMessage
note
Required
Localizable disclaimer notice to show on the UI detailing the type of checks are done by the HCL Validaiton. Example : HCL Validation is only done on storage and network controllers.
notifications
Required
Notifications returned by the HCL Validation operation.
string
scan_time
Required
HCL Validation check time.
status
Required
Overall compliance status of Cluster with respective to all hosts in the cluster.
Possible values are:
string
commit
Optional
Spec Identifier of the desired configuration on which the HCL scan is performed to generate this result, populated by the HCL validation. unset if validation is performed with no spec When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.
pci_device_compliance
Optional
Compliance result for the Pci Devices that are present in all hosts of the cluster.
boolean
v_san_data_only
Optional
HCL Validation Computed only for vSAN Clusters. unset to show vSAN in UI
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details
Errors
404
com.vmware.vapi.std.errors.error : If there is some other unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system or if desired software document is not found.
