Esx.Settings.HardwareModuleFirmwareCompliance

Esx.Settings.HardwareModuleFirmwareCompliance
Esx.Settings.HardwareModuleFirmwareCompliance

The Esx.Settings.HardwareModuleFirmwareCompliance schema contains information that describe the compliance of firmware of a particular hardware module (e.g. BIOS, PCI device) on the host with respect to the firmware present in the target Hardware Support Package (HSP) specification.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "status": "string",
    "stage_status": "string",
    "details": {
        "component_class": "string",
        "description": "string"
    },
    "current": {
        "version": "string"
    },
    "target": {
        "version": "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
            }
        ]
    }
}
string
status
Required

Compliance status of the hardware module's firmware.

Possible values:

  • COMPLIANT: Target version is same as current version.
  • NON_COMPLIANT: Target version is greater than current version.
  • INCOMPATIBLE: Target state cannot be applied due to conflict or missing dependencies or the target state is lesser than the current version.
  • UNAVAILABLE: Drift check failed due to unknown error or check hasn't happened yet and results are not available.

For more information see: Esx.Settings.ComplianceStatus.

This property was added in vSphere API 7.0.0.0.

string
stage_status
Optional

Stage status of the hardware module's firmware. This is only relevant when the value of Esx.Settings.HardwareModuleFirmwareCompliance.status is Esx.Settings.ComplianceStatus.NON_COMPLIANT.

Possible values:

  • STAGED: Required components/payloads are already staged.
  • NOT_STAGED: Required components/payloads are not staged.
  • UNKNOWN: Required components/payloads staged status is unknown.

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

For more information see: Esx.Settings.StageStatus.

This property was added in vSphere API 8.0.0.1.

If missing or null the staging status is unknown - the contents may or may not be staged. This can happen, for instance, if the stage check failed, has not been done yet, or the target uses an older interface that does not include support for returning the staged status.

details
Optional

Additional details about the hardware module itself

This property was added in vSphere API 7.0.0.0.

missing or null if no further info was provided by HSM.

current
Optional

Current version of the firmware present on the host hardware module.

This property was added in vSphere API 7.0.0.0.

missing or null if version of firmware on the hardware module on the host cannot be determined.

target
Optional

Target version of the firmware present in the Hardware Support Package (HSP).

This property was added in vSphere API 7.0.0.0.

missing or null if component is not present in the software specification.

notifications
Required

Notifications describing the compliance result.

This property was added in vSphere API 7.0.0.0.