Esx.Settings.Clusters.Software.Reports.StorageDeviceCompliance

Esx.Settings.Clusters.Software.Reports.StorageDeviceCompliance
Esx.Settings.Clusters.Software.Reports.StorageDeviceCompliance

The Esx.Settings.Clusters.Software.Reports.StorageDeviceCompliance schema contains information that describe the compliance result of all storage devices from all hosts in the cluster with respect to the storage device model and the firmware certification

This schema was added in vSphere API 7.0.2.1.

JSON Example
{
    "status": "string",
    "compatible_devices": [
        {
            "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
                    }
                ]
            }
        }
    ],
    "incompatible_devices": [
        {
            "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
                    }
                ]
            }
        }
    ],
    "unknown_devices": [
        {
            "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
                    }
                ]
            }
        }
    ],
    "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

Overall compliance status of storage devices in the cluster with respect 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.2.1.

compatible_devices
Required

Lists compliance information for storage devices found to be compliant with Broadcom Compatibility Guide (BCG) during the last check operation.

Note that complianceStatus of every device is not necessarily COMPATIBLE due to changes made after this check was run; entries are only rearranged when a new check operation is invoked. lastOverrideTime being greater than the scanTime is an indication that there were changes made after the last check operation

This property was added in vSphere API 7.0.2.1.

incompatible_devices
Required

Lists compliance information for storage devices found to be non-compliant with Broadcom Compatibility Guide (BCG) during the last check operation.

Note that complianceStatus of every device is not necessarily INCOMPATIBLE due to changes made after this check was run; entries are only rearranged when a new check operation is invoked. lastOverrideTime being greater than the scanTime is an indication that there were changes made after the last check operation

This property was added in vSphere API 7.0.2.1.

unknown_devices
Required

Lists storage devices whose compliance information could not be computed successfully during the last check operation.

Note that complianceStatus of every device is not necessarily UNAVAILABLE due to changes made after this check was run; entries are only rearranged when a new check operation is invoked. lastOverrideTime being greater than the scanTime is an indication that there were changes made after the last check operation

This property was added in vSphere API 7.0.2.1.

notifications
Optional

Storage device compliance 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