Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.CheckSummary

Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.CheckSummary
Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.CheckSummary

The Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.CheckSummary schema contains information to describe the HCL compliance summary result of a cluster on target software specification.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "status": "string",
    "scan_time": "string",
    "commit": "string",
    "base_image_version": "string",
    "summary_result": "Vapi.Std.LocalizableMessage Object",
    "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 the cluster with respective to all hosts in the cluster.

Possible values:

  • COMPATIBLE: Target hardware is compliant with BCG/HCL. This includes (from the Esx.Settings.Clusters.Software.Reports.ComplianceStatusDetail:

    • COMPLIANT
    • VENDOR_UPDATE
    • USER_OVERRIDE

  • INCOMPATIBLE: Target hardware is not (recognizably) compliant with BCG/HCL This includes (from the Esx.Settings.Clusters.Software.Reports.ComplianceStatusDetail):

    • NONCOMPLIANT
    • USER_FLAGGED
    • NONCOMPLIANCE_MUTED

  • 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 BCG/HCL cannot be determined This includes (from the Esx.Settings.Clusters.Software.Reports.ComplianceStatusDetail):

    • HCL_DATA_UNAVAILABLE
    • UNAVAILABLE
    • NO_FIRMWARE_PROVIDER
    • UNKNOWN

  • 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.HardwareCompatibility.ComplianceStatus.

This property was added in vSphere API 7.0.0.0.

string As date-time As date-time
scan_time
Required

HCL Validation check time.

This property was added in vSphere API 7.0.0.0.

string
commit
Optional

Spec Identifier of the desired configuration on which the HCL scan is performed to generate this result, populated by the HCL validation.

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if validation was performed against a draft.

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

string
base_image_version
Required

Target base image version E.g., version = BaseImageSpec->Version Esx.Settings.BaseImageSpec.version schema

This property was added in vSphere API 7.0.0.0.

summary_result
Required

Over all Compliance result for cluster for the software specification.

This property was added in vSphere API 7.0.0.0.

notifications
Required

Notifications returned by the HCL Validation operation.

This property was added in vSphere API 7.0.0.0.