Esx.Settings.Clusters.Software.Reports.ServerCompatibility

Esx.Settings.Clusters.Software.Reports.ServerCompatibility
Esx.Settings.Clusters.Software.Reports.ServerCompatibility

This Esx.Settings.Clusters.Software.Reports.ServerCompatibility schema contains properties that provide the compatibility information for a server model, cpu and BIOS.

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

Lists the BIOS constraints that the target ESXi release has for this 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.

If missing or null no constraints are present as server is either not compatible or compatibility information is not found.

string
cpu_series
Required

The CPU series name.

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
Required

Compliance status of the host, when computed based on this Broadcom Compatibility Guide (BCG) listing.

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.

array of string
compatible_versions
Optional

List of vSphere versions compatible for this host.

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 the drive is not compatible with the target ESXi version.

array of string
supported_releases
Optional

Provides information about supported releases for this entry.

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.

If missing or null server is compatible with the given target release.

string
vcg
Required

Identifier of the Broadcom Compatibility Guide (BCG) listing.

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 property must be an identifier for the resource type: com.vmware.esx.settings.vcg_product. 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.vcg_product.

string As uri As uri
vcg_link
Required

Provides link to the Broadcom Compatibility Guide for further information on the compatibility.

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
partner
Required

OEM partner name of the server as listed in the Broadcom Compatibility Guide (BCG) listing.

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
Required

Model name of the server as listed in the Broadcom Compatibility Guide (BCG) listing.

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.

boolean
used_for_compliance
Required

Flag to indicate whether this Broadcom compatibility Guide (BCG) listing was used to compute the overall compatibility of 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.

boolean
user_selected
Required

Flag to indicate if the user has selected this Broadcom Compatibility Guide (BCG) listing to be considered to compute the overall compatibility of 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.

notes
Optional

Information that needs to be taken into account when considering this server hardware compatibility.

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.

Only set if there is any information reported.