Esx.Settings.Clusters.Software.Reports.StorageDeviceCompatibility

Esx.Settings.Clusters.Software.Reports.StorageDeviceCompatibility
Esx.Settings.Clusters.Software.Reports.StorageDeviceCompatibility

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

This schema was added in vSphere API 7.0.2.1.

JSON Example
{
    "status": "string",
    "compatible_versions": [
        "string"
    ],
    "supported_firmware_versions": [
        "string"
    ],
    "constraints": [
        {
            "firmware_version": "string",
            "firmware_version_match": "string",
            "driver_name": "string",
            "driver_version": "string",
            "supported_features": {
                "supported_features": [
                    "string"
                ]
            }
        }
    ],
    "vcg_product": "string",
    "model": "string",
    "partner": "string",
    "compatibility_guide_link": "string",
    "used_for_compliance": false,
    "user_selected": false,
    "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

Compliance status of the storage device, when computed based on this Broadcom Compatibility Guide (BCG) listing.

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.2.1.

array of string
compatible_versions
Optional

List of vSphere Versions compatible for this storage device.

This property was added in vSphere API 7.0.2.1.

This property will be missing or null if the storage device is certified for the target ESXi version.

array of string
supported_firmware_versions
Optional

This property is deprecated as of vSphere API 8.0.0.1.

List of minimum firmware versions supported from Broadcom Compatibility Guide (BCG) listing for the given vSphere version.

This property was added in vSphere API 7.0.2.1.

This property will be missing or null if the storage device is not certified for the target ESXi version or the storage device is only certified in combination with specific driver versions, in which case listedDriverFirmwareVersions below will be set.

array of Esx.Settings.Clusters.Software.Reports.StorageDeviceConstraint
constraints
Optional

List of Supported Firmware Versions and corresponding supported features 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
vcg_product
Required

Identifier of the Broadcom Compatibility Guide (BCG) listing for the product.

This property was added in vSphere API 7.0.2.1.

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

string
model
Required

Model name of the storage device as listed in the Broadcom Compatibility Guide (BCG) listing. This may not be the same as the Esx.Settings.Clusters.Software.Reports.StorageDeviceInfo.model

This property was added in vSphere API 7.0.2.1.

string
partner
Required

OEM partner name of the storage device as listed in the Broadcom Compatibility Guide (BCG) listing.

This property was added in vSphere API 7.0.2.1.

string As uri As uri
compatibility_guide_link
Required

Provides link to the Broadcom Compatibility Guide (BCG) listing for further information on the compatibility.

This property was added in vSphere API 7.0.2.1.

boolean
used_for_compliance
Required

Flag to indicate whether this Broadcom Compatibility Guide (BCG) listing was used to compute the overall compatibility of the storage device.

This property was added in vSphere API 7.0.2.1.

boolean
user_selected
Required

Flag to indicate if the user has selected this Broadcom Compatibility Guide (BCG) listing to be considered to compute the overall compatibility of the storage device.

This property was added in vSphere API 7.0.2.1.

notifications
Optional

Broadcom Compatibility Guide (BCG) listing specific notifications describing the compliance result.

This property was added in vSphere API 7.0.2.1.

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

Property Of