Esx.Settings.Clusters.Software.Reports.PciDeviceComplianceInfo

The Esx.Settings.Clusters.Software.Reports.PciDeviceComplianceInfo schema contains information that describe the compliance of a pci device with respect to the component present in the target software specification.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "status": "string",
    "detail": "string",
    "device": {
        "display_name": "string",
        "driver_name": "string",
        "vendor": "string",
        "vid": "string",
        "did": "string",
        "svid": "string",
        "ssid": "string"
    },
    "compatible_versions": [
        "string"
    ],
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "target": {
        "driver_version": "string",
        "firmware_version": "string",
        "driver_name": "string"
    },
    "default_image_host_details": {
        "image": {
            "display_name": "string"
        },
        "hosts": [
            "string"
        ]
    },
    "alternative_image_driver_fw_details": {
        "alternative_image_driver_fw_details": {
            "image_host_details": {
                "image": {
                    "display_name": "string"
                },
                "hosts": [
                    "string"
                ]
            },
            "target": {
                "driver_version": "string",
                "firmware_version": "string",
                "driver_name": "string"
            }
        }
    },
    "validated_features_in_use": {
        "validated_features_in_use": [
            "string"
        ]
    },
    "supported": [
        {
            "driver_version": "string",
            "firmware_version": "string",
            "driver_name": "string"
        }
    ],
    "constraints": [
        {
            "firmware_version": "string",
            "firmware_version_match": "string",
            "driver_name": "string",
            "driver_version": "string",
            "supported_features": {
                "supported_features": [
                    "string"
                ]
            }
        }
    ],
    "compatibility_guide_link": "string",
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ]
    }
}

string

status

Required

High-level compliance status of the device.

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.

This property was added in vSphere API 7.0.0.0.

string

detail

Optional

Detailed compliance status of the PCI device.

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.

This property is optional because it was added in a newer version than its parent node.

device

Required

Pci Device Details

This property was added in vSphere API 7.0.0.0.

array of string

compatible_versions

Required

List of vSphere Versions compatible for this device. This field is populated only for device found INCOMPATIBLE

This property was added in vSphere API 7.0.0.0.

object

host_info

Required

Affected List of Host IDs where this device is found.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

target

Required

Driver and Firmware Version from default image Specification.

This property was added in vSphere API 7.0.0.0.

default_image_host_details

Optional

This property contains information about the default image and the hosts on which it will be applied.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

object

alternative_image_driver_fw_details

Optional

This property contains target driver and firmware information for every alternative image that will be applied on its corresponding host.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.image. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.image.

object

validated_features_in_use

Optional

Validated features in use on this device If Service is set but features is empty, device is active for solution Subset of validated features for which we provide certification - for example RDMA, not IPV6 Inclusion in this set of features is independent of the certification status of device. In other words it's possible a device is configured to use a feature it is not certified.

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

array of Esx.Settings.Clusters.Software.Reports.DriverFirmwareVersion

supported

Required

This property is deprecated as of vSphere API 8.0.0.1.

List of Supported Driver and Firmware Version combination from Hardware Compatibility List.

This property was added in vSphere API 7.0.0.0.

array of Esx.Settings.Clusters.Software.Reports.PciDeviceConstraint

constraints

Optional

List of Supported Driver and Firmware Version combination and corresponding supportedFeatures from Broadcom Compatibility Guide (BCG) listing for the given vSphere version

This property was added in vSphere API 8.0.0.1.

This property is optional because it was added in a newer version than its parent node.

string As uri As uri

compatibility_guide_link

Optional

Provides link to the Broadcom Compatibility Guide for further information on the compatibility.

This property was added in vSphere API 7.0.0.0.

If missing or null there is no Broadcom Compatibility link available as this is device used by VSAN.

notifications

Optional

Device Specific notifications describing the compliance result.

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if there are no notifications

Property Of

Esx.Settings.Clusters.Software.Reports.PciDeviceCompliance