Esx.Settings.Clusters.Software.Reports.CheckResult

Esx.Settings.Clusters.Software.Reports.CheckResult
Esx.Settings.Clusters.Software.Reports.CheckResult

The Esx.Settings.Clusters.Software.Reports.CheckResult schema contains information to describe HCL compliance result of a cluster on target software specification.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "status": "string",
    "scan_time": "string",
    "updated_since_last_check": false,
    "v_san_data_only": false,
    "commit": "string",
    "base_image_version": "string",
    "has_alternative_images": false,
    "server_compliance": {
        "compliant_servers": [
            {
                "server": {
                    "model_name": "string",
                    "vendor": "string",
                    "cpu_series": "string",
                    "cpu_model": "string",
                    "cpu_features": "string",
                    "bios": {
                        "version": "string",
                        "vendor": "string"
                    }
                },
                "matches": [
                    {
                        "bios_constraints": [
                            {
                                "bios": {
                                    "version": "string",
                                    "vendor": "string"
                                },
                                "notes": [
                                    "Vapi.Std.LocalizableMessage Object"
                                ]
                            }
                        ],
                        "cpu_series": "string",
                        "status": "string",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_releases": [
                            "string"
                        ],
                        "vcg": "string",
                        "vcg_link": "string",
                        "partner": "string",
                        "model": "string",
                        "used_for_compliance": false,
                        "user_selected": false,
                        "notes": [
                            "Vapi.Std.LocalizableMessage Object"
                        ]
                    }
                ],
                "model_compatibility": "string",
                "status_detail": "string",
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "noncompliant_servers": [
            {
                "server": {
                    "model_name": "string",
                    "vendor": "string",
                    "cpu_series": "string",
                    "cpu_model": "string",
                    "cpu_features": "string",
                    "bios": {
                        "version": "string",
                        "vendor": "string"
                    }
                },
                "matches": [
                    {
                        "bios_constraints": [
                            {
                                "bios": {
                                    "version": "string",
                                    "vendor": "string"
                                },
                                "notes": [
                                    "Vapi.Std.LocalizableMessage Object"
                                ]
                            }
                        ],
                        "cpu_series": "string",
                        "status": "string",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_releases": [
                            "string"
                        ],
                        "vcg": "string",
                        "vcg_link": "string",
                        "partner": "string",
                        "model": "string",
                        "used_for_compliance": false,
                        "user_selected": false,
                        "notes": [
                            "Vapi.Std.LocalizableMessage Object"
                        ]
                    }
                ],
                "model_compatibility": "string",
                "status_detail": "string",
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "unknown_servers": [
            {
                "server": {
                    "model_name": "string",
                    "vendor": "string",
                    "cpu_series": "string",
                    "cpu_model": "string",
                    "cpu_features": "string",
                    "bios": {
                        "version": "string",
                        "vendor": "string"
                    }
                },
                "matches": [
                    {
                        "bios_constraints": [
                            {
                                "bios": {
                                    "version": "string",
                                    "vendor": "string"
                                },
                                "notes": [
                                    "Vapi.Std.LocalizableMessage Object"
                                ]
                            }
                        ],
                        "cpu_series": "string",
                        "status": "string",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_releases": [
                            "string"
                        ],
                        "vcg": "string",
                        "vcg_link": "string",
                        "partner": "string",
                        "model": "string",
                        "used_for_compliance": false,
                        "user_selected": false,
                        "notes": [
                            "Vapi.Std.LocalizableMessage Object"
                        ]
                    }
                ],
                "model_compatibility": "string",
                "status_detail": "string",
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "pci_device_compliance": {
        "status": "string",
        "compatible_devices": [
            {
                "status": "string",
                "detail": "string",
                "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"
                },
                "default_image_host_details": {
                    "image": {
                        "display_name": "string"
                    },
                    "hosts": [
                        "string"
                    ]
                },
                "alternative_image_driver_fw_details": {
                    "alternative_image_driver_fw_details": {
                        "image_host_details": {
                            "image": {
                                "display_name": "string"
                            },
                            "hosts": [
                                "string"
                            ]
                        },
                        "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": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "incompatible_devices": [
            {
                "status": "string",
                "detail": "string",
                "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"
                },
                "default_image_host_details": {
                    "image": {
                        "display_name": "string"
                    },
                    "hosts": [
                        "string"
                    ]
                },
                "alternative_image_driver_fw_details": {
                    "alternative_image_driver_fw_details": {
                        "image_host_details": {
                            "image": {
                                "display_name": "string"
                            },
                            "hosts": [
                                "string"
                            ]
                        },
                        "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": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "incompatible_driver_firmware": [
            {
                "status": "string",
                "detail": "string",
                "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"
                },
                "default_image_host_details": {
                    "image": {
                        "display_name": "string"
                    },
                    "hosts": [
                        "string"
                    ]
                },
                "alternative_image_driver_fw_details": {
                    "alternative_image_driver_fw_details": {
                        "image_host_details": {
                            "image": {
                                "display_name": "string"
                            },
                            "hosts": [
                                "string"
                            ]
                        },
                        "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": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ]
    },
    "storage_device_compliance": {
        "status": "string",
        "compatible_devices": [
            {
                "storage_device_info": {
                    "model": "string",
                    "vendor": "string",
                    "part_number": "string",
                    "capacity": 0
                },
                "device_count": 0,
                "status": "string",
                "detail": "string",
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "default_image_host_details": {
                    "image": {
                        "display_name": "string"
                    },
                    "hosts": [
                        "string"
                    ]
                },
                "alternative_image_host_details": {
                    "alternative_image_host_details": {
                        "image": {
                            "display_name": "string"
                        },
                        "hosts": [
                            "string"
                        ]
                    }
                },
                "firmware_version": "string",
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "driver_name": "string",
                "driver_version": "string",
                "matches": [
                    {
                        "status": "string",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_firmware_versions": [
                            "string"
                        ],
                        "constraints": [
                            {
                                "firmware_version": "string",
                                "firmware_version_match": "string",
                                "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": {
                            "info": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ],
                            "warnings": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ],
                            "errors": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ]
                        }
                    }
                ],
                "used_by_vsan": false,
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "incompatible_devices": [
            {
                "storage_device_info": {
                    "model": "string",
                    "vendor": "string",
                    "part_number": "string",
                    "capacity": 0
                },
                "device_count": 0,
                "status": "string",
                "detail": "string",
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "default_image_host_details": {
                    "image": {
                        "display_name": "string"
                    },
                    "hosts": [
                        "string"
                    ]
                },
                "alternative_image_host_details": {
                    "alternative_image_host_details": {
                        "image": {
                            "display_name": "string"
                        },
                        "hosts": [
                            "string"
                        ]
                    }
                },
                "firmware_version": "string",
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "driver_name": "string",
                "driver_version": "string",
                "matches": [
                    {
                        "status": "string",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_firmware_versions": [
                            "string"
                        ],
                        "constraints": [
                            {
                                "firmware_version": "string",
                                "firmware_version_match": "string",
                                "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": {
                            "info": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ],
                            "warnings": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ],
                            "errors": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ]
                        }
                    }
                ],
                "used_by_vsan": false,
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "unknown_devices": [
            {
                "storage_device_info": {
                    "model": "string",
                    "vendor": "string",
                    "part_number": "string",
                    "capacity": 0
                },
                "device_count": 0,
                "status": "string",
                "detail": "string",
                "host_info": {
                    "host_info": {
                        "name": "string",
                        "is_vsan_witness": false
                    }
                },
                "default_image_host_details": {
                    "image": {
                        "display_name": "string"
                    },
                    "hosts": [
                        "string"
                    ]
                },
                "alternative_image_host_details": {
                    "alternative_image_host_details": {
                        "image": {
                            "display_name": "string"
                        },
                        "hosts": [
                            "string"
                        ]
                    }
                },
                "firmware_version": "string",
                "validated_features_in_use": {
                    "validated_features_in_use": [
                        "string"
                    ]
                },
                "driver_name": "string",
                "driver_version": "string",
                "matches": [
                    {
                        "status": "string",
                        "compatible_versions": [
                            "string"
                        ],
                        "supported_firmware_versions": [
                            "string"
                        ],
                        "constraints": [
                            {
                                "firmware_version": "string",
                                "firmware_version_match": "string",
                                "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": {
                            "info": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ],
                            "warnings": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ],
                            "errors": [
                                {
                                    "type": "string",
                                    "id": "string",
                                    "time": "string",
                                    "message": "Vapi.Std.LocalizableMessage Object",
                                    "resolution": "Vapi.Std.LocalizableMessage Object",
                                    "originator": "string",
                                    "retriable": false
                                }
                            ]
                        }
                    }
                ],
                "used_by_vsan": false,
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": "Vapi.Std.LocalizableMessage Object",
                            "resolution": "Vapi.Std.LocalizableMessage Object",
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            }
        ],
        "notifications": {
            "info": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "warnings": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ],
            "errors": [
                {
                    "type": "string",
                    "id": "string",
                    "time": "string",
                    "message": "Vapi.Std.LocalizableMessage Object",
                    "resolution": "Vapi.Std.LocalizableMessage Object",
                    "originator": "string",
                    "retriable": false
                }
            ]
        }
    },
    "notifications": {
        "info": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "warnings": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ],
        "errors": [
            {
                "type": "string",
                "id": "string",
                "time": "string",
                "message": "Vapi.Std.LocalizableMessage Object",
                "resolution": "Vapi.Std.LocalizableMessage Object",
                "originator": "string",
                "retriable": false
            }
        ]
    },
    "note": "Vapi.Std.LocalizableMessage Object"
}
string
status
Required

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

Possible values:

  • COMPATIBLE: Target hardware is compliant with Broadcom Compatibility Guide (BCG)
  • INCOMPATIBLE: Target hardware is not (recognizably) compliant with Broadcom Compatibility Guide (BCG)
  • HCL_DATA_UNAVAILABLE: Never returned by the HCL compliance APIs

HCL data can not be fetched to validate cluster hardware.

  • UNAVAILABLE: Target hardware compliance with Broadcom Compatibility Guide (BCG) cannot be determined.
  • NO_FIRMWARE_PROVIDER: Never returned by the HCL compliance APIs

No Firmware HSM present in Software Spec to get Firmware Details Esx.Settings.HardwareSupportPackageInfo schema

For more information see: Esx.Settings.Clusters.Software.Reports.ComplianceStatus.

This property was added in vSphere API 7.0.0.0.

string As date-time As date-time
scan_time
Required

HCL Validation check time.

This property was added in vSphere API 7.0.0.0.

boolean
updated_since_last_check
Optional

Flag to indicate if there were any hardware compatibility overrides were performed after the last check operation.

This property was added in vSphere API 7.0.2.1.

This property 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.

This property was added in vSphere API 7.0.0.0.

missing or null 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 property was added in vSphere API 7.0.0.0.

This property will be missing or null if validation was performed against a draft.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

string
base_image_version
Required

Target default base image version E.g., version = BaseImageSpec->Version Esx.Settings.BaseImageSpec.version schema

This property was added in vSphere API 7.0.0.0.

boolean
has_alternative_images
Optional

Boolean flag to indicate that desired state contains alternative images or not. If set to true, it signifies the desired state contains alternative images. If unset or set to false, it signifies the desired state contains single image.

This property was added in vSphere API 9.0.0.0.

This property is optional because it was added in a newer version than its parent node.

server_compliance
Optional

Compliance results for servers that make up the hosts of the cluster.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property will be missing or null if server compliance was not computed.

pci_device_compliance
Optional

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

This property was added in vSphere API 7.0.0.0.

This property will be missing or null if Pci device compliance was not computed.

storage_device_compliance
Optional

Compliance result for storage devices in all the hosts of the cluster. Currently only includes SAS/SATA storage devices.

This property was added in vSphere API 7.0.2.1.

This property will be missing or null if storage device compliance was not computed.

notifications
Required

Notifications returned by the HCL Validation operation.

This property was added in vSphere API 7.0.0.0.

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.

This property was added in vSphere API 7.0.0.0.