Esx. Settings. Clusters. Software. Reports. Hardware Compatibility. Details Get

Esx. Settings. Clusters. Software. Reports. Hardware Compatibility. Details Get

Returns the HCL validation check detailed results.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error 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
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details
COPY
Path Parameters
string
cluster
Required

identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

Query Parameters
string of array
device_compliance
Optional

Filter by compliance status (COMPATIBLE/INCOMPATIBLE/UNKNOWN)

Possible values:

  • COMPATIBLE: Target hardware is compliant with Broadcom Compatibility Guide (BCG)
  • INCOMPATIBLE: Target hardware is not (recognizably) compliant with Broadcom Compatibility Guide (BCG)
  • HCL_DATA_UNAVAILABLE: Never returned by the HCL compliance APIs

HCL data can not be fetched to validate cluster hardware.

  • UNAVAILABLE: Target hardware compliance with Broadcom Compatibility Guide (BCG) cannot be determined.
  • NO_FIRMWARE_PROVIDER: Never returned by the HCL compliance APIs

No Firmware HSM present in Software Spec to get Firmware Details Esx.Settings.HardwareSupportPackageInfo schema

For more information see: Esx.Settings.Clusters.Software.Reports.ComplianceStatus.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If missing or null compliance status is not considered

string of array
device_compliance_detail
Optional

Filter by detailed compliance status (CERTIFIED/USER_OVERRIDE etc.)

Possible values:

  • CERTIFIED: Hardware is specifically certified for target vSphere version according to the BCG/HCL
  • NOT_CERTIFIED: Hardware is specifically not certified for target vSphere version according to the BCG/HCL
  • HCL_DATA_UNAVAILABLE: HCL data can not be fetched to validate cluster hardware.
  • HOSTS_UNAVAILABLE: Hosts in cluster are not available to validate cluster hardware.
  • FIRMWARE_VERSION_UNKNOWN: No firmware version information is available (for example no Hardware Support Manager, HSM, configured in the cluster's Software Spec to get Firmware Details Esx.Settings.HardwareSupportPackageInfo schema or the system failed to retrieve the current firmware version of a device using the specified HSM.
  • UNKNOWN: When given hardware may be certified for a release but its status can't be definitively determined due to ambiguity in server model, CPU series, or BIOS version
  • VENDOR_UPDATE: When BIOS or firmware has been updated from a certified entry found in the Broadcom Compatibility Guide (BCG)
  • USER_VERIFIED: When a server or device's HCL compliance status has been overridden by the user to mark the system as compliant
  • USER_FLAGGED: When a server or device's HCL compliance status has been overridden by the user to mark the system as non-compliant
  • MUTED: When a user requests a non-compliance or HCL compliance unavailable warning to be suppressed

For more information see: Esx.Settings.Clusters.Software.Reports.ComplianceStatusDetail.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If missing or null detailed compliance status is not considered

string of array
hardware_category
Optional

Filter by hardware category

Possible values:

  • SERVER: Target hardware is host servers
  • PCI_DEVICE: Target hardware is PCI device
  • STORAGE_DEVICE: Target hardware is storage device

For more information see: Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.HardwareCategory.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If missing or null hardware category is not considered

string of array
device_class
Optional

Filter by device class

Possible values:

  • STORAGE_CONTROLLER: Target hardware is storage I/O controller (HBA / RAID Controller)
  • STORAGE_DEVICE: Target hardware is storage device controller (HDD, SSD, NVMe, ...)
  • NETWORK_INTERFACE: Target hardware is network interface card (NIC)
  • GRAPHICS_PROCESSOR: Target hardware is graphics processing unit (GPU)
  • OTHER: Target hardware is a class not captured in any of the preceding

For more information see: Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.DeviceClass.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

If missing or null device class is not considered

Authentication
This operation uses the following authentication methods.
Responses
200

CheckResult HCL validation result.

Returns Esx.Settings.Clusters.Software.Reports.CheckResult of type(s) application/json 
"Esx.Settings.Clusters.Software.Reports.CheckResult Object"

401

if the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json 
"Vapi.Std.Errors.Unauthenticated Object"

404

If there is no cluster associated with cluster in the system or if desired software document is not found.

Returns Vapi.Std.Errors.NotFound of type(s) application/json 
"Vapi.Std.Errors.NotFound Object"

500

If there is some other unknown internal error. The accompanying error message will give more details about the failure and any possible resolution(s).

Returns Vapi.Std.Errors.Error of type(s) application/json 
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json 
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details
On This Page
Esx.settings.clusters.software.reports.hardware Compatibility.details Operations
GET
Esx. Settings. Clusters. Software. Reports. Hardware Compatibility. Details Get