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

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. unset if validation is performed with no spec 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.

StdLocalizableMessage

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.

SettingsNotifications

notifications Required

Notifications returned by the HCL Validation operation.

SettingsClustersSoftwareReportsPciDeviceCompliance

pci_device_compliance Optional

Compliance result for the Pci Devices that are present in all hosts of the cluster.

string

scan_time Required

HCL Validation check time.

SettingsClustersSoftwareReportsComplianceStatus Enum

status Required

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

boolean

v_san_data_only Optional

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

Returned By

Get Clusters Software Reports Hardware Compatibility Details

JSON Example

Show optional properties

{
    "base_image_version": "string",
    "notifications": {},
    "scan_time": "string",
    "status": "enum"
}

{
    "base_image_version": "string",
    "commit": "string",
    "notifications": {
        "errors": [
            {
                "id": "string",
                "time": "string"
            }
        ],
        "info": [
            {
                "id": "string",
                "time": "string"
            }
        ],
        "warnings": [
            {
                "id": "string",
                "time": "string"
            }
        ]
    },
    "pci_device_compliance": {
        "compatible_devices": [
            {
                "compatibility_guide_link": "string",
                "compatible_versions": [
                    "string"
                ],
                "device": {
                    "did": "string",
                    "display_name": "string",
                    "driver_name": "string",
                    "ssid": "string",
                    "svid": "string",
                    "vendor": "string",
                    "vid": "string"
                },
                "host_info": {
                    "key": {
                        "name": "string"
                    }
                },
                "notifications": {
                    "errors": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ],
                    "info": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ],
                    "warnings": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ]
                },
                "status": "enum",
                "supported": [
                    {
                        "driver_name": "string",
                        "driver_version": "string",
                        "firmware_version": "string"
                    }
                ],
                "target": {
                    "driver_name": "string",
                    "driver_version": "string",
                    "firmware_version": "string"
                }
            }
        ],
        "incompatible_devices": [
            {
                "compatibility_guide_link": "string",
                "compatible_versions": [
                    "string"
                ],
                "device": {
                    "did": "string",
                    "display_name": "string",
                    "driver_name": "string",
                    "ssid": "string",
                    "svid": "string",
                    "vendor": "string",
                    "vid": "string"
                },
                "host_info": {
                    "key": {
                        "name": "string"
                    }
                },
                "notifications": {
                    "errors": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ],
                    "info": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ],
                    "warnings": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ]
                },
                "status": "enum",
                "supported": [
                    {
                        "driver_name": "string",
                        "driver_version": "string",
                        "firmware_version": "string"
                    }
                ],
                "target": {
                    "driver_name": "string",
                    "driver_version": "string",
                    "firmware_version": "string"
                }
            }
        ],
        "incompatible_driver_firmware": [
            {
                "compatibility_guide_link": "string",
                "compatible_versions": [
                    "string"
                ],
                "device": {
                    "did": "string",
                    "display_name": "string",
                    "driver_name": "string",
                    "ssid": "string",
                    "svid": "string",
                    "vendor": "string",
                    "vid": "string"
                },
                "host_info": {
                    "key": {
                        "name": "string"
                    }
                },
                "notifications": {
                    "errors": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ],
                    "info": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ],
                    "warnings": [
                        {
                            "id": "string",
                            "time": "string"
                        }
                    ]
                },
                "status": "enum",
                "supported": [
                    {
                        "driver_name": "string",
                        "driver_version": "string",
                        "firmware_version": "string"
                    }
                ],
                "target": {
                    "driver_name": "string",
                    "driver_version": "string",
                    "firmware_version": "string"
                }
            }
        ],
        "status": "enum"
    },
    "scan_time": "string",
    "status": "enum",
    "v_san_data_only": false
}

SettingsClustersSoftwareReportsCheckResult

Properties

Returned By

JSON Example

Was this page helpful?