Settings_Clusters_Software_Reports_HardwareCompatibility_CheckSummary

Settings_Clusters_Software_Reports_HardwareCompatibility_CheckSummary
Settings_Clusters_Software_Reports_HardwareCompatibility_CheckSummary

The HardwareCompatibility.CheckSummary structure contains information to describe the HCL compliance summary result of a cluster on target software specification.

JSON Example 
{
    "status": "string",
    "scan_time": "string",
    "commit": "string",
    "base_image_version": "string",
    "summary_result": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": {
                    "id": "string",
                    "params": {
                        "params": "Std_LocalizationParam Object"
                    }
                },
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Std_LocalizableMessage Object",
                "resolution": "Std_LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Std_LocalizableMessage Object",
                "resolution": "Std_LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Std_LocalizableMessage Object",
                "resolution": "Std_LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ]
    }
}
Settings_Clusters_Software_Reports_HardwareCompatibility_ComplianceStatus
status
Required

The HardwareCompatibility.ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
COMPATIBLE : Target hardware is compliant with VCG/HCL. This includes (from the ComplianceStatusDetail:

  • COMPLIANT

  • VENDOR_UPDATE

  • USER_OVERRIDE
    INCOMPATIBLE : Target hardware is not (recognizably) compliant with VCG/HCL This includes (from the ComplianceStatusDetail):

  • NONCOMPLIANT

  • USER_FLAGGED

  • NONCOMPLIANCE_MUTED
    HCL_DATA_UNAVAILABLE : HCL data can not be fetched to validate cluster hardware.
    UNAVAILABLE : Target hardware compliance with VCG/HCL cannot be determined This includes (from the ComplianceStatusDetail):

  • HCL_DATA_UNAVAILABLE

  • UNAVAILABLE

  • NO_FIRMWARE_PROVIDER

  • UNKNOWN
    NO_FIRMWARE_PROVIDER : No Firmware HSM present in Software Spec to get Firmware Details HardwareSupportPackageInfo structure

string As date-time
scan_time
Required

HCL Validation check time.

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 field will be unset if validation was performed against a draft. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field 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 BaseImageSpec.version structure

Std_LocalizableMessage
summary_result
Required

The LocalizableMessage structure represents localizable string and message template. Services include one or more localizable message templates in the errors they report so that clients can display diagnostic messages in the native language of the user. Services can include localizable strings in the data returned from operations to allow clients to display localized status information in the native language of the user.

Settings_Notifications
notifications
Required

The Notifications structure contains info/warning/error messages that can be reported by the task.

Returned By