ResourceDefinition
uris
/redfish/v1/Systems/system_id/Bios
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | - | BIOS资源模型的OData描述信息 |
| @odata.id | string | true | - | BIOS资源的访问路径 |
| @odata.type | string | true | - | BIOS资源的类型 |
| Id | string | true | - | BIOS资源的ID |
| Name | string | true | - | BIOS资源的名称 |
| AttributeRegistry | string | true | - | BIOS属性注册资源ID |
| Attributes | object | true | - | BIOS属性列表,具体属性参考表3-488 |
| SoftwareImages | array | true | - | BIOS固件镜像列表 |
| @odata.id | string | true | - | 固件信息资源节点的访问路径 |
| ActiveSoftwareImage | object | true | - | 有效的BIOS固件镜像 |
| @odata.id | string | true | - | 固件信息资源节点的访问路径 |
| ResetBiosToDefaultsPending | boolean | true | true/false | 是否存在重设BIOS属性的待处理请求 |
| @Redfish.Settings | object | true | - | BIOS设置资源信息 |
| @odata.type | string | true | - | BIOS设置资源的类型 |
| ETag | string | true | - | BIOS设置资源的ETag值 |
| Messages | array | true | - | BIOS设置任务相关联的数组,记录BIOS侧返回的未生效的设置项及对应的错误码 |
| Time | string | true | - | BIOS设置生效的时间 |
| SettingsObject | object | true | - | BIOS设置资源的访问路径 |
| Actions | object | true | - | Redfish允许的指定BIOS资源可执行操作 |
| Bios.ResetBios | object | true | - | 恢复BIOS项默认值 |
| target | string | true | - | 恢复BIOS属性默认值的路径 |
| @Redfish.ActionInfo | string | true | - | 恢复BIOS属性默认值的查询路径 |
| Bios.ChangePassword | object | true | - | 修改BIOS密码 |
| target | string | true | - | 修改BIOS密码的路径 |
| @Redfish.ActionInfo | string | true | - | 修改BIOS密码的查询路径 |
| Oem.Public | object | true | - | 自定义属性 |
| BootCertificates | object | true | - | BIOS证书资源的访问路径说明BMC300 3.8.0.1及以上版本支持 |
| PolicyConfig | object | true | - | BIOS策略重配资源的访问路径 |
supported_methods
- GET
- POST
HTTP methods
GET
命令功能
查询 BIOS 资源信息
说明
查询BIOS配置信息时,查询的是BIOS持久化生效的配置项信息。BIOS实际支持的 资源信息受BIOS版本限制。
命令格式
URL: https://device_ip/redfish/v1/Systems/system_id/Bios
请求头:
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| system_id | 系统资源的ID | 参见源文件参数说明 |
| auth_value | 请求消息的鉴权参数 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用指南
无
使用实例
请求样例:
GET https://device_ip/redfish/v1/Systems/system_id/BiosX-Auth-Token: 123456789***********************
请求消息体:无
响应样例:
{
"@odata.context": "/redfish/v1/$metadata#Bios.Bios",
"@odata.id": "/redfish/v1/Systems/1/Bios",
"@odata.type": "#Bios.v1_2_3.Bios",
"Id": "Bios",
"Name": "BIOS Configuration Current Settings",
"AttributeRegistry": "BiosAttributeRegistry.1.0.1",
"Attributes": {
"QuickBoot": "Enabled",
"QuietBoot": "Disabled",
"PXEBootToLanUEFI": "Enabled",
"PXEBootToLanLegacy": "Enabled",
"PxeTimeoutRetryControl": "Disabled",
"BootTypeOrder0": "HardDiskDrive",
"BootTypeOrder1": "DVDROMDrive",
"BootTypeOrder2": "PXE",
"BootTypeOrder3": "Others",
"CustomPowerPolicy": "Efficiency",
"TurboMode": "Disabled",
"ProcessorHyperThreadingDisable": "Enabled",
"ProcessorEISTEnable": "Enabled",
"PowerSaving": "Enabled",
"SystemCpuUsage": 95,
"PStateDomain": "All",
"ProcessorAutonomousCstateEnable": "Enabled",
"ProcessorAutonomousCStateEnable": "Enabled",
"ProcessorC1eEnable": "Enabled",
"C6Enable": "Enabled",
"NumaEn": "Enabled",
"PCIeSRIOVSupport": "Disabled",
"PCIeARISupport": "Disabled",
"VTdSupport": "Enabled",
"InterruptRemap": "Enabled",
"CoherencySupport": "Enabled",
"ATS": "Enabled",
"PassThroughDMA": "Enabled",
"BMCWDTEnable": "Disabled",
"BMCWDTAction": "HardReset",
"BMCWDTTimeout": 20,
"OSWDTEnable": "Disabled",
"OSWDTAction": "HardReset",
"OSWDTTimeout": 5,
"CREnable": "Enabled",
"GlobalBaudRate": "Rate115200",
"ProcessorFlexibleRatioOverrideEnable": "Disabled",
"ProcessorFlexibleRatio": 23,
"ProcessorHWPMEnable": "Disabled",
"TStateEnable": "Disabled",
"EnableXE": "Disabled",
"MLCStreamerPrefetcherEnable": "Disabled",
"MLCSpatialPrefetcherEnable": "Disabled",
"MonitorMwaitEnable": "Enabled",
"DCUStreamerPrefetcherEnable": "Disabled",
"DCUIPPrefetcherEnable": "Enabled",
"ProcessorX2APIC": "Disabled",
"BootPState": "MaxPerformance",
"QpiLinkSpeed": "Auto",
"KtiLinkL0pEn": "Enabled",
"KtiLinkL1En": "Enabled",
"DDRFreqLimit": "Auto",
"PatrolScrub": "Enabled",
"FPKPortConfig0": "Enabled",
"FPKPortConfig1": "Enabled",
"FPKPortConfig2": "Enabled",
"FPKPortConfig3": "Enabled",
"PCIePortDisable1": "Auto",
"PCIePortDisable8": "Auto",
"PCIePortDisable85": "Auto"
},
"SoftwareImages": [
{
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/Bios"
}
],
"ActiveSoftwareImage": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/Bios"
},
"ResetBiosToDefaultsPending": false,
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_0_0.Settings",
"ETag": "2484f287",
"Messages": [],
"Time": "2016-02-29T16:14:44+00:00",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Settings"
}
},
"Actions": {
"#Bios.ResetBios": {
"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/Bios/ResetBiosActionInfo"
},
"#Bios.ChangePassword": {
"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/Bios/ChangePasswordActionInfo"
}
},
"Oem": {
"Public": {
"BootCertificates": {
"@odata.id": "/redfish/v1/Systems/1/Bios/Oem/Public/BootCertificates"
}
}
},
"PolicyConfig": {
"@odata.id": "/redfish/v1/Systems/1/Bios/PolicyConfig"
}
}响应码:200
POST (ACTION)
ResetBios
命令功能
恢复 BIOS 属性默认值
说明
恢复BIOS默认资源表示已下发BIOS默认值,但当前还未生效,下次系统重启时生 效。
命令格式
URL: https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ResetBios
请求头:
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
{}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| system_id | 系统资源的ID | ● 针对机架服务器,取值 为1 ● 针对高密服务器,取值 为BladeN(N表示节点 槽位号),例如 "Blade1" ● 针对刀片服务器,取值 可以为BladeN(N表示 计算节点槽位号)或 SwiN(N表示交换模块 槽位号),例如 "Swi1" ● 针对X6800 V5,X6000 V5,G5500,XA320 V2服务器,取值还可以 为Enc,表示计算节点 所在的机框资源 ● 针对设备U位信息,取 值可以为UN(N表示设 备U位号),例如"U1" ● 针对机柜资源,取值为 Rack |
使用指南
无
使用实例
请求样例:
POST https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ResetBiosX-Auth-Token: 123456789*********************** Content-Type: header_type
请求消息体:
{}响应样例:
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码:200
POST (ACTION)
ChangePassword
命令功能
修改 BIOS 密码
说明
BMC只是修改BIOS密码,BIOS密码生效需重启OS,且如果OS重启前有多次设 置,以最后一次的设置请求为准1。
命令格式
URL: https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ChangePassword
请求头:
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
{
"OldPassword": oldpwd_value,
"NewPassword": newpwd_value,
"PasswordName": pwd_name
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| system_id | 系统资源的ID | ● 针对机架服务器,取值 为1 ● 针对高密服务器,取值 为BladeN(N表示节点 槽位号),例如 “Blade1” ● 针对刀片服务器,取值 可以为BladeN(N表示 计算节点槽位号)或 SwiN(N表示交换模块 槽位号),例如 “Swi1” |
| oldpwd_value | 字符串 | BIOS已存在密码,长度以 BIOS侧实际情况为准 |
| newpwd_value | 字符串 | BIOS的新密码,长度以 BIOS侧实际情况为准 |
| pwd_name | 字符串 | ● Supervisor:修改BIOS 管理员密码 ● UserPassword:修改 BIOS普通用户密码 说明 UserPassword只在BMC300 5.1.0及以上版本支持 |
使用指南
无
使用实例
请求样例:
POST https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ChangePasswordX-Auth-Token: 123456789*********************** Content-Type: header_type
请求消息体:
{
"OldPassword": oldpwd_value,
"NewPassword": newpwd_value,
"PasswordName": pwd_name
}响应样例:
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码:200