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 Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"@odata.context": "/redfish/v1/$metadata#AttributeRegistry.AttributeRegistry",
"@odata.type": "#AttributeRegistry.v1_3_6.AttributeRegistry",
"Id": "BiosAttributeRegistry.1.0.0",
"Language": "en",
"Name": "Bios Attribute Registry Version 1",
"OwningEntity": "Lenovo",
"RegistryEntries": {
"Attributes": [
{
"AttributeName": "CXLMemoryModule_MemoryMode",
"CurrentValue": null,
"DefaultValue": "MemoryMode_1LM_Vol",
"DisplayName": "Memory Mode",
"GrayOut": false,
"HelpText": "[1LM + Vol]:DRAM and CMM are visible to software as two separate NUMA nodes. \r\n[Heterogeneous Interleave]:DRAM and CMM are visible to software as one NUMA node, and they are interleaved.\r\n[Flat Memory Mode]: DRAM and CMM are visible to software as one NUMA node. Frequently used data is in DRAM, less frequently used data is in CMM. Hardware swaps the less frequently used data to CMM automatically.",
"Hidden": false,
"IsSystemUniqueProperty": false,
"MenuPath": "./CXLMemoryModule/CXLMemoryModule_CXLMemoryModule",
"ReadOnly": false,
"ResetRequired": true,
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "1LM + Vol",
"ValueName": "MemoryMode_1LM_Vol"
},
{
"ValueDisplayName": "Heterogeneous Interleave",
"ValueName": "HeterogeneousInterleave"
},
{
"ValueDisplayName": "Flat Memory Mode",
"ValueName": "FlatMemoryMode"
}
],
"WriteOnly": false
},
...
{
"AttributeName": "DevicesandIOPorts_Bifurcation_Slot7",
"CurrentValue": null,
"DefaultValue": "x16",
"DisplayName": "Slot 7",
"GrayOut": false,
"HelpText": "Setting [x16] uses the system setting to bifurcate the slot. [x8x8] to bifurcate the physical x16 slot to support two x8 devices at maximum. [x8x4x4]/[x4x4x8] to support one x8 and two x4 devices at maximum. [x4x4x4x4] to support four x4 devices at maximum",
"Hidden": false,
"IsSystemUniqueProperty": false,
"MenuPath": "./SystemUEFI/DevicesandIOPorts_Bifurcation/ DevicesandIOPorts_Bifurcation_OverrideSlotBifurcation",
"ReadOnly": false,
"ResetRequired": true,
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "x16",
"ValueName": "x16"
},
{
"ValueDisplayName": "x8x8",
"ValueName": "x8x8"
},
{
"ValueDisplayName": "x8x4x4",
"ValueName": "x8x4x4"
},
{
"ValueDisplayName": "x4x4x8",
"ValueName": "x4x4x8"
},
{
"ValueDisplayName": "x4x4x4x4",
"ValueName": "x4x4x4x4"
}
],
"WriteOnly": false
}
"Dependencies": [
{
"Dependency": {
"MapFrom": [
{
"MapFromAttribute": "BroadcomNetXtremeGigabitEthernetAdapter__ Slot14PhysicalPort1LogicalPort1_LegacyVLANMode",
"MapFromCondition": "EQU",
"MapFromProperty": "CurrentValue",
"MapFromValue": "Disabled"
}
],
"MapToAttribute": "BroadcomNetXtremeGigabitEthernetAdapter__Slot14Physical Port1LogicalPort1_VLANID14094",
"MapToProperty": "GrayOut",
"MapToValue": true
},
"DependencyFor": "BroadcomNetXtremeGigabitEthernetAdapter__Slot14PhysicalPort1 LogicalPort1_VLANID14094",
"Type": "Map"
},
...
{
"Dependency": {
"MapFrom": [
{
"MapFromAttribute": "BroadcomNetXtremeGigabitEthernetAdapter__Slot14 PhysicalPort2LogicalPort1_LegacyVLANMode",
"MapFromCondition": "EQU",
"MapFromProperty": "CurrentValue",
"MapFromValue": "Disabled"
}
],
"MapToAttribute": "BroadcomNetXtremeGigabitEthernetAdapter__Slot14Physical Port2LogicalPort1_VLANID14094",
"MapToProperty": "GrayOut",
"MapToValue": true
},
"DependencyFor": "BroadcomNetXtremeGigabitEthernetAdapter__Slot14Physical Port2LogicalPort1_VLANID14094",
"Type": "Map"
},
],
"Menus": [
{
"DisplayName": "BIOS Configurations",
"DisplayOrder": 1,
"GrayOut": false,
"Hidden": false,
"MenuName": "BiosConfigurations",
"MenuPath": "./",
"ReadOnly": false
},
...
{
"DisplayName": "System UEFI",
"DisplayOrder": 2,
"GrayOut": false,
"Hidden": false,
"MenuName": "SystemUEFI",
"MenuPath": "./SystemUEFI",
"ReadOnly": false
} ]
},
"RegistryVersion": "1.0.0",
"SupportedSystems": [
{
"FirmwareVersion": "1.20",
"ProductName": "ThinkSystem SR650 V4",
"SystemId": "7DGCCTO1WW"
}
],
"odata.context": "/redfish/v1/$metadata#AttributeRegistry.AttributeRegistry"
}