Esx.Settings.Clusters.Software.Reports.StorageDeviceComplianceInfo

The Esx.Settings.Clusters.Software.Reports.StorageDeviceComplianceInfo schema contains properties that describe the compliance information of a storage device.

This schema was added in vSphere API 7.0.2.1.

JSON Example

{
    "storage_device_info": {
        "model": "string",
        "vendor": "string",
        "part_number": "string",
        "capacity": 0
    },
    "device_count": 0,
    "status": "string",
    "detail": "string",
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "default_image_host_details": {
        "image": {
            "display_name": "string"
        },
        "hosts": [
            "string"
        ]
    },
    "alternative_image_host_details": {
        "alternative_image_host_details": {
            "image": {
                "display_name": "string"
            },
            "hosts": [
                "string"
            ]
        }
    },
    "firmware_version": "string",
    "validated_features_in_use": {
        "validated_features_in_use": [
            "string"
        ]
    },
    "driver_name": "string",
    "driver_version": "string",
    "matches": [
        {
            "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
                    }
                ]
            }
        }
    ],
    "used_by_vsan": 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
            }
        ]
    }
}

storage_device_info

Required

Information of the storage device.

This property was added in vSphere API 7.0.2.1.

integer As int64 As int64

device_count

Optional

Indicate the number of actual physical storage devices represented by this info.

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

status

Required

Compliance status of the storage device. When there are multiple possible Broadcom Compatibility Guide (BCG) matches for the storage device, the compliance status would be set to Esx.Settings.Clusters.Software.Reports.ComplianceStatus.UNAVAILABLE Each match found would be listed under Esx.Settings.Clusters.Software.Reports.StorageDeviceComplianceInfo.matches with the corresponding compliance status of the storage device if compared against the constraints specified in the match.

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.

string

detail

Required

Detailed compliance status of the storage 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.

This property was added in vSphere API 7.0.2.1.

object

host_info

Required

Affected List of Host IDs where this device is found.

This property was added in vSphere API 7.0.2.1.

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.

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_host_details

Optional

Specifies the alternative Image ID and its corresponding details along with hosts for a given storage device.

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.

string

firmware_version

Optional

Firmware version on the storage device.

This property was added in vSphere API 7.0.2.1.

This property will be missing or null if the firmware version on the storage device is unknown or cannot be determined.

object

validated_features_in_use

Optional

Validated Features in use on the storage 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.

string

driver_name

Optional

Driver name on the storage device

This property was added in vSphere API 8.0.0.1.

This property will be missing or null if there is no driver associated with the device.

string

driver_version

Optional

Driver Version on the storage device

This property was added in vSphere API 8.0.0.1.

This property will be missing or null if there is no driver associated with the device.

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

matches

Required

Provides information about possible compatibility matches for the given storage device.

There could be multiple possible matches available in the compatibility data.

This property was added in vSphere API 7.0.2.1.

boolean

used_by_vsan

Required

This property is deprecated as of vSphere API 8.0.0.1.

Indicates if the storage device is in use by vSAN. When this flag is set to true, the hardware compatibility is computed against vSAN HCL constraints.

This property was added in vSphere API 7.0.2.1.

notifications

Optional

Device 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

Esx.Settings.Clusters.Software.Reports.StorageDeviceCompliance