SettingsHardwareModuleFirmwareCompliance

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.

Properties

SettingsHardwareModuleFirmwareInfo

current Optional

Current version of the firmware present on the host hardware module. unset if version of firmware on the hardware module on the host cannot be determined.

SettingsHardwareModuleDetails

details Optional

Additional details about the hardware module itself unset if no further info was provided by HSM.

SettingsNotifications

notifications Required

Notifications describing the compliance result.

SettingsStageStatus Enum

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.

Possible values are: STAGED , NOT_STAGED

SettingsComplianceStatus Enum

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.

Possible values are: COMPLIANT , NON_COMPLIANT , INCOMPATIBLE , UNAVAILABLE

SettingsHardwareModuleFirmwareInfo

target Optional

Target version of the firmware present in the Hardware Support Package (HSP). unset if component is not present in the software specification.

JSON Example

Show optional properties

{
	"notifications": {},
	"status": "COMPLIANT"
}

{
	"current": {
		"version": "string"
	},
	"details": {
		"component_class": "SYSTEM_BIOS",
		"description": "string"
	},
	"notifications": {
		"errors": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		],
		"info": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		],
		"warnings": [
			{
				"id": "string",
				"message": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"originator": "string",
				"resolution": {
					"args": [
						"string"
					],
					"default_message": "string",
					"id": "string",
					"localized": "string",
					"params": {
						"key": {
							"d": 0,
							"dt": "string",
							"format": "SHORT_DATE",
							"i": 0,
							"l": {
								"id": "string",
								"params": "StdLocalizationParam Object"
							},
							"precision": 0,
							"s": "string"
						}
					}
				},
				"retriable": false,
				"time": "string",
				"type": "INFO"
			}
		]
	},
	"stage_status": "STAGED",
	"status": "COMPLIANT",
	"target": {
		"version": "string"
	}
}

SettingsHardwareModuleFirmwareCompliance

Properties

JSON Example

Was this page helpful?