Settings_Clusters_Software_Reports_CheckResult
Settings_Clusters_Software_Reports_CheckResult
The CheckResult structure contains information to describe HCL compliance result of a cluster on target software specification.
JSON Example
{
"status": "string",
"scan_time": "string",
"updated_since_last_check": false,
"v_san_data_only": false,
"commit": "string",
"base_image_version": "string",
"pci_device_compliance": {
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"compatible_devices": [
{
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"device": {
"display_name": "string",
"driver_name": "string",
"vendor": "string",
"vid": "string",
"did": "string",
"svid": "string",
"ssid": "string"
},
"compatible_versions": [
"string"
],
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
},
"target": {
"driver_version": "string",
"firmware_version": "string",
"driver_name": "string"
},
"validated_features_in_use": {
"validated_features_in_use": [
"string"
]
},
"supported": [
{
"driver_version": "string",
"firmware_version": "string",
"driver_name": "string"
}
],
"constraints": [
{
"firmware_version": "string",
"firmware_version_match": "string",
"driver_name": "string",
"driver_version": "string",
"supported_features": {
"supported_features": [
"string"
]
}
}
],
"compatibility_guide_link": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
]
}
}
],
"incompatible_devices": [
{
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"device": {
"display_name": "string",
"driver_name": "string",
"vendor": "string",
"vid": "string",
"did": "string",
"svid": "string",
"ssid": "string"
},
"compatible_versions": [
"string"
],
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
},
"target": {
"driver_version": "string",
"firmware_version": "string",
"driver_name": "string"
},
"validated_features_in_use": {
"validated_features_in_use": [
"string"
]
},
"supported": [
{
"driver_version": "string",
"firmware_version": "string",
"driver_name": "string"
}
],
"constraints": [
{
"firmware_version": "string",
"firmware_version_match": "string",
"driver_name": "string",
"driver_version": "string",
"supported_features": {
"supported_features": [
"string"
]
}
}
],
"compatibility_guide_link": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
]
}
}
],
"incompatible_driver_firmware": [
{
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"device": {
"display_name": "string",
"driver_name": "string",
"vendor": "string",
"vid": "string",
"did": "string",
"svid": "string",
"ssid": "string"
},
"compatible_versions": [
"string"
],
"host_info": {
"host_info": {
"name": "string",
"is_vsan_witness": false
}
},
"target": {
"driver_version": "string",
"firmware_version": "string",
"driver_name": "string"
},
"validated_features_in_use": {
"validated_features_in_use": [
"string"
]
},
"supported": [
{
"driver_version": "string",
"firmware_version": "string",
"driver_name": "string"
}
],
"constraints": [
{
"firmware_version": "string",
"firmware_version_match": "string",
"driver_name": "string",
"driver_version": "string",
"supported_features": {
"supported_features": [
"string"
]
}
}
],
"compatibility_guide_link": "string",
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
]
}
}
]
},
"storage_device_compliance": {
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"compatible_devices": [
{
"storage_device_info": {
"model": "string",
"vendor": "string",
"part_number": "string",
"capacity": 0
},
"device_count": 0,
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"detail": "string",
"host_info": {
"host_info": "Settings_HostInfo Object"
},
"firmware_version": "string",
"validated_features_in_use": {
"validated_features_in_use": [
"string"
]
},
"driver_name": "string",
"driver_version": "string",
"matches": [
{
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"compatible_versions": [
"string"
],
"supported_firmware_versions": [
"string"
],
"constraints": [
{
"firmware_version": "string",
"firmware_version_match": "Settings_Clusters_Software_Reports_FirmwareVersionMatchingCriteria Object",
"driver_name": "string",
"driver_version": "string",
"supported_features": {
"supported_features": [
"string"
]
}
}
],
"vcg_product": "string",
"model": "string",
"partner": "string",
"compatibility_guide_link": "string",
"used_for_compliance": false,
"user_selected": false,
"notifications": "Settings_Notifications Object"
}
],
"used_by_vsan": false,
"notifications": "Settings_Notifications Object"
}
],
"incompatible_devices": [
{
"storage_device_info": {
"model": "string",
"vendor": "string",
"part_number": "string",
"capacity": 0
},
"device_count": 0,
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"detail": "string",
"host_info": {
"host_info": "Settings_HostInfo Object"
},
"firmware_version": "string",
"validated_features_in_use": {
"validated_features_in_use": [
"string"
]
},
"driver_name": "string",
"driver_version": "string",
"matches": [
{
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"compatible_versions": [
"string"
],
"supported_firmware_versions": [
"string"
],
"constraints": [
{
"firmware_version": "string",
"firmware_version_match": "Settings_Clusters_Software_Reports_FirmwareVersionMatchingCriteria Object",
"driver_name": "string",
"driver_version": "string",
"supported_features": {
"supported_features": [
"string"
]
}
}
],
"vcg_product": "string",
"model": "string",
"partner": "string",
"compatibility_guide_link": "string",
"used_for_compliance": false,
"user_selected": false,
"notifications": "Settings_Notifications Object"
}
],
"used_by_vsan": false,
"notifications": "Settings_Notifications Object"
}
],
"unknown_devices": [
{
"storage_device_info": {
"model": "string",
"vendor": "string",
"part_number": "string",
"capacity": 0
},
"device_count": 0,
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"detail": "string",
"host_info": {
"host_info": "Settings_HostInfo Object"
},
"firmware_version": "string",
"validated_features_in_use": {
"validated_features_in_use": [
"string"
]
},
"driver_name": "string",
"driver_version": "string",
"matches": [
{
"status": "Settings_Clusters_Software_Reports_ComplianceStatus Object",
"compatible_versions": [
"string"
],
"supported_firmware_versions": [
"string"
],
"constraints": [
{
"firmware_version": "string",
"firmware_version_match": "Settings_Clusters_Software_Reports_FirmwareVersionMatchingCriteria Object",
"driver_name": "string",
"driver_version": "string",
"supported_features": {
"supported_features": [
"string"
]
}
}
],
"vcg_product": "string",
"model": "string",
"partner": "string",
"compatibility_guide_link": "string",
"used_for_compliance": false,
"user_selected": false,
"notifications": "Settings_Notifications Object"
}
],
"used_by_vsan": false,
"notifications": "Settings_Notifications Object"
}
],
"notifications": "Settings_Notifications Object"
},
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"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"
},
"resolution": {
"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"
},
"originator": "string",
"retriable": false
}
]
},
"note": {
"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"
}
}
status
Required
The ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
COMPATIBLE : Target hardware is compliant with VMware Compatibility Guide (VCG)
INCOMPATIBLE : Target hardware is not (recognizably) compliant with VMware Compatibility Guide (VCG)
HCL_DATA_UNAVAILABLE : HCL data can not be fetched to validate cluster hardware.
UNAVAILABLE : Target hardware compliance with VMware Compatibility Guide (VCG) cannot be determined.
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.
boolean
updated_since_last_check
Optional
Flag to indicate if there were any hardware compatibility overrides were performed after the last check operation. 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
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
pci_device_compliance
Optional
The PciDeviceCompliance structure contains information that describe the compliance result of all pci device from all hosts in the clsuter with respect to the component present in the target software specification.
storage_device_compliance
Optional
The StorageDeviceCompliance structure contains information that describe the compliance result of all storage devices from all hosts in the cluster with respect to the storage device model and the firmware certification
notifications
Required
The Notifications structure contains info/warning/error messages that can be reported by the task.
note
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.