ResourceDefinition

uris

/redfish/v1/Systems/system_id/Bios/Settings

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	false	-	BIOS设置资源当前设置的属性列表，具体属性含义参考表3-533
Attributes.PXEBootToLanUEFI	string	true	-	是否使能UEFI模式PXE网络启动
}
Oem {	object	true	-	自定义属性
Oem.Public {	object	false	-	自定义属性
Oem.Public.EffectiveStatus	string	true	-	BIOS设置的生效状态，包括： ● Effective：BIOS设置已生效 ● Ineffective：BIOS设置未生效
}
}
Actions {	object	true	-	Redfish允许的BIOS设置资源可执行操作
Actions.Oem {	object	true	-	自定义属性
Actions.Oem.Public {	object	false	-	自定义属性
Actions.Oem.Public.#Settings.Revoke {	object	true	-	撤销BIOS未生效设置项
Actions.Oem.Public.#Settings.Revoke.target	string	true	-	撤销BIOS设置未生效项的路径
}
}
}
}

supported_methods

GET
PATCH
POST

HTTP methods

GET

命令功能

查询 BIOS 设置资源信息

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Bios/Settings

请求头:

text

X-Auth-Token: 123456789***********************

请求消息体:

json

{}

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
system_id	系统资源的ID	参见源文件参数说明
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得

使用指南

无

使用实例

请求样例：

http

GET <https://device_ip/redfish/v1/Systems/system_id/Bios/Settings>

X-Auth-Token: 123456789***********************

请求消息体：

json

{}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Bios.Bios",
"@odata.id": "/redfish/v1/Systems/1/Bios/Settings",
"@odata.type": "#Bios.v1_0_0.Bios",
"Id": "Settings",
"Name": "BIOS Configuration Pending Settings",
"AttributeRegistry": "BiosAttributeRegistry.1.0.1",
"Attributes": {
"PXEBootToLanUEFI": "Disabled"
},
"Oem": {
"Public": {
"EffectiveStatus": "Effective"
}
},
"Actions": {
"Oem": {
"Public": {
"#Settings.Revoke": {
"target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Oem/Public/Settings.Revoke"
}
}
}
}
}

响应码：200

PATCH

命令功能

修改 BIOS 设置资源属性

说明

BIOS设置资源表示已下发BIOS setup项，但当前还未生效，下次系统重启时生效。

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Bios/Settings

请求头:

text

X-Auth-Token: 123456789***********************
Content-Type: header_type
If-Match: ifmatch_value

请求消息体:

json

{
"Attributes": {
"QuickBoot": quickboot_value,
"QuietBoot": quietboot_value,
"PXEBootToLanUEFI": pxeboottolanuefi_value,
"PXEBootToLanLegacy": pxeboottolanlegacy_value,
"PxeTimeoutRetryControl": pxetimeoutretrycontrol_value,
"BootTypeOrder0": boottypeorder0_value,
"BootTypeOrder1": boottypeorder1_value,
"BootTypeOrder2": boottypeorder2_value,
"BootTypeOrder3": boottypeorder3_value,
"CustomPowerPolicy": custompowerpolicy_value,
"ProcessorHyperThreadingDisable": processorhyperthreadingdisable_value,
"ProcessorEISTEnable": processoreistenable_value,
"PowerSaving": powersaving_value,
"PStateDomain": pstatedomain_value,
"ProcessorC1eEnable": processorc1eenable_value,
"C6Enable": c6enable_value,
"NumaEn": numaen_value,
"PCIeSRIOVSupport": pciesriovsupport_value,
"VTdSupport": vtdsupport_value,
"InterruptRemap": interruptremap_value,
"CoherencySupport": coherencysupport_value,
"ATS": ats_value,
"PassThroughDMA": passthroughdma_value,
"BMCWDTEnable": bmcwdtenable_value,
"OSWDTEnable": oswdtenable_value,
"CREnable": crenable_value,
"GlobalBaudRate": globalbaudrate_value,
"ProcessorFlexibleRatioOverrideEnable": processorflexibleratiooverrideenable_,
"ProcessorHWPMEnable": processorhwpmenable_value,
"TStateEnable": tstateenable_value,
"EnableXE": enablexe_value,
"MLCStreamerPrefetcherEnable": mlcstreamerprefetcherenable_value,
"MLCSpatialPrefetcherEnable": mlcspatialprefetcherenable_value,
"MonitorMwaitEnable": monitormwaitenable_value,
"DCUStreamerPrefetcherEnable": dcustreamerprefetcherenable_value,
"DCUIPPrefetcherEnable": dcuipprefetcherenable_value,
"ProcessorX2APIC": processorx2apic_value,
"BootPState": bootpstate_value,
"QpiLinkSpeed": qpilinkspeed_value,
"KtiLinkL0pEn": ktilinkl0pen_value,
"KtiLinkL1En": ktilinkl1en_value,
"DDRFreqLimit": ddrfreqlimit_value,
"PatrolScrub": patrolscrub_value,
"FPKPortConfig0": fpk_port_config_value,
"FPKPortConfig1": fpk_port_config_value,
"FPKPortConfig2": fpk_port_config_value,
"FPKPortConfig3": fpk_port_config_value,
"PCIePortDisable1": pcie_port_disable_value,
"PCIePortDisable8": pcie_port_disable_value,
"PCIePortDisable85": pcie_port_disable_value
}
}

URL参数说明

参数	参数说明	取值
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

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
Attributes	设置的BIOS属性值列表	可设置的BIOS属性及含义，请参考表3-533

使用指南

无

使用实例

请求样例：

http

PATCH <https://device_ip/redfish/v1/Systems/system_id/Bios/Settings>

X-Auth-Token: 123456789*********************** Content-Type: header_type If-Match: ifmatch_value

请求消息体：

json

{
"Attributes": {
"QuickBoot": quickboot_value,
"QuietBoot": quietboot_value,
"PXEBootToLanUEFI": pxeboottolanuefi_value,
"PXEBootToLanLegacy": pxeboottolanlegacy_value,
"PxeTimeoutRetryControl": pxetimeoutretrycontrol_value,
"BootTypeOrder0": boottypeorder0_value,
"BootTypeOrder1": boottypeorder1_value,
"BootTypeOrder2": boottypeorder2_value,
"BootTypeOrder3": boottypeorder3_value,
"CustomPowerPolicy": custompowerpolicy_value,
"ProcessorHyperThreadingDisable": processorhyperthreadingdisable_value,
"ProcessorEISTEnable": processoreistenable_value,
"PowerSaving": powersaving_value,
"PStateDomain": pstatedomain_value,
"ProcessorC1eEnable": processorc1eenable_value,
"C6Enable": c6enable_value,
"NumaEn": numaen_value,
"PCIeSRIOVSupport": pciesriovsupport_value,
"VTdSupport": vtdsupport_value,
"InterruptRemap": interruptremap_value,
"CoherencySupport": coherencysupport_value,
"ATS": ats_value,
"PassThroughDMA": passthroughdma_value,
"BMCWDTEnable": bmcwdtenable_value,
"OSWDTEnable": oswdtenable_value,
"CREnable": crenable_value,
"GlobalBaudRate": globalbaudrate_value,
"ProcessorFlexibleRatioOverrideEnable": processorflexibleratiooverrideenable_,
"ProcessorHWPMEnable": processorhwpmenable_value,
"TStateEnable": tstateenable_value,
"EnableXE": enablexe_value,
"MLCStreamerPrefetcherEnable": mlcstreamerprefetcherenable_value,
"MLCSpatialPrefetcherEnable": mlcspatialprefetcherenable_value,
"MonitorMwaitEnable": monitormwaitenable_value,
"DCUStreamerPrefetcherEnable": dcustreamerprefetcherenable_value,
"DCUIPPrefetcherEnable": dcuipprefetcherenable_value,
"ProcessorX2APIC": processorx2apic_value,
"BootPState": bootpstate_value,
"QpiLinkSpeed": qpilinkspeed_value,
"KtiLinkL0pEn": ktilinkl0pen_value,
"KtiLinkL1En": ktilinkl1en_value,
"DDRFreqLimit": ddrfreqlimit_value,
"PatrolScrub": patrolscrub_value,
"FPKPortConfig0": fpk_port_config_value,
"FPKPortConfig1": fpk_port_config_value,
"FPKPortConfig2": fpk_port_config_value,
"FPKPortConfig3": fpk_port_config_value,
"PCIePortDisable1": pcie_port_disable_value,
"PCIePortDisable8": pcie_port_disable_value,
"PCIePortDisable85": pcie_port_disable_value
}
}

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#Systems/Members/1/Bios/Settings/$entity",
"@odata.id": "/redfish/v1/Systems/1/Bios/Settings",
"@odata.type": "#Bios.v1_0_0.Bios",
"Id": "Settings",
"Name": "BIOS Configuration Pending Settings",
"AttributeRegistry": "BiosAttributeRegistry.1.0.1",
"Attributes": {
"QuickBoot": "Enabled",
"QuietBoot": "Disabled",
"PXEBootToLanUEFI": "Enabled",
"PXEBootToLanLegacy": "Enabled",
"PxeTimeoutRetryControl": "TimeoutRetryCount1",
"BootTypeOrder0": "HardDiskDrive",
"BootTypeOrder1": "DVDROMDrive",
"BootTypeOrder2": "PXE",
"BootTypeOrder3": "Others",
"CustomPowerPolicy": "Custom",
"ProcessorHyperThreadingDisable": "Enabled",
"ProcessorEISTEnable": "Enabled",
"PowerSaving": "Disabled",
"PStateDomain": "All",
"ProcessorAutonomousCStateEnable": "Disabled",
"ProcessorC1eEnable": "Enabled",
"C6Enable": "Auto",
"NumaEn": "Enabled",
"PCIeSRIOVSupport": "Disabled",
"VTdSupport": "Enabled",
"InterruptRemap": "Enabled",
"CoherencySupport": "Enabled",
"ATS": "Enabled",
"PassThroughDMA": "Enabled",
"BMCWDTEnable": "Disabled",
"OSWDTEnable": "Disabled",
"CREnable": "Enabled",
"GlobalBaudRate": "Rate115200",
"ProcessorFlexibleRatioOverrideEnable": "Disabled",
"ProcessorHWPMEnable": "Disabled",
"TStateEnable": "Disabled",
"EnableXE": "Enabled",
"MLCStreamerPrefetcherEnable": "Enabled",
"MLCSpatialPrefetcherEnable": "Enabled",
"MonitorMwaitEnable": "Enabled",
"DCUStreamerPrefetcherEnable": "Enabled",
"DCUIPPrefetcherEnable": "Enabled",
"ProcessorX2APIC": "Disabled",
"BootPState": "MaxPerformance",
"QpiLinkSpeed": "Auto",
"KtiLinkL0pEn": "Enabled",
"KtiLinkL1En": "Enabled",
"DDRFreqLimit": "Auto",
"PatrolScrub": "Enabled"
},
"Oem": {
"Public": {
"EffectiveStatus": "Ineffective"
}
},
"Actions": {
"Oem": {
"Public": {
"#Settings.Revoke": {
"target": "/redfish/v1/Systems/1/Bios/Settings/Actions/Oem/Public/Settings.Revoke"
}
}
}
}
}

响应码：200

POST (ACTION)

Revoke

命令功能

清除未生效的 BIOS 配置

命令格式

URL: https://device_ip/redfish/v1/Systems/system_id/Bios/Settings/Actions/Oem/Public/Settings.Revoke

请求头:

text

X-Auth-Token: 123456789***********************
Content-Type: header_type

请求消息体:

json

{}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
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

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/Systems/system_id/Bios/Settings/Actions/Oem/Public/Settings.Revoke>

X-Auth-Token: 123456789*********************** Content-Type: header_type

请求消息体：

json

{}

响应样例：

json

{
"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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

POST (ACTION) ​

Revoke ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH

POST (ACTION)

Revoke