SettingsClustersSoftwareReportsHardwareCompatibilityCheckSummary

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


Properties

string
base_image_version Required

Target base image version E.g., version = BaseImageSpec->Version BaseImageSpec.version structure


notifications Required

Notifications returned by the HCL Validation operation.


string as date-time
scan_time Required

HCL Validation check time.


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

Possible values are: COMPATIBLEINCOMPATIBLEHCL_DATA_UNAVAILABLEUNAVAILABLENO_FIRMWARE_PROVIDER


summary_result Required

Over all Compliance result for cluster for the software specification.


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.

JSON Example

{
	"base_image_version": "string",
	"notifications": {},
	"scan_time": "string",
	"status": "COMPATIBLE",
	"summary_result": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	}
}

Feedback

Was this page helpful?