Settings_HardwareModuleFirmwareCompliance

Settings_HardwareModuleFirmwareCompliance
Settings_HardwareModuleFirmwareCompliance

The HardwareModuleFirmwareCompliance structure 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.

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

The ComplianceStatus enumerated type contains the possible different status of compliance with respect to target version.
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.

stage_status
Optional

The StageStatus enumerated type contains the possible different staged statuses with respect to target version. This is only relevant when the value of ComplianceStatus is NON_COMPLIANT.
STAGED : Required components/payloads are already staged.
NOT_STAGED : Required components/payloads are not staged.

details
Optional

The HardwareModuleDetails structure contains information that provide more details about the a hardware module (e.g. BIOS, PCI device).

current
Optional

The HardwareModuleFirmwareInfo structure contains information to describe the firmware on a hardware component or module (e.g. BIOS, PCI device).

target
Optional

The HardwareModuleFirmwareInfo structure contains information to describe the firmware on a hardware component or module (e.g. BIOS, PCI device).

notifications
Required

The Notifications structure contains info/warning/error messages that can be reported by the task.