Skip to main content

GET – BIOS attribute registries

Use the GET method to retrieve properties in AttributeRegistry for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/schemas/registries/BiosAttributeRegistry.1.0.0.json

Request body

None

Response body

Field

Type

Description

Id

String

“BiosAttributeRegistry.1.0.0”

Language

String

“en”

Name

String

“Bios Attribute Registry Version 1”

OwningEntity

String

“Lenovo”

RegistryEntries

Object

List of all attributes and their metadata for this component.

 

Attributes

Array

The array containing the attributes and their possible values.

  

Attributes[N]

Object

An attribute and its possible values.

   

AttributeName

String

The unique name of the attribute.

   

CurrentValue

String

null

   

DefaultValue

String

The default current value of the attribute.

   

DisplayName

String

The user-readable display string for the attribute in the defined language.

   

DisplayOrder

Number

The numeric value describing the ascending order that the attribute is displayed relative to other attributes.

   

GrayOut

Boolean

The gray-out state of this attribute.

   

HelpText

String

The help text for the attribute.

   

Hidden

Boolean

The hidden state of this attribute.

   

LowerBound

Number

The lower limit of the value of an attribute of type 'Integer'.

   

MaxLength

Number

The maximum character length of the value of an attribute of type 'string'.

   

MenuPath

String

A path that describes the menu hierarchy of this attribute.

   

MinLength

Number

The minimum character length of the value of an attribute of type 'string'.

   

ReadOnly

Boolean

The read-only state of this attribute.

   

ResetRequired

Boolean

The value shall be true for all BIOS registry attributes.

   

ScalarIncrement

Number

The amount to increment or decrement the value of an attribute of type 'Integer' each time a user requests a value change.

   

Type

String

The type of the attribute.

   

UpperBound

Number

The upper limit of the value of an attribute of type 'Integer'.

   

Value

Array

The array containing possible values for attributes of type 'Enumeration'.

    

Value[N]

Object

Expanded

     

ValueDisplayName

String

A user-readable display string of the value of the attribute in the defined 'Language'.

     

ValueName

String

The value name of the attribute.

   

ValueExpression

String

A regular expression that is used to validate the value of the attribute. This is only applicable to attributes of type 'string' or 'Integer'.

   

WarningText

String

The warning text for changing the attribute.

   

WriteOnly

Boolean

Defines whether this attribute is write-only. Such attributes revert back to their initial value after settings are applied.

 

Dependencies

Array

The array containing a list of dependencies of attributes on this component.

  

Dependencies[N]

Object

A dependency of attributes on this component.

   

Dependency

Object

The dependency expression for one or more Attributes in this Attribute Registry.

    

MapFrom

Array

Array of the map-from conditions for mapping dependency.

     

MapFrom[N]

Object

A map-from condition for mapping dependency.

      

MapFromAttribute

String

The attribute that is used to evaluate this dependency expression.

      

MapFromCondition

String

The condition that is used to evaluate this dependency expression.

      

MapFromProperty

String

“CurrentValue”.

      

MapFromValue

String

The value to use to evaluate this dependency expression.

      

MapTerms

String

The logical term used to combine two or more MapFrom conditions in this dependency expression.

    

MapToAttribute

String

The Name of the attribute that is affected by this dependency expression.

    

MapToProperty

String

The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency expression.

    

MapToValue

Boolean

TRUE

   

DependencyFor

String

The AttributeName of the attribute whose change triggers the evaluation of this dependency expression.

   

Type

String

“Map”

 

Menus

Array

The array containing the attributes menus and their hierarchy.

  

Menus[N]

Object

A menu and its hierarchy.

   

DisplayName

String

The user-readable display string of this menu in the defined 'Language'.

   

DisplayOrder

Number

The numeric value describing the ascending order in which this menu is displayed relative to other menus.

   

GrayOut

Boolean

FALSE

   

MenuName

String

The unique name string of this menu.

   

MenuPath

String

A path that describes this menu hierarchy relative to other menus.

   

ReadOnly

Boolean

FALSE

RegistryVersion

String

“1.0.0”

SupportedSystems

Array

Array of systems supported by this attribute registry.

 

SupportedSystems[N]

Object

A system supported by this attribute registry.

  

ProductName

String

Use The product name of the system.

  

SystemId

String

The system ID of the system.

  

FirmwareVersion

String

Firmware version.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"@odata.type": "#AttributeRegistry.v1_3_0.AttributeRegistry",
"RegistryVersion": "1.0.0",
"Id": "BiosAttributeRegistry.1.0.0",
"SupportedSystems": [
{
"ProductName": "Lenovo ThinkSystem SR650",
"SystemId": "7X0025Z000",
"FirmwareVersion": "CDI340M"
}
],
"Language": "en",
"Name": "Bios Attribute Registry Version 1",
"@odata.id": "/redfish/v1/schemas/registries/BiosAttributeRegistry.1.0.0.json",
"OwningEntity": "Lenovo",
"@odata.context": "/redfish/v1/$metadata#AttributeRegistry.AttributeRegistry",
"RegistryEntries": {
"Dependencies": [
{
"Type": "Map",
"Dependency": {
"MapToValue": true,
"MapFrom": [
{
"MapFromAttribute": "LegacyBIOS_LegacyBIOS",
"MapFromProperty": "CurrentValue",
"MapFromValue": "Enable",
"MapFromCondition": "EQU"
}
],
"MapToProperty": "GrayOut",
"MapToAttribute": "BootModes_SystemBootMode"
},
"DependencyFor": "BootModes_SystemBootMode"
},
...
{
"Type": "Map",
"Dependency": {
"MapToValue": true,
"MapFrom": [
{
"MapFromAttribute": "SystemRecovery_POSTWatchdogTimer",
"MapFromProperty": "CurrentValue",
"MapFromValue": "Disable",
"MapFromCondition": "EQU"
}
],
"MapToProperty": "GrayOut",
"MapToAttribute": "SystemRecovery_POSTWatchdogTimerValue"
},
"DependencyFor": "SystemRecovery_POSTWatchdogTimerValue"
}
],
"Menus": [
{
"GrayOut": false,
"ReadOnly": false,
"MenuPath": "./",
"MenuName": "BiosMainMenu",
"DisplayOrder": 1,
"DisplayName": "BIOS Configuration"
},
...
{
"GrayOut": false,
"ReadOnly": false,
"MenuPath": "./UEFILanguage/UEFILanguage_UEFILanguagepage",
"MenuName": "UEFILanguage_UEFILanguagepage",
"DisplayOrder": 3,
"DisplayName": "UEFILanguage"
}
],
"Attributes": [
{
"GrayOut": false,
"Type": "Enumeration",
"HelpText": "Enable/Disable POST Watchdog Timer.",
"DefaultValue": "Disable",
"WarningText": "POST Watchdog Timer changes require a system reboot to take effect.",
"DisplayName": "POST Watchdog Timer",
"CurrentValue": null,
"ReadOnly": false,
"AttributeName": "SystemRecovery_POSTWatchdogTimer",
"Value": [
{
"ValueDisplayName": "Disable",
"ValueName": "Disable"
},
{
"ValueDisplayName": "Enable",
"ValueName": "Enable"
}
],
"MenuPath": "./SystemRecovery/SystemRecovery_SystemRecovery",
"Hidden": false,
"DisplayOrder": 1,
"ResetRequired": true,
"WriteOnly": false
},
...
{
"GrayOut": false,
"Type": "Enumeration",
"HelpText": "Display the current secure boot mode",
"DefaultValue": null,
"WarningText": "Secure Boot Mode changes require a system reboot to take effect.",
"DisplayName": "Secure Boot Mode",
"CurrentValue": null,
"ReadOnly": true,
"AttributeName": "SecureBootConfiguration_SecureBootMode",
"Value": [
{
"ValueDisplayName": "UserMode",
"ValueName": "UserMode"
},
{
"ValueDisplayName": "SetupMode",
"ValueName": "SetupMode"
},
{
"ValueDisplayName": "AuditMode",
"ValueName": "AuditMode"
},
{
"ValueDisplayName": "DeployedMode",
"ValueName": "DeployedMode"
}
],
"MenuPath": "./SecureBootConfiguration/SecureBootConfiguration_SecureBootConfiguration",
"Hidden": false,
"DisplayOrder": 118,
"ResetRequired": true,
"WriteOnly": false
}
]
}
}