Esx.Settings.Clusters.Software.Reports.PciDeviceCompliance

Esx.Settings.Clusters.Software.Reports.PciDeviceCompliance
Esx.Settings.Clusters.Software.Reports.PciDeviceCompliance

The Esx.Settings.Clusters.Software.Reports.PciDeviceCompliance schema contains information that describe the compliance result of all pci device from all hosts in the clsuter 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",
    "compatible_devices": [
        {
            "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
                    }
                ]
            }
        }
    ],
    "incompatible_devices": [
        {
            "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
                    }
                ]
            }
        }
    ],
    "incompatible_driver_firmware": [
        {
            "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

Over all Compliance status of PCI Devices in Cluster with respective to all hosts in the cluster.

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.

compatible_devices
Required

Compatible Device Compliance result for all devices present on all hosts in the cluster compared with the corresponding component in the software specification. The key is the DeviceName and value is the PciDeviceComplianceInfo object.

This property was added in vSphere API 7.0.0.0.

incompatible_devices
Required

Incompatible Device Compliance result for all devices present on all hosts in the cluster compared with the corresponding component in the software specification. The key is the DeviceName and value is the PciDeviceComplianceInfo object.

This property was added in vSphere API 7.0.0.0.

incompatible_driver_firmware
Required

Incompatible Driver Firmware combination Compliance result for all devices present on hosts in the cluster compared with the corresponding component in the software specification. The key is the DeviceName and value is the PciDeviceComplianceInfo object.

This property was added in vSphere API 7.0.0.0.