Esx.Settings.Clusters.Software.Reports.ServerComplianceInfo

This Esx.Settings.Clusters.Software.Reports.ServerComplianceInfo schema contains properties that describe a set of server of server compliance characteristics.

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

JSON Example

{
    "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
            }
        ]
    }
}

server

Required

Information about the server.

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.

array of Esx.Settings.Clusters.Software.Reports.ServerCompatibility

matches

Required

Provides information about possible compatibility matches for the given server.

There could be multiple matches returned as there are several possible matches in the Compatibility data.

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.

string

model_compatibility

Required

Shows if the server model is compatible with given target ESXi release.

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.

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.

string

status_detail

Required

Detailed compliance status of the host server.

Possible values:

CERTIFIED: Hardware is specifically certified for target vSphere version according to the BCG/HCL
NOT_CERTIFIED: Hardware is specifically not certified for target vSphere version according to the BCG/HCL
HCL_DATA_UNAVAILABLE: HCL data can not be fetched to validate cluster hardware.
HOSTS_UNAVAILABLE: Hosts in cluster are not available to validate cluster hardware.
FIRMWARE_VERSION_UNKNOWN: No firmware version information is available (for example no Hardware Support Manager, HSM, configured in the cluster's Software Spec to get Firmware Details Esx.Settings.HardwareSupportPackageInfo schema or the system failed to retrieve the current firmware version of a device using the specified HSM.
UNKNOWN: When given hardware may be certified for a release but its status can't be definitively determined due to ambiguity in server model, CPU series, or BIOS version
VENDOR_UPDATE: When BIOS or firmware has been updated from a certified entry found in the Broadcom Compatibility Guide (BCG)
USER_VERIFIED: When a server or device's HCL compliance status has been overridden by the user to mark the system as compliant
USER_FLAGGED: When a server or device's HCL compliance status has been overridden by the user to mark the system as non-compliant
MUTED: When a user requests a non-compliance or HCL compliance unavailable warning to be suppressed

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

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.

object

host_info

Required

Affected List of Host IDs matching this configuration

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.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

notifications

Optional

Host type-specific notifications describing the compliance result.

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 there are no notifications

Property Of

Esx.Settings.Clusters.Software.Reports.ServerCompliance