SettingsClustersSoftwareReportsCheckResult

The CheckResult structure contains information to describe HCL compliance 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


status Required

Overall compliance status of Cluster with respective to all hosts in the cluster.

Possible values are: COMPATIBLEINCOMPATIBLEHCL_DATA_UNAVAILABLEUNAVAILABLENO_FIRMWARE_PROVIDER


note Required

Localizable disclaimer notice to show on the UI detailing the type of checks are done by the HCL Validaiton. Example : HCL Validation is only done on storage and network controllers.


notifications Required

Notifications returned by the HCL Validation operation.


string
scan_time Required

HCL Validation check time.


pci_device_compliance Optional

Compliance result for the Pci Devices that are present in all hosts of the cluster. This field will be unset if Pci device compliance was not computed.


Settings_Clusters_Software_Reports_ServerCompliance
server_compliance Optional

Compliance results for servers that make up the hosts of the cluster. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. This field will be unset if server compliance was not computed.


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.


Settings_Clusters_Software_Reports_StorageDeviceCompliance
storage_device_compliance Optional

Compliance result for storage devices in all the hosts of the cluster. Currently only includes SAS/SATA storage devices. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. This field will be unset if storage device compliance was not computed.


boolean
updated_since_last_check Optional

Flag to indicate if there were any hardware compatibility overrides were performed after the last check operation. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. This field is optional because it was added in a newer version than its parent node.


boolean
v_san_data_only Optional

HCL Validation Computed only for vSAN Clusters. unset to show vSAN in UI

JSON Example

{
    "base_image_version": "string",
    "note": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "notifications": {},
    "scan_time": "string",
    "status": "enum"
}
Feedback

Was this page helpful?