1 Redfish概述

"Name": "Chassis Collection"

}

响应码：200

【输出说明】

表4-14 查询机箱集合资源信息返回值

字段	类型	字段说明
@odata.context	字符串	机箱集合资源模型的OData 描述信息
@odata.id	字符串	机箱集合资源的访问路径
@odata.type	字符串	机箱集合资源的类型
Members	机箱资源列表
@odata.id	字符串	单个机箱资源节点的访问路径
[email protected]	数值	机箱资源数量
Name	字符串	机箱集合资源的名称

4.2.2 查询设备信息

【功能描述】

查询设备的机箱资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-15 查询主机信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Chassis.Chassis(SerialNumber,Id,IndicatorLED,PowerState,ChassisType,PartNumber,Description,Thermal,Oem,PCIeDevices,Status,Links,Name,Drives,Power,SKU,NetworkAdapters,LogServices,Manufacturer,AssetTag,Model,[email protected])",

"@odata.id": "/redfish/v1/Chassis/1",

"@odata.type": "#Chassis.v1_7_0.Chassis",

"AssetTag": "ABC",

"ChassisType": "Rack Mount Chassis",

"Description": "Computer System Chassis",

"Oem": {

"Public": {

"DeviceMaxNum": {

"CPUNum": 2,

"FanNum": 6,

"MemoryNum": 24,

"PowerSupplyNum": 2,

"PCIeNum": 10,

"DiskNum": 20,

"StorageCardNum":4

}

"Mainboard": {

"BoardName": "RS33M2C9S",

"SerialNumber": "210231A1110000000001",

}

"Boards": {
"@odata.id": "/redfish/v1/Chassis/1/Boards"
}

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/10"

}

"Drives": {

"@odata.id": "/redfish/v1/Chassis/1/Drives"

"Id": "1",

"IndicatorLED": "Off",

"Lit",

"Blinking",

"Off"

"Links": {

"ComputerSystems": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Chassis/1/LogServices"

"Manufacturer": "H3C",

"Model": "RS33M2C9S",

"Name": "Computer System Chassis",

"NetworkAdapters": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"

"PartNumber": "",

"Power": {

"@odata.id": "/redfish/v1/Chassis/1/Power"

"PowerState": "On",

"SKU": "",

"SerialNumber": "",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Thermal": {

"@odata.id": "/redfish/v1/Chassis/1/Thermal"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功

表4-16 查询设备信息返回值

字段	类型	字段说明
@odata.context	字符串	指定机箱资源模型的OData 描述信息
@odata.id	字符串	指定机箱资源的访问路径
@odata.type	字符串	指定机箱资源的类型
Drives	对象	所有物理盘集合访问路径
Id	字符串	指定机箱资源的 ID，为机箱在机箱集合中的唯一标识
Name	字符串	指定机箱资源的名称
ChassisType	字符串	机箱类型
Description	字符串	接口描述
AssetTag	字符串	资产标签
IndicatorLED	字符串	UID灯状态： "Lit"：常亮 "Blinking"：闪烁 "Off"：关闭
[email protected]	数组	UID灯状态取值数组： "Lit"：常亮 "Blinking"：闪烁 "Off"：关闭
Links	关联服务资源
ComputerSystems	对象	系统信息资源
ManagedBy	对象	系统管理资源
LogServices	对象	日志服务集合资源节点的访问路径
Power	对象	电源信息资源
PowerState	字符串	当前主机状态： On Off
Thermal	对象	机箱散热信息
Manufacturer	字符串	制造商
Model	字符串	型号
PartNumber	字符串	产品部件号
SKU	字符串	SKU编码
SerialNumber	字符串	产品序列号
Status	对象	指定管理资源的状态，包括： Health：管理资源健康状态 State：管理资源使能状态
@odata.id	字符串	各扩展资源的访问路径
PCIeDevices	数组	PCIe设备的访问路径
Oem.Public.DeviceMaxNum.CPUNum	数值	单板部件CPU最大个数
Oem.Public.DeviceMaxNum.FanNum	数值	单板部件风扇最大个数
Oem.Public.DeviceMaxNum.MemoryNum	数值	单板部件内存最大个数
Oem.Public.DeviceMaxNum.PowerSupplyNum	数值	单板部件电源最大个数
Oem.Public.DeviceMaxNum.PCIeNum	数值	PCIe卡最大个数
Oem.Public.DeviceMaxNum.DiskNum	数值	硬盘最大个数
Oem.Public.DeviceMaxNum.StorageCardNum	数值	最大存储卡数量
Oem.Public.Mainboard.BoardName	字符串	主板产品名称 (R6900、R8900是中置背板的产品名称)
Oem.Public.Mainboard.SerialNumber	字符串	主板序列号(R6900、R8900是中置背板的序列号)
Oem.Public.Boards	对象	Boards资源的访问路径

【修改记录】

(1)HDM-1.30.07：新增对象字段Drives

(2)HDM-1.30.09：新增字段DeviceMaxNum{CPUNum,FanNum,MemoryNum,PowerSupplyNum}

(3)HDM-1.30.10：新增字段Mainboard.BoardName,Mainboard.SerialNumber

(4)HDM-1.30.12：字段DeviceMaxNum移到Oem.Public下，即为Oem.Public.DeviceMaxNum

(5)HDM-1.30.14：字段Mainboard{BoardName,SerialNumber}移到Oem.Public下

(6)HDM-1.30.18P52：新增字段Oem.Public.DeviceMaxNum.{PCIeNum,DiskNum}

(7)HDM-2.08.00：新增字段 PCIeDevices

(8)HDM-2.10.00：新增字段 Oem.Public.Boards

(9)HDM-2.93：新增字段Oem.Public.DeviceMaxNum.StorageCardNum

4.2.3 设置UID灯

【功能描述】

设置UID灯的状态，可设置为常亮、关闭、闪烁。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"IndicatorLED": ledstate

}

【参数说明】

表4-17 设置UID灯参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
IndicatorLED	字符串	Lit：常亮； Off：关闭； Blinking：闪烁

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"IndicatorLED":"Lit"

}

响应码：200

【响应样例】

{

"@odata.id": "/redfish/v1/Chassis/1",

"@odata.type": "#Chassis.v1_7_0.Chassis",

"AssetTag": "ZB17-01-Unis Huashan 20110228",

"ChassisType": "Rack Mount Chassis",

"Description": "Computer System Chassis",

"Oem": {

"Public": {

"DeviceMaxNum": {

"CPUNum": 2,

"FanNum": 6,

"MemoryNum": 24,

"PowerSupplyNum": 2

}

"Mainboard": {

"BoardName": "RS33M2C9S",

"SerialNumber": "210231A1110000000001",

}

"Boards": {
"@odata.id": "/redfish/v1/Chassis/1/Boards"
}

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/10"

}

"Drives": {

"@odata.id": "/redfish/v1/Chassis/1/Drives"

"Id": "1",

"IndicatorLED": "Blinking",

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives/drive_id

"Lit",

"Blinking",

"Off"

"Links": {

"ComputerSystems": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Chassis/1/LogServices"

"Manufacturer": "H3C",

"Model": "RS33M2C9S",

"Name": "Computer System Chassis",

"NetworkAdapters": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters"

"PartNumber": "",

"Power": {

"@odata.id": "/redfish/v1/Chassis/1/Power"

"PowerState": "On",

"SKU": "",

"SerialNumber": "",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Thermal": {

"@odata.id": "/redfish/v1/Chassis/1/Thermal"

}

【输出说明】

返回状态码200，表示操作成功。

返回体字段同【查询设备信息】。

【修改记录】

(1) HDM-1.30.09修改响应码为200，增加响应体；新增闪烁功能

4.2.4 获取所有物理盘集合信息

【功能描述】

获取所有物理盘（NVMe和HDD）集合信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Drives

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-18 获取所有物理盘集合信息

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://172.16.20.162/redfish/v1/Chassis/1/Drives

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#DriveCollection.DriveCollection(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives",

"@odata.type": "#Drive.v1_4_0.Drive",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront2"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskSlot3"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

}

"[email protected]": 3,

"Name": "Drives Collection"

}

【输出说明】

返回状态码200，表示操作成功。

表4-19 查询主机信息返回值

字段	类型	字段说明
@odata.context	字符串	物理盘集合信息模型的OData 描述信息
@odata.id	字符串	物理盘集合信息资源的访问路径
@odata.type	字符串	物理盘集合信息资源的类型
Members	数组	物理盘资源的访问路径 DiskSlotx表明是NVMe盘，x表示PCIe槽位号
[email protected]	数值	物理盘个数
Name	字符串	物理盘资源信息名称

【修改记录】

(1) HDM-1.30.07 接口新增

4.2.5 查询指定物理盘信息

【功能描述】

查询指定的物理盘信息。

【所属权限模块】

查询模块

【命令格式】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-20 查询指定物理盘信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
chassis_id	机箱资源的ID	当前所有机型取值为1
drive_id	硬盘ID	由获取所有物理盘集合信息中查询

【使用实例1】

#获取参与逻辑盘组建的物理盘的信息。

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront0",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapacityBytes": 6003333529600,

"FailurePredicted": false,

"HotspareType": "None",

"Id": "DiskFront0",

"IndicatorLED": "Off",

"Location": [{

"Info": "DiskFront0",

"InfoFormat": "DeviceName"

}],

"Manufacturer": "HGST",

"MediaErrCount": 0,

"MediaType": "HDD",

"Model": "HUS726060AL5210",

"Name": "DiskFront0",

"NegotiatedSpeedGbs": 12,

"CapableSpeedGbs": 12,

"Oem": {

"Public": {

"CapableSpeedGTs":null,

"ConnectionID": 83,

"DriveNumberInBios": 0,

"DriveNumberInOS": 0,

"FirmwareStatus": "Online",

"HoursOfPoweredUp":6504.18,

"NegotiatedSpeedGTs": null,

"OwnerVolume": {

"Name": "",

"RaidControllerID": 0,

"PatrolState": "DoneOrNotPatrolled",

"RebuildState": "DoneOrNotRebuilt",

"RebuildProgress": null,

"SpareforLogicalDrives": [],

"SASAddress": [

"5000039418218546",

"SASSmartInformation": null,

"SATASmartInformation": [

{

"AttributeName": "N/A",

"ID": 9,

"RawValue": "",

"Thresh": 0,

"Value": 100,

"Worst": 100

"Status": {

"Health": "OK",

"State": "Enabled"

"VolumeRaidLevel": "RAID0",

"element_num": 3

"Panel": "Front 0",

"TemperatureCelsius": 36

}

"PredictedMediaLifeLeftPercent": "null",

"PredictiveFailureCount": 0,

"Protocol": "SAS",

"Revision": "A907",

"SerialNumber": "K1H33AHD",

"Status": {

"Health": "OK",

"State": "Enabled"

}

"StatusIndicator":"OK",

}

响应码：200

【使用实例2】

#获取未参与逻辑盘组建的物理盘信息。

GET http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront2

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront6",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapacityBytes": 6003333529600,

"FailurePredicted": false,

"Id": "DiskFront6",

"Location": [{

"Info": "DiskFront6",

"InfoFormat": "DeviceName"

}],

"Manufacturer": "HGST",

"MediaErrCount": 0,

"MediaType": "HDD",

"Model": "HUS726060AL5210",

"Name": "DiskFront6",

"NegotiatedSpeedGbs": 12,

"CapableSpeedGbs": 12,

"Oem": {

"Public": {

"CapableSpeedGTs":null,

"ConnectionID": 87,

"DriveNumberInBios": 6,

"DriveNumberInOS": 6,

"FirmwareStatus": "Unconfigured_Good",

"SASSmartInformation":{

"AccumulatedLoadUnloadCycles":52,

"AccumulatedStartStopCycles":36,

"CycleCountOverDeviceLifetime":50000,

"DiskTemperatureCelsius":36,

"DiskTripTemperatureCelsius":65,

"ElementsInGrownDefectList":0,

"LoadUnloadCountOverDeviceLifetime":600000,

"PercentageUsedEnduranceIndicator":0,

"WeekAndYearOfManufacture":"In week 44 Of Year 2022"

"SATASmartInformation":null,

"NegotiatedSpeedGTs": null, "Panel": "Front 6",

"TemperatureCelsius": 35

}

"PredictedMediaLifeLeftPercent": "null",

"PredictiveFailureCount": 0,

"Protocol": "SAS",

"Revision": "A907",

"SerialNumber": "K1H2PJPF",

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【使用实例3】

#获取NVMe盘的信息。

GET https://172.16.20.162/redfish/v1/Chassis/1/Drives/DiskN1Slot204

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskSlot204",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapableSpeedGbs": null, ßNVMe不再支持该字段，请关注CapableSpeedGTs

"CapacityBytes": 2199023255552,

"Id": "DiskSlot204",

"Location": [

{

"Info": "Box2-4",

"InfoFormat": "DeviceName"

}

"Manufacturer": "INTEL",

"MediaType": "SSD",

"Model": "SSDPE2KX020T7",

"Name": "P4500",

"NegotiatedSpeedGbs": null, ßNVMe不再支持该字段，请关注CapableSpeedGTs

"Oem": {

"Public": {

"CapableSpeedGTs":8,

"DriveNumberInBios": "Slot 204",

"DriveNumberInOS": "Slot 204",

"FirmwareStatus": "Normal",

"SASSmartInformation": null,

"SATASmartInformation":null,

"NegotiatedSpeedGTs": 8,

"Panel": "Box2-4",

"TemperatureCelsius": 35,

}

"PredictedMediaLifeLeftPercent": "96",

"Protocol": "PCIe",

"Revision": "QDV101D1",

"SerialNumber": "PHLF725200RL2P0HGN",

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【输出说明】

表4-21 查询指定物理盘信息返回值

字段	类型	字段说明
@odata.context	字符串	指定物理盘资源模型的OData 描述信息
@odata.id	字符串	指定物理盘资源的访问路径
@odata.type	字符串	指定物理盘资源的类型
CapacityBytes	数值	物理盘容量
Id	字符串	物理盘ID；对于NVMe就是PCIe槽位号
Location.Info	字符串	指定驱动器丝印信息
Location.InfoFormat	字符串	指定驱动器丝印格式： DeviceName
Manufacturer	字符串	厂家
MediaErrCount	数值、字符串	media error计数,不支持显示“null” (NVMe盘没有)
MediaType	字符串	指定物理盘介质类型： HDD SSD
Model	字符串	硬盘型号
Name	字符串	物理盘名称
NegotiatedSpeedGbs	数值	指定物理盘接口的协商速率(Gbs)Gbps) 说明：NVMe不支持
CapableSpeedGbs	数值	指定物理盘接口的最大速率（Gbps）说明：NVMe不支持
FailurePredicted	布尔	指定物理盘（不包括NVME盘）是否检测到预故障，包括： l true l false
Protocol	字符串	指定物理盘遵循协议： SAS SATA PCIe
Oem.Public.NegotiatedSpeedGTs	数值	指定物理盘接口的协商速率 (GT/s) 说明：仅NVMe支持
Oem.Public.CapableSpeedGTs	数值	指定物理盘接口的最大速率 (GT/s) 说明：仅NVMe支持
Oem.Public.DriveNumberInBios	数值	Bios下编号。对于NVMe就是PCIe槽位号
Oem.Public.DriveNumberInOS	数值	系统下编号。对于NVMe就是PCIe槽位号
Oem.Public.FirmwareStatus	字符串	指定物理盘状态： LSI-9300卡 Ready：Ready LSI其它卡 Ready：Ready Unconfigured_Good：未配置 Unconfigured_Bad：配置异常 Hot_Spare：热备盘 Offline：离线 FAILED：故障 Rebuilding：重建 Optimal：Optimal Online：已配置 JBOD：JBOD Unknown：未知 Predict_Fail Copyback PMC卡 Offline：离线 PFA：预故障 Raw：RAW状态 Hotspare：热备盘 Ready：准备好 Optimal：Optimal Unknown：未知 Rebuilding RebuildWait NVMe盘： "Spare_below" "Temp_Anomaly" "Subsys_Degraded" "Read_only" "Cache_Failed" "Normal" "Predict_Fail" "PMR_Failed" 外购的Marvell卡 -- RAID-MARVELL-SANTACRUZ-LP-2i – 其下的物理盘状态 "Idle"：空闲状态，即未组逻辑盘 "Assigned"：被分配的状态，即已组逻辑盘 "BGA" "Importable" "Fail"：等同于driver fault "PFA"：预故障 "Unknown"：未知状态自研的Marvell卡 - RAID-MARVELL-M.2 – 其下的物理盘状态 "PFA"：预故障 "Configured"：已组逻辑盘 "Unconfigured"：未组逻辑盘 "Unknown"：未知
Oem.Public.Panel	字符串	槽位号
Oem.Public.ConnectionID	数值	物理盘连接ID，(NVMe盘没有)
Oem.Public.TemperatureCelsius	字符串	硬盘温度，单位摄氏度
PredictedMediaLifeLeftPercent	数值、字符串	剩余寿命，不支持显示"null"
PredictiveFailureCount	数值、字符串	prefail计数，不支持显示“null” (NVMe盘没有)
Revision	字符串	硬盘版本
SerialNumber	字符串	硬盘序列号
Status.Health	字符串	物理盘健康状态
Status.State	字符串	物理盘使能状态
Oem.Public.OwnerVolume.Name	字符串	所属逻辑盘名称
Oem.Public.OwnerVolume.RaidControllerID	字符串	所属逻辑盘RAID卡ID
Oem.Public.OwnerVolume.Status.Health	字符串	所属逻辑盘健康状态
Oem.Public.OwnerVolume.Status.State	字符串	所属逻辑盘使能状态
Oem.Public.OwnerVolume.VolumeRaidLevel	字符串	所属逻辑盘RAID级别
Oem.Public.OwnerVolume.element_num	字符串	所属逻辑盘下物理盘数量
HotspareType	字符串	指定驱动器的热备状态，包括：None/ Global/ Dedicated
IndicatorLED	字符串	指定驱动器的带内定位指示灯状态，包括：On/Off （支持LSI RAID卡）
StatusIndicator	字符串	指定驱动器的状态，包括:OK/FAIL/Rebuild/PredictiveFailureAnalysis/Hotspare/InAFailedArray/InACriticalArray
Oem.Public.HoursOfPoweredUp	数值	指定驱动器上电运行时间
Oem.Public.SASAddress	数组	指定驱动器SAS地址
Oem.Public.PatrolState	字符串	指定驱动器巡检状态，包括：DoneOrNotPatrolled/Patrolling
Oem.Public.RebuildState	字符串	指定驱动器数据重建状态，包括：DoneOrNotRebuilt/Rebuilding
Oem.Public.RebuildProgress	字符串	指定驱动器数据重建进度
Oem.Public.SpareforLogicalDrives	字符串	指定局部热备盘所属逻辑盘列表（目前获取不到写死null）
Oem.Public.SASSmartInformation	对象	SAS接口SMART信息
Oem.Public.SASSmartInformation. AccumulatedLoadUnloadCycles	数值	驱动器累计Load-Unload次数
Oem.Public.SASSmartInformation. AccumulatedStartStopCycles	数值	驱动器累计启停次数
Oem.Public.SASSmartInformation. CycleCountOverDeviceLifetime	数值	驱动器生命周期内可以启停的次数
Oem.Public.SASSmartInformation. DiskTemperatureCelsius	数值	驱动器当前温度
Oem.Public.SASSmartInformation. DiskTripTemperatureCelsius	数值	驱动器温度上限值
Oem.Public.SASSmartInformation. ElementsInGrownDefectList	数值	增长列表中的元素
Oem.Public.SASSmartInformation. LoadUnloadCountOverDeviceLifetime	数值	驱动器生命周期内可以Load-Unload的次数
Oem.Public.SASSmartInformation. PercentageUsedEnduranceIndicator	数值	已使用的磨损百分比（仅SSD 支持）
Oem.Public.SASSmartInformation. WeekAndYearOfManufacture	字符串	生产日期
Oem.Public.SATASmartInformation	对象	SATA接口SMART信息
Oem.Public.SATASmartInformation.AttributeName	字符串	SMART属性名称
Oem.Public.SATASmartInformation.ID	数值	SMART属性ID
Oem.Public.SATASmartInformation.Thresh	数值	SMART属性阈值
Oem.Public.SATASmartInformation.Value	数值	SMART属性当前值
Oem.Public.SATASmartInformation.Worst	数值	SMART属性最差值
Oem.Public.SATASmartInformation.RawValue	字符串	SMART属性原始值

【修改记录】

(1) (原有Systems下查询指定物理盘信息接口)HDM-1.11.27及以前版本路径为https://device_ip/redfish/v1/Systems/system_id/Storage/RAIDStorage0/Volumes/hdd_id

(2) (原有Systems下查询指定物理盘信息接口)HDM-1.30.06：增加字段Oem.Public. FirmwareStatus；字段MediaType拆分成MediaType，Protocol，NegotiatedSpeedGbs

(3) HDM-1.30.07：接口新增，替代原有Systems下查询指定物理盘信息接口。支持查询NVMe盘信息。

(4) HDM-1.30.09：修改物理盘所属逻辑盘健康状态与HDM保持一致。

(5) HDM-1.30.10：新增字段Location{Info,InfoFormat}

(6) HDM-1.30.11：新增字段CapableSpeedGbs；InfoFormat返回值为"DeviceName"

(7) 名称修改，原有名称“查询物理盘信息”

(8) HDM-1.30.11：NVMe盘新增字段CapableSpeedGbs，同时合入HDM-1.30.11P72

(9) (仅)HDM-1.30.18P5x,B05：字段PredictedMediaLifeLeftPercent类型由字符串修改修改成数值，不支持显示"null"保持不变；字段Location类型修改成数组

(10) (仅)HDM-1.30.18P5x,B05：NVMe盘新增Location字段

(11) HDM-2.11.92,HDM-2.25：VolumeRaidLevel，取值由"RAID x"修改成"RAIDx"，即删除空格

(12) HDM-2.93：新增字段HotspareType,IndicatorLED,StatusIndicator,Oem.Public.OwnerVolume.{HoursOfPoweredUp,SASAddress,PatrolState,RebuildState,RebuildProgress,SpareforLogicalDrives}

(13) HDM-3.35：新增字段FailurePredicted

(14) HDM-3.36：Oem.Public.FirmwareStatus中NVMe盘新增支持"Predict_Fail"

(15)HDM-3.39、HDM-6.04: 新增Oem.Public.NegotiatedSpeedGTs、Oem.Public.CapableSpeedGTs用于呈现NVMe的相关接口速率，原有NegotiatedSpeedGbs、CapableSpeedGbs仅支持非NVMe的接口速率

(16) HDM-6.04：修正IndicatorLED字段的描述，增加使用场景说明，仅支持带内点灯操作后的查询使用

(17) HDM-6.13：补充Oem.Public.FirmwareStatus针对Marvell卡下的M.2硬盘的说明

(18) HDM-6.14,HDM-3.49：新增NVME硬盘故障状态PMR_Failed

(19) HDM-3.42: 新增字段Oem.Public.SASSmartInformation,SASSmartInformation.AccumulatedLoadUnloadCycles,SASSmartInformation.AccumulatedStartStopCycles,SASSmartInformation.CycleCountOverDeviceLifetime,SASSmartInformation.DiskTemperatureCelsius

SASSmartInformation.DiskTripTemperatureCelsius,SASSmartInformation.ElementsInGrownDefectList,SASSmartInformation.LoadUnloadCountOverDeviceLifetime,SASSmartInformation.WeekAndYearOfManufacture,Oem.Public.SATASmartInformation

AttributeName,ID,Thresh,Value,Worst,RawValuess

(20) HDM-6.15:版本新增Oem.Public.SASSmartInformation. PercentageUsedEnduranceIndicator

(21) HDM-6.08: 新增字段MediaErrCount、PredictiveFailureCount

(22) HDM-6.11:Oem.Public.TemperatureCelsius字段，现新增支持获取NVME盘温度

4.2.6 设置指定物理盘属性

【功能描述】

设置物理盘状态

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Drives/drive_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

//设置硬盘状态

{

"Oem":{

"Public":{

"FirmwareStatus":diskstate

}

//设置全局热备盘或取消全局热备盘

{

"HotspareType": hotsparetype

}

//设置局部热备盘或取消局部热备盘

{

"HotspareType": " hotsparetype ",

"Oem":{

"Public":{

"SpareforLogicalDrives":[

{

"@odata.id": volumepath

}

]

}

【参数说明】

表4-22 设置指定物理盘属性参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
driver_id	硬盘ID	由获取所有物理盘集合信息中查询
Oem.Public.FirmwareStatus	字符串	Unconfigured_Good：未配置 Unconfigured_Bad：配置异常 JBOD：JBOD 注：Unconfigured_Bad和 JBOD状态不支持相互切换。
HotspareType	驱动器的热备状态	None：未配置热备 Global：全局热备 Dedicated：局部热备注：LSI卡支持全局和局部热备，PMC卡支持局部热备
Oem.Public.SpareforLogicalDrives	局部热备所属逻辑盘列表	数组
Oem.Public.SpareforLogicalDrives @odata.id	驱动设置为局部热备盘时，所关联的逻辑盘访问路径	可通过查询指定物理盘创建热备盘时可选逻辑盘列表获得如：” /redfish/v1/Systems/1/Storages/RAIDStorage0/ Volumes/LogicalDrive0” 注：只支持目标逻辑盘下的热备盘设置

【使用实例】

PATCH http://192.168.30.120/redfish/v1/Chassis/1/Drives/DiskFront0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

设置物理盘状态

{

"Oem":{

"Public":{

"FirmwareStatus":"Unconfigured_Bad"

}

【应答样例】

{

"@odata.context": "/redfish/v1/$metadata",

"odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront0",

"CapableSpeedGbs": 12,

"CapacityBytes": 300067880960,

"Id": "DiskFront0",

"Location": [

{

"Info": "DiskFront0",

"InfoFormat": "DeviceName"

}

"Manufacturer": "HGST",

"MediaType": "HDD",

"Model": "HUC156030CSS200",

"Name": "DiskFront0",

"NegotiatedSpeedGbs": 12,

"Oem": {

"Public": {

"ConnectionID": 25,

"DriveNumberInBios": 0,

"DriveNumberInOS": 0,

"FirmwareStatus": "Unconfigured_Bad",

"Panel": "Front 0",

"TemperatureCelsius": 38

}

"PredictedMediaLifeLeftPercent": "null",

"Protocol": "SAS",

"Revision": "AA01",

"SerialNumber": "0THK3XXP",

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【请求样例】#设置专用热备

PATCH http://192.168.18.18/redfish/v1/Chassis/1/Drives/DiskFront3

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

"HotspareType": "Dedicated",

"Oem":{

"Public":{

"SpareforLogicalDrives":[

{"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Valumes/ LogicalDrive0" },

{"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Valumes/ LogicalDrive1" }

]

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Drive.Drive(*)",

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront6",

"@odata.type": "#Drive.v1_4_0.Drive",

"CapableSpeedGbs": 6,

"CapacityBytes": 960193626112,

"HotspareType": "None",

"Id": "DiskFront6",

"IndicatorLED": "OFF",

"Location": [

{

"Info": "DiskFront6",

"InfoFormat": "DeviceName"

}

"Manufacturer": "Samsung",

"MediaType": "SSD",

"Model": "SAMSUNG MZ7LM960",

"Name": "DiskFront6",

"NegotiatedSpeedGbs": 6,

"Oem": {

"Public": {

"ConnectionID": 9,

"DiskSize": null,

"DiskSpeed": null,

"DriveNumberInBios": 6,

"DriveNumberInOS": 6,

"FirmwareStatus": "Hot_Spare",

"HoursOfPoweredUp": null,

"Panel": "Front 6",

"PatrolState": "DoneOrNotPatrolled",

"RebuildProgress": null,

"RebuildState": "DoneOrNotRebuilt",

"SASAddress": [

"300062B204D3260C",

"SpareforLogicalDrives": [

"TemperatureCelsius": 40

}

"PredictedMediaLifeLeftPercent": null,

"Protocol": "SATA",

"Revision": "GXT5204Q",

"SerialNumber": "S2TZNX0J307156",

"Status": {

"Health": "OK",

"State": "Enabled"

"StatusIndicator": " OK "

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回体字段同【查询指定物理盘信息】。

【修改记录】

(1) HDM-2.13.00接口新增

(2) HDM-2.38所属权限模块修改成远程控制

(3) HDM-6.02 支持配置热备盘，新增字段HotspareType、Oem.Public.SpareforLogicalDrives、Oem.Public.SpareforLogicalDrives @odata.id

4.2.7 查询指定机箱散热资源信息

【功能描述】

查询指定服务器机箱的温度和风扇传感器信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-23 查询指定机箱散热资源参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal(Oem,Fans,Id,FanSummary,Name,Temperatures)",

"@odata.id": "/redfish/v1/Chassis/1/Thermal",

"@odata.type": "#Thermal.v1_4_0.Thermal",

"FanSummary": {

"Redundancy": [

{

"Name"："FAN_Redundancy",

"Status": {

"Health": "OK",

"State":"Enabled"

}

]

"Count": 6

"Fans": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",

"Name": "Fan1",

"MaxReadingRange": 16500,

"MemberId": "0",

"MinReadingRange": 0,

"Oem": {

"Public": {

"SpeedRatio": 52,

"Position": "Chassis",

"SlotNumber": 1,

}

"PartNumber": "N/A",

"Reading": 8600,

"ReadingUnits": "RPM",

"Status": {

"Health": "OK",

"State": "Enabled"

}

…………

"Id": "Thermal",

"Name": "Thermal",

"Oem": {

"Public": {

"FanSpeedAdjustmentMode": "Custom",

"FanSpeedLevelPercents": 1

}

"Temperatures": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",

"LowerThresholdCritical": null,

"LowerThresholdFatal": null,

"LowerThresholdNonCritical": null,

"MemberId": "0",

"Name": "01-Inlet Temp",

"PhysicalContext": "Room",

"ReadingCelsius": 31,

"SensorNumber": 1,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 52,

"UpperThresholdFatal": 54,

"UpperThresholdNonCritical": 50

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/1",

"LowerThresholdCritical": null,

"LowerThresholdFatal": null,

"LowerThresholdNonCritical": null,

"MemberId": "1",

"Name": "02-CPU 1",

"PhysicalContext": "Room",

"ReadingCelsius": 39,

"SensorNumber": 2,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": null,

"UpperThresholdFatal": null,

"UpperThresholdNonCritical": 88

…………

]

}

响应码：200

【输出说明】

表4-24 散热资源信息

字段	类型	字段说明
@odata.context	字符串	散热资源模型的 OData 描述信息
@odata.id	字符串	散热资源的访问路径
@odata.type	字符串	散热资源的类型
Id	字符串	散热资源 ID
Name	字符串	散热资源名称
Oem.Public.FanSpeedAdjustmentMode	字符串	调速模式： "Silent"：静音模式： "Balanced"：均衡模式： "Powerful"：强劲模式： "Custom"：自定义
Oem.Public.FanSpeedLevelPercents	数值	风扇调速档位，档位越高，风扇的转速越高，设置范围1~20。注意只有当FanSpeedAdjustmentMode 等于Custom 时此字段才存在
Oem.Public.FirmwareVersion	字符串	风扇的当前版本号，仅R5500G5 AMD/INTEL
FanSummary.Count	数值	最大风扇传感器的数量
FanSummary.Redundancy.Name	字符串	风扇冗余传感器名称
FanSummary.Redundancy.Status	对象	State：风扇冗余传感器使能状态（Disabled表明未添加该传感器） Health：风扇冗余状态
Fans	风扇控制信息，刀片产品此字段为空
@odata.id	字符串	风扇散热资源的访问路径
Fans.Name	字符串	风扇名称
MaxReadingRange	数值	风扇转速规格最大值
MinReadingRange	数值	风扇转速最小值
MemberId	字符串	风扇ID
Reading	数值	风扇当前转速
Status	对象	指定风扇管理资源的状态，包括： Health：风扇健康状态 State：风扇使能状态
Oem.Public.SpeedRatio	数值	转速比
Oem.Public.Position	字符串	指定风扇传感器的容器
Oem.Public.SlotNumber	数值	指定风扇传感器的槽位号
PartNumber	对象	部件号
ReadingUnits	对象	指定风扇传感器读取到的风扇转速的单位，包括： RPM Percent
Temperatures	温度传感器列表
@odata.id	字符串	温度传感器散热资源的访问路径
MemberId	字符串	指定温度传感器的 ID。
LowerThresholdCritical	数值,字符串	温度传感器的低压严重告警阈值，无值显示N/A
LowerThresholdFatal	数值,字符串	温度传感器的低压紧急告警阈值，无值显示N/A
LowerThresholdNonCritical	数值,字符串	温度传感器的低压轻微告警阈值，无值显示N/A
Name	字符串	指定温度传感器的名称
PhysicalContext	字符串	描述此温度测量适用的区域或设备
SensorNumber	数值	指定温度传感器的序号
ReadingCelsius	数值	指定温度传感器的当前读数, 没有就显示N/A
Status	对象	指定管理资源的状态，包括： Health：传感器健康状态 State：传感器使能状态
UpperThresholdCritical	数值,字符串	指定温度传感器的高温严重告警阈值，无值显示N/A
UpperThresholdFatal	数值,字符串	指定温度传感器的高温紧急告警阈值，无值显示N/A
UpperThresholdNonCritical	数值,字符串	指定温度传感器的高温轻微告警阈值，无值显示N/A

【修改记录】

(1) HDM-1.30.09：删除根资源下oem字段及内部内容、删除所有Threshold字段；新增Temperatures.MemberId、FanSummary、Fans{oem、PartNumber、ReadingUnits}字段

(2) HDM-1.30.11：字段Fans.MemberId类型从数值修改成字符串；新增字段Oem.Public{FanSpeedAdjustmentMode,FanSpeedLevelPercents}

(3) HDM-1.30.13：字段Temperatures.MemberId类型从数值修改成字符串

(4) HDM-1.30.16：刀片产品Fans字段置空

(5) 仅HDM-1.30.18P5X,B05: 字段Fans.FanName名称修改成Fans.Name；Fans.PartName功能实现

(6) 仅HDM-1.30.18P5X,B05: 新增字段Fans.Oem.Public.Position

(7) HDM-2.11.92, HDM-2.25:新增字段Oem.Public.SlotNumber

(8) HDM-2.13.00:新增字段FanSummary.Redundancy{Name,Status}

(9) HDM-2.16.00：字段FanSpeedAdjustmentMode取值修改

(10)HDM-2.33：新增字段Oem.Public.FirmwareVersion (仅R5500G5 AMD/INTEL)

4.2.8 设置风扇模式

【功能描述】

设置风扇模式。

【所属权限模块】

电源控制

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"Oem":{

"Public":{

"FanSpeedAdjustmentMode":speedmode,

"FanSpeedLevelPercents":speedlevel

}

【参数说明】

表4-25 设置风扇参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
chassis_id	机箱资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
Oem.Public.FanSpeedAdjustmentMode	字符串	调速模式： "Silent"：静音模式： "Balanced"：均衡模式： "Powerful"：强劲模式： "Custom"：自定义
Oem.Public.FanSpeedLevelPercents	数值	风扇档位：1~20。注意只有当FanSpeedAdjustmentMode 等于Custom 时此字段才存在；档位越高，风扇转速越高

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Thermal

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Oem":{

"Public": {

"FanSpeedAdjustmentMode":"Custom",

"FanSpeedLevelPercents":18

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal(Fans,Id,FanSummary,Name,Temperatures)",

"@odata.id": "/redfish/v1/Chassis/1/Thermal",

"@odata.type": "#Thermal.v1_4_0.Thermal",

"FanSummary": {

"Count": 6

"Fans": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Fans/0",

"Name": "Fan1",

"MaxReadingRange": 16500,

"MemberId": "0",

"MinReadingRange": 0,

"Oem": {

"Public": {

"SpeedRatio": 52,

"Position": "Chassis",

"SlotNumber": 0

}

"PartNumber": "N/A",

"Reading": 8600,

"ReadingUnits": "RPM",

"Status": {

"Health": "OK",

"State": "Enabled"

}

…………

"Id": "Thermal",

"Name": "Thermal",

"Oem": {

"Public": {

"FanSpeedAdjustmentMode": "Custom",

"FanSpeedLevelPercents": 18

}

"Temperatures": [

{

"@odata.id": "/redfish/v1/Chassis/1/Thermal#/Temperatures/0",

"LowerThresholdCritical": "N/A",

"LowerThresholdFatal": "N/A",

"LowerThresholdNonCritical":"N/A",

"MemberId": "0",

"Name": "01-Inlet Temp",

"PhysicalContext": "Room",

"ReadingCelsius": 22,

"SensorNumber": 1,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 52,

"UpperThresholdFatal": 54,

"UpperThresholdNonCritical": 50

…………

]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回参数说明，同【查询指定机箱散热资源信息】

【修改记录】

(1) HDM-1.30.10：字段增加：FanSpeedLevelPercents；原有的AdjustFanSpeedMode取值从1-20修改成“Optimal”， “Increased”， “Maximum”， “Custom”

(2) HDM-1.30.12：字段AdjustFanSpeedMode名称修改成FanSpeedAdjustmentMode；同时增加返回体，返回体同【查询指定机箱散热资源信息】。

(3) 仅HDM-1.30.18P5X,B05: 字段Fans.FanName名称修改成Fans.Name

(4) HDM-2.16.00：字段FanSpeedAdjustmentMode取值修改

4.2.9 查询进风口历史温度资源信息

【功能描述】

查询进风口历史温度资源信息，刀箱产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Thermal/InletHistoryTemperature

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Thermal.Thermal(Description,HistoricalInletTemp,Name,Id)",

"@odata.id": "/redfish/v1/Chassis/1/Thermal/InletHistoryTemperature",

"@odata.type": "#Thermal.v1_4_0.Thermal",

"Description": "Air Inlet Historical Temperature",

"HistoricalInletTemp": [

{

"avg": 22,

"max": 22,

"min": 22,

"time": "2019-10-16 12:18:56"

.........

{

"avg": 24,

"max": 24,

"min": 24,

"time": "2019-10-24 00:42:13"

}

"Id": "InletHistoryTemperature",

"Name": "InletHistoryTemperature"

}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	进风口历史温度资源模型的OData 描述信息
@odata.id	字符串	进风口历史温度资源的访问路径
@odata.type	字符串	进风口历史温度资源的类型
Description	字符串	接口描述
HistoricalInletTemp.avg	数值	温度平均值
HistoricalInletTemp.max	数值	最大温度值
HistoricalInletTemp.min	数值	最小温度值
HistoricalInletTemp.time	字符串	采样时间

【修改记录】

(1) HDM-1.30.09：接口新增

4.2.10 查询电源信息

【功能描述】

查询电源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-26 查询电源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

"@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

"AllPowerStatus": {

"Oem": {

"Public": {

"HostPowerStatus": "On",

"JBODPowerStatus": null,

"JBOGPowerStatus": null,

"OverallPowerStatus": "On",

"SmartNICPowerStatus": null

}

"Id": "Power",

"Name": "Power",

"PowerControl": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

"MaxNum": 2,

"MemberId": "1",

"Name": "System Power Control 1",

"Oem": {

"Public": {

"CurrentCPUPowerWatts": 115,

"CurrentFanPowerWatts": 28,

"CurrentMemoryPowerWatts": 2,

"CurrentDiskPowerWatts": 2

}

"PowerConsumedWatts": 146,

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 766

"PowerMetrics": {

"MaxConsumedWatts": 10000,

"MinConsumedWatts": 150

"Status": {

"Health": "OK",

"State": "Enabled"

}

"PowerSupplies": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1",

"FirmwareVersion": "1M.0009.0021.002",

"LineInputVoltage": 233,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "1",

"Model": "PSR550-12A",

"Name": "PSU1",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"InputAmperage": 0.636,

"LineInputCurrent": 0.636,

"PowerCurrentWatts": 131,

"PowerID": "1",

"PowerOutputWatts": 131,

"ReadingAmperes": null,

"SlotNumber": 1

}

"PowerCapacityWatts": 550,

"PowerSupplyType": "ACorDC",

"SerialNumber": "01234567",

"Status": {

"Health": "OK",

"State": "Enabled"

}

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",

"FirmwareVersion": "4M.0002.0006.005;1M.0009.0021.003",

"LineInputVoltage": 232,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "2",

"Model": "PSR550-12A",

"Name": "PSU2",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"InputAmperage": 0.636,

"LineInputCurrent": 0.636,

"PowerCurrentWatts": 141,

"PowerID": "2",

"PowerOutputWatts": 141,

"ReadingAmperes": null,

"SlotNumber": 2

}

"PowerCapacityWatts": 550,

"PowerSupplyType": "ACorDC",

"SerialNumber": "210213A05NH179003656",

"Status": {

"Health": "OK",

"State": "Enabled"

}

"Redundancy":[

{

"Mode": "Failover" ，

"RedundancySet": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/0"

}]

}

"Voltages": [

{

"LowerThresholdCritical": 2.96,

"LowerThresholdFatal": "N/A",

"LowerThresholdNonCritical": "N/A",

"MaxReadingRange": 255,

"MinReadingRange": 0,

"Name": "SYS_3.3V",

"ReadingVolts": 3.2,

"SensorNumber": 48,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 3.6,

"UpperThresholdFatal": "N/A",

"UpperThresholdNonCritical": "N/A"

...

]

}

【输出说明】

表4-27 查询电源信息返回值

字段	类型	字段说明
@odata.context	字符串	电源信息资源模型的 OData 描述信息
@odata.id	字符串	电源信息资源的访问路径
@odata.type	字符串	电源信息资源的类型
PowerControl.MaxNum	数值	电源最大数目
PowerControl.PowerConsumedWatts	数值	电源当前功率
PowerControl.PowerCapacityWatts	数值	电源输出功率，额定功率
PowerControl.PowerMetrics.MaxConsumedWatts	数值	最大功耗
PowerControl.PowerMetrics.MinConsumedWatts	数值	最小功耗
PowerControl.PowerLimit.CorrectionInMs	数值	功耗纠正时间（毫秒）
PowerControl.PowerLimit.LimitException	字符串	功率封顶失效动作： "NoAction"：无操作 "HardPowerOff "：关机
PowerControl.PowerLimit.LimitInWatts	数值,null	电源功率限制, null 的表明是关闭功率封顶
PowerControl.Status.Health	字符串	电源控制器健康状态
PowerControl.Status.State	字符串	电源控制器使能状态
PowerControl.Oem.Public.CurrentCPUPowerWatts	数值	当前CPU功率
PowerControl.Oem.Public.CurrentMemoryPowerWatts	数值	当前内存功率
PowerControl.Oem.Public.CurrentFanPowerWatts	数值	当前风扇功率
PowerControl.Oem.Public.CurrentDiskPowerWatts	数值	当前硬盘功率
PowerSupplies.FirmwareVersion	字符串	固件版本
PowerSupplies.LineInputVoltage	数值	输入电压
PowerSupplies.LineInputVoltageType	字符串	输入电压类型： ACMidLine
PowerSupplies.Manufacturer	字符串	电源模块生产商
PowerSupplies.Model	字符串	电源型号
PowerSupplies.Name	字符串	电源名称
PowerSupplies.PowerCapacityWatts	数值	电源功耗
PowerSupplies.Oem.Public.PowerID	字符串	电源模块D号
PowerSupplies.Oem.Public.ActiveStandby	字符串	主备情况： "Standby" "Active"
PowerSupplies.Oem.Public.PowerCurrentWatts	字符串	当前电源模块输入功率
PowerSupplies.Oem.Public.InputAmperage，	数值	指定电源模块的输入电流
PowerSupplies.Oem.Public.ReadingAmperes	数值	指定电流传感器的当前读数
PowerSupplies.Oem.Public.SlotNumber	数值	指定电源模块的槽位号
PowerSupplies.Oem.Public.LineInputCurrent	数值	指定电源模块的输入电流
PowerSupplies.Oem.Public.PowerOutputWatts	数值	指定电源模块输出功率
PowerSupplies.PowerSupplyType	字符串	电源类型： "Unknown" "AC" "DC" "ACorDC"
PowerSupplies.PartNumber	字符串	电源部件号，部分电源未实现
PowerSupplies.SerialNumber	字符串	电源序列号
PowerSupplies.Status.Health	字符串	电源模块健康状态
PowerSupplies.Status.State	字符串	电源模块使能状态
PowerSupplies.MemberId	字符串	指定电源模块的ID，为其在电源模块列表中的唯一标识
Redundancy. Mode	字符串	指定电源冗余组的冗余模式： " Sharing"，表示负载均衡； "Failover"，表示主备供电模式
Redundancy. RedundancySet	对象	指定电源冗余组所包含的冗余电源模块的列表，包括： @odata.id：指定电源模块的访问路径
Voltages.LowerThresholdCritical	数值、字符串	严重下限阈值，没有显示N/A
Voltages.LowerThresholdFatal	数值、字符串	致命下限阈值，没有显示N/A
Voltages.LowerThresholdNonCritical	数值、字符串	警告下限阈值，没有显示N/A
Voltages.MaxReadingRange	数值	最大读取范围
Voltages.MinReadingRange	数值	最小读取范围
Voltages.Name	字符串	传感器名称
Voltages.ReadingVolts	数值、字符串	线性传感器显示：电压数值没有电压显示N/A 离散型传感器显示： "Voltage fault trigger"电压故障触发 "Voltage fault release"电压故障解除
Voltages.SensorNumber	数值	传感器编号
Voltages.Status.Health	字符串	电压传感器健康状态
Voltages.Status.State	字符串	电压传感器使能状态
Voltages.UpperThresholdCritical	数值、字符串	严重上限阈值，没有显示N/A
Voltages.UpperThresholdFatal	数值、字符串	致命上限阈值，没有显示N/A
Voltages.UpperThresholdNonCritical	数值、字符串	警告上限阈值，没有显示N/A
AllPowerStatus.Oem.Public.HostPowerStatus	字符串	Host（主板）的电源状态，取值范围： Off/On
AllPowerStatus.Oem.Public.JBODPowerStatus	字符串	JBOD的主电源状态，目前直接写null
AllPowerStatus.Oem.Public.JBOGPowerStatus	字符串	JBOG的主电源状态，目前直接写null
AllPowerStatus.Oem.Public.OverallPowerStatus	字符串	总电源状态，目前是随主机状态一致：Off/On
AllPowerStatus.Oem.Public.SmartNICPowerStatus	字符串	智能网卡的主电源状态，没接智能网卡时为null，取值范围： Off/On/null 。

【修改记录】

(1) HDM-1.30.06 新增字段PowerSupplies.Oem.Public.PowerCurrentWatts

(2) HDM-1.30.07 新增字段Oem.Public及内部字段

(3) HDM-1.30.09 新增字段PowerSupplies.MemberId；Voltages.ReadingVolts

、Voltages下所有Threshold字段没有就显示N/A；删除字段Oem.Public及内部字段

(4) HDM-1.30.12，删除字段PowerControl.PowerLimitState其功能由新增字段PowerControl.PowerLimit.PowerLimitEnable替代，以和【设置电源信息】保持一致

(5) HDM-1.30.14，字段Voltages.ReadingVolts，增加返回值"Voltage fault trigger"(电压故障触发)

(6) HDM-1.30.15P02，新增字段PowerControl.Oem.Public{CurrentCPUPowerWatts，CurrentMemoryPowerWatts，CurrentFanPowerWatts}，PowerSupplies.Oem.Public{InputAmperage，ReadingAmperes}，仅HDM-1.30.15P02

(7) HDM-2.0.04，字段PowerControl.PowerLimit.PowerLimitEnable删除

(8) HDM-2.11.92, HDM-2.25:新增字段PowerSupplies.Oem.Public.SlotNumber; PowerSupplyType删除No-input取值

(9) HDM-2.38,字段新增PowerSupplies.Oem.Public.{LineInputCurrent,PowerOutputWatts}

(10) HDM-2.93: 新增字段AllPowerStatus.Oem.Public.{HostPowerStatus,JBODPowerStatus,JBOGPowerStatus,OverallPowerStatus,SmartNICPowerStatus}

(10) HDM-3.10: 新增字段AllPowerStatus.Oem.Public.{HostPowerStatus,JBODPowerStatus,JBOGPowerStatus,OverallPowerStatus,SmartNICPowerStatus}

(11) HDM-6.08：新增Redundancy.Mode和Redundancy.RedundancySet字段

4.2.11 设置电源信息

【功能描述】

设置电源信息。刀箱产品不支持该接口。

【所属权限模块】

电源控制

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体1】

//电源主备切换请求消息体：

{

"PowerControl":[{

"Oem":{

"Public":{

"PowerID":id,

"ActiveStandby":mode

}

}]

}

【请求消息体2】

//开启关闭，并设置功率封顶参数

{

"PowerControl":[

{

"PowerLimit":{

"LimitInWatts":limit_value,

"LimitException":limit_exception

}

]

}

【参数说明】

表4-28 设置电源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
chassis_id	机箱资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
PowerControl.Oem.Public.PowerID	数值	电源ID
PowerControl.Oem.Public.ActiveStandby	字符串	主备设置：“Active”、“ Standby”
PowerControl.PowerLimit.LimitInWatts	数值,null	功率限定：范围150~10000W； 150~10000W会直接开启功率封顶；null 的表明是关闭功率封顶
PowerControl.PowerLimit.LimitException	字符串	功率封顶失效动作： "NoAction"：无操作 "HardPowerOff "：关机

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/Power

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体样例1】

//电源主备切换请求消息体：

{

"PowerControl":[{

"Oem":{

"Public":{

"PowerID":1,

"ActiveStandby":"Standby"

}

}]

}

【请求消息体样例2】

//开启并设置功率封顶参数

{

"PowerControl":[{

"PowerLimit":{

"LimitInWatts":766,

"LimitException":"NoAction"

}

}]

}

【返回示例】

{

"@odata.context": "/redfish/v1/$metadata#Power.Power(PowerControl,Voltages,Id,Name,PowerSupplies)",

"@odata.id": "/redfish/v1/Chassis/1/Power",

"@odata.type": "#Power.v1_5_0.Power",

"Id": "Power",

"Name": "Power",

"PowerControl": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerControl/1",

"MaxNum": 2,

"MemberId": "1",

"Name": "System Power Control 1",

"PowerConsumedWatts": 146,

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 766

"PowerMetrics": {

"MaxConsumedWatts": 10000,

"MinConsumedWatts": 150

"Status": {

"Health": "OK",

"State": "Enabled"

}

"PowerSupplies": [

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/1",

"FirmwareVersion": "1M.0009.0024.002",

"LineInputVoltage": 238,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "1",

"Model": "PSR800-12A",

"Name": "PSU1",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"InputAmperage": 0.519,

"PowerCurrentWatts": 105,

"PowerID": "1",

"ReadingAmperes": 7.04,

"SlotNumber":1

}

"PowerCapacityWatts": 800,

"PowerSupplyType": "AC",

"SerialNumber": "01234",

"Status": {

"Health": "OK",

"State": "Enabled"

}

{

"@odata.id": "/redfish/v1/Chassis/1/Power#/PowerSupplies/2",

"FirmwareVersion": "4M.0002.0006.005;1M.0009.0024.003",

"LineInputVoltage": 234,

"LineInputVoltageType": "ACMidLine",

"Manufacturer": "FSP-GROUP",

"MemberId": "2",

"Model": "PSR800-12A",

"Name": "PSU2",

"Oem": {

"Public": {

"ActiveStandby": "Active",

"PowerCurrentWatts": 144,

"PowerID": "2"

}

"PowerCapacityWatts": 800,

"PowerSupplyType": "AC",

"SerialNumber": "210213A05PH17A000320",

"Status": {

"Health": "OK",

"State": "Enabled"

}

"Voltages": [

{

"LowerThresholdCritical": 2.96,

"LowerThresholdFatal": "N/A",

"LowerThresholdNonCritical": "N/A",

"MaxReadingRange": 255,

"MinReadingRange": 0,

"Name": "SYS_3.3V",

"ReadingVolts": 3.2,

"SensorNumber": 48,

"Status": {

"Health": "OK",

"State": "Enabled"

"UpperThresholdCritical": 3.6,

"UpperThresholdFatal": "N/A",

"UpperThresholdNonCritical": "N/A"

...

]

}

【输出说明】

返回状态码200，表示操作成功。

返回参数说明同【查询电源信息】

【修改记录】

(1) HDM-1.30.08：LimitInWatts最大值从1800修改到10000

(2) HDM-1.30.12：字段PowerControl.PowerLimit.PowerEnable 名称修改成 PowerControl.PowerLimit.PowerLimitEnable

(3) HDM-1.30.12：刀箱产品不支持该接口，返回错误

(4) 仅HDM-1.30.18P5X,B05: 请求体中PowerControl类型由{…}修改成[{…}]

(5) HDM-2.0.04，字段PowerControl.PowerLimit.PowerLimitEnable删除，并增加字段LimitInWatts对使能的处理

4.2.12 查询历史功率资源信息

【功能描述】

查询历史功率资源信息，刀箱产品不支持该接口。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Power/PowerHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/Power/PowerHistoryData

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Power.Power(Description,Name,HistoricalPower,Id)",

"@odata.id": "/redfish/v1/Chassis/1/Power/PowerHistoryData",

"@odata.type": "#Power.v1_5_0.Power",

"Description": "Historical Power",

"HistoricalCPU": [

{

"avg": 247,

"max": 292,

"min": 6,

"time": "2019-10-16 22:59:01"

.........

{

"avg": 246,

"max": 256,

"min": 240,

"time": "2019-10-24 00:42:12"

}

"Id": "PowerHistoryData",

"Name": "PowerHistoryData"}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定系统资源模型的OData 描述信息
@odata.id	字符串	指定系统资源的访问路径
@odata.type	字符串	指定系统资源的类型
Description	字符串	接口描述
HistoricalCPU.avg	数值	功率平均值
HistoricalCPU.max	数值	最大功率值
HistoricalCPU.min	数值	最小功率值
HistoricalCPU.time	字符串	采样时间

【修改记录】

(1) HDM-1.30.09：接口新增

4.2.13 查询扩展卡列表

【功能描述】

查询服务器扩展板卡列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Boards

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-29 查询扩展卡列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
chassis_id	机箱资源的ID	当前所有机型取值为1

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#BoardsCollection.BoardsCollection(Members,Name,[email protected])",

"@odata.id": "/redfish/v1/Chassis/1/Boards",

"@odata.type": "#BoardsCollection.BoardsCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard6"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel1"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel4"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard8"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/M.2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard5"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard4"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BaseBoard"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/MB-BMC"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard7"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/mLOM"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/MB-BIOS"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Expander"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/HBA_Raid"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser1"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard1"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser2"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/BackPanel3"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/PcieCard3"

{

"@odata.id": "/redfish/v1/Chassis/1/Boards/Riser3"

}

"[email protected]": 22,

"Name": "Boards Collection"

}

【输出说明】

表4-30 查询扩展卡列表信息返回值

字段	类型	字段说明
@odata.context	字符串	扩展卡列表资源模型的 OData 描述信息
@odata.id	字符串	扩展卡列表资源的访问路径
@odata.type	字符串	扩展卡列表资源的类型
Members	数组	扩展卡查询路径
Name	字符串	扩展卡资源名称
[email protected]	数值	扩展卡个数

4.2.14 查询指定扩展卡信息

【功能描述】

查询扩展卡信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/Boards/board_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-31 查询扩展卡信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
board_id	扩展卡ID	根据扩展卡列表查询信息中查看
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#BoardsInstance.BoardsInstance",

"@odata.id": "/redfish/v1/Chassis/1/Boards/BaseBoard",

"@odata.type": "#Boards.v1_0_0.Boards",

"BoardId": "2147553296",

"DeviceId": "0",

"Id": "BaseBoard",

"ManufactureDate": "2018-10-27",

"Manufacturer": "H3C",

"Name": "BaseBoard",

"PartNumber": "0302A3SE",

"ProductName": "BS03M4C1SFH",

"SerialNumber": "02A3SEH189000022",

"Status": {

"Health": "OK",

"State": "Enabled"

"Version": "1"

}

【输出说明】

表4-32 查询扩展卡信息返回值

字段	类型	字段说明
@odata.context	字符串	指定扩展卡资源模型的 OData 描述信息
@odata.id	字符串	指定扩展卡资源的访问路径
@odata.type	字符串	指定扩展卡资源的类型
BoardId	字符串	指定扩展板卡单板ID
DeviceId	字符串	设备号
Id	字符串	ID号
ManufactureDate	日期	制造日期
Manufacturer	字符串	制造商
PartNumber	字符串	部件号
ProductName	字符串	产品名称
SerialNumber	字符串	序列号
Status.Health	字符串	指定扩展卡的健康状态
Status.Enable	字符串	指定扩展卡的使能状态
Version	字符串	版本号
Name	字符串	指定扩展卡资源名称

4.2.15 查询PCIE卡列表

【功能描述】

查询PCIE卡列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-33 查询PCIE卡列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevicesCollection.PCIeDevicesCollection(*)",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices",

"@odata.type": "#PCIeDeviceCollection.PCIeDeviceCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/9"

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/2"

}

"[email protected]": 3,

"Name": "PCIeDevices Collection"

}

【输出说明】

表4-34 查询PCIE卡列表信息返回值

字段	类型	字段说明
@odata.context	字符串	PCIE列表资源模型的 OData 描述信息
@odata.id	字符串	PCIE列表资源的访问路径
@odata.type	字符串	PCIE列表资源的类型
Members	数组	PCIE设备查询路径
[email protected]	数值	PCIE设备个数
Name	字符串	PCIE设备资源名称

【修改记录】

（1）HDM-1.30.09：修改PCIE设备查询路径

4.2.16 查询指定PCIE卡设备信息

【功能描述】

查询指定的PCIE卡设备信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-35 查询PCIE卡信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
pciedevices _id	PCIE卡ID	由PCIE卡集合中查询

【应答示例1】

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3",

"@odata.type": "#PCIeDevice.v1_2_0.PCIeDevice",

"Description": "RAID-LSI-9361-8i(1G)-A1-X",

"FirmwareVersion": "NULL",

"Id": "PCIeCard3",

"Links": {

"Chassis":

[

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"PCIeFunctions":

[

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3/Functions/1"

}

]

"PCIeInterface":{

"LanesInUse":8,

"MaxLanes":8

}

"Manufacturer": "LSI Logic",

"Model": "RAID-LSI-9361-8i(1G)-A1-X",

"CardManufacturer": "Broadcom",

"CardModel": "RAID-LSI-9361-8i(1G)-A1-X",

"Name": "PCIeCard3",

"Oem": {

"Public": {

"PCIeCardType": "RAID",

"DeviceLocator": "PCIe Card3",

"Position": 3,

"SlotNumber": 3

}

"SerialNumber": "02A2X0H185001019",

"Status": {

"Health": "OK",

"State": "Enabled"

}

【应答示例2：GPU卡】

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5",

"@odata.type": "#PCIeDevice.v1_2_0.PCIeDevice",

"Description": "Tesla V100-PCIE-16G",

"FirmwareVersion": "88.00.1A.00.03",

"Id": "PCIeCard5",

"Links": {

"Chassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"PCIeFunctions": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/5/Functions/1"

}

]

"Manufacturer": "NVIDIA",

"Model": "Tesla V100-PCIE-16G",

"CardManufacturer": "NVIDIA",

"CardModel": "Tesla V100-PCIE-16G",

"Name": "Tesla V100-PCIE-16G",

"Oem": {

"Public": {

"DeviceLocator": "PCIe Card5",

"MemorySizeMiB": 16384,

"PCIeCardType": "GPU",

"Position": 5,

"PowerCapacityWatts": 70,

"PowerWatts": 70,

"SlotNumber": 5

}

"PCIeInterface": {

"LanesInUse": 16,

"MaxLanes": null

"SerialNumber": "0323617020478",

"Status": {

"Health": "OK",

"State": "Enabled"

}

【输出说明】

表4-36 查询指定PCIE卡设备信息返回值

字段	类型	字段说明
@odata.context	字符串	指定PCIE卡资源模型的 OData 描述信息
@odata.id	字符串	指定PCIE卡资源的访问路径
@odata.type	字符串	指定PCIE卡资源的类型
Description	字符串	指定PCIe设备的描述
FirmwareVersion	字符串	指定PCIe设备的固件版本，未支持显示”NULL”
Id	字符串	指定PCIe设备资源ID
Links	PCIe设备关联的资源
@odata.id	字符串	各属性的访问路径
Chassis	数组	指定机箱资源的链接
PCIeFunctions	数组	指定PCIe功能的访问路径
PCIeInterface.LanesInUse	数值	指定PCIe设备当前协商的PCIe lane数
PCIeInterface.MaxLanes	数值	指定PCIe设备支持的最大PCIe lane数
Manufacturer	字符串	指定PCIe设备的生产厂商
Model	字符串	指定PCIe设备的型号
CardManufacturer	字符串	PCIe设备制造商（与存储控制器、网卡等的CardManufacturer保持一致）
CardModel	字符串	PCIe设备型号（与存储控制器的CardModel、网卡的Oem.Public.Name保持一致）
Name	字符串	指定PCIe设备资源名称
Oem.Public.PCIeCardType	字符串	指定PCIe设备的类型，如： · GPU · FPGA · NIC · RAID · SAS · FC · IB · OEM · QAT · SWITCH
Oem.Public.DeviceLocator	字符串	指定PCIe设备的丝印
Oem.Public.FunctionType	字符串	指定PCIe设备的类型【当前未实现】
Oem.Public.McuFirmwareVersion	字符串	指定PCIe设备相关的MCU固件版本【当前未实现】
Oem.Public.Position	数值	指定PCIe设备的容器
Oem.Public.SlotNumber	数值	指定PCIe设备的槽位号
Oem.Public.PowerWatts	数值	指定GPU设备当前功耗注：部分Nvidia GPU需要安装驱动并执行“nvidia-smi -pm 1”命令才能获取当前功耗
Oem.Public.PowerCapacityWatts	数值	指定GPU设备额定功率
Oem.Public.MemorySizeMiB	数值	指定GPU设备显存
SerialNumber	字符串	指定PCIe设备的序列号
Status	对象	指定PCIe设备的状态，包括： Health：指定PCIe设备资源健康状态 State：指定PCIe设备资源使能状态

【修改记录】

(1) HDM-1.30.09：接口新增

(2) HDM-1.30.11：SerialNumber功能实现

(3) HDM-1.30.18P56, HDM-2.0.07：字段Links.Chassis、Links.PCIeFunctions类型由对象修改成数组

(4) HDM-2.11.92, HDM-2.25：新增字段Oem.Public.PCIeCardType, Oem.Public.SlotNumber

(5) HDM-2.11.93, HDM-2.25：新增字段PCIeInterface.LanesInUse

(6) HDM-2.11.97, HDM-2.25：新增字段PCIeInterface.MaxLanes

(7) HDM-2.26 字段PCIeCardType新增值SWITCH

(8) HDM-2.27 字段PCIeCardType新增值QAT

(9) HDM-2.38 针对GPU卡新增字段Oem.Public.{PowerWatts,PowerCapacityWatts,Oem.Public.MemorySizeMiB}

(10) HDM-6.08：新增CardManufacturer、CardModel字段

4.2.17 查询指定PCIE卡功能信息

【功能描述】

查询指定的PCIE卡功能信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id/Functions/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-37 查询PCIE卡信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
pciedevices _id	PCIE卡ID	由PCIE卡集合中查询

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#PCIeDevicesFunctionsInstance.PCIeDevicesFunctionsInstance",

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3/Functions/1",

"@odata.type": "#PCIeFunction.v1_2_0.PCIeFunction",

"DeviceId": "0x005D",

"Id": "1",

"Manufacturer": "LSI Logic",

"Name": "Function1",

"Oem": {

"Public": {

"BusNumber": "0x5e",

"Datawidth": "x8",

"DeviceClass": "MassStorageController",

"DeviceNumber": "0x00",

"FunctionNumber": "0",

"LinkWidthAbility": "x16",

"MaxProtocol": "Gen 3",

"MaxSpeed": "8.0GT/s",

"Negotiatedspeed": "8.0GT/s",

"Protocol": "Gen 3",

"Slot": "3"

}

"ProductName": "RAID-LSI-9361-8i(1G)-A1-X",

"Status": {

"Health": "OK",

"State": "Enabled"

"SubsystemId": "0x9361",

"SubsystemVendorId": "0x1000",

"VendorId": "0x1000"

}

【输出说明】

表4-38 查询PCIE卡功能信息返回值

字段	类型	字段说明
@odata.context	字符串	指定PCIE卡资源模型的 OData 描述信息
@odata.id	字符串	指定PCIE卡资源的访问路径
@odata.type	字符串	指定PCIE卡资源的类型
DeviceId	字符串	指定PCIe设备的设备ID
VendorId	字符串	指定PCIe设备的厂商ID
Id	字符串	指定PCIe功能资源ID
SubsystemId	字符串	子系统ID
SubsystemVendorId	字符串	子系统供应商ID
Manufacturer	字符串	指定 PCIe 设备的生产厂商
PartNumber	字符串	部件号
ProductName	字符串	产品名称
SerialNumber	字符串	序列号
Status	对象	指定PCIe设备功能的状态，包括： Health：指定设备资源健康状态 State：指定设备资源使能状态
Oem.Public.Datawidth	字符串	协商带宽
Oem.Public.MaxSpeed	字符串	最大速率
Oem.Public.Negotiatedspeed	字符串	协商速率
Oem.Public.Protocol	字符串	协商协议
Oem.Public.Slot	字符串	PCIe槽位号
Oem.Public.BusNumber	字符串	指定PCIe设备总线号
Oem.Public.DeviceClass	字符串	指定PCIe设备分类
Oem.Public.DeviceNumber	字符串	指定PCIe设备设备号
Oem.Public.FunctionNumber	字符串	指定PCIe设备功能号
Oem.Public.LinkWidthAbility	字符串	指定PCIe设备最大链路带宽
Oem.Public.MaxProtocol	字符串	最高协议
Oem.Public.MaxDatawidth	字符串	最大带宽
Name	字符串	指定PCIe功能资源名称

【修改记录】

(1) HDM-1.30.08增加字段PartNumber，SerialNumber

(2) HDM-1.30.09新增字段 Oem.Public{BusNumber, DeviceClass，DeviceNumber，FunctionNumber}

(3) HDM-1.30.09字段PartNumber，SerialNumber删除；该接口原文档名称是“查询指定PCIE卡信息”

(4) HDM-1.30.18P56,HDM-2.0.07：字段Status由字符串修改成对象

(5) HDM-2.93: 新增字段Oem.Public.MaxProtocol,Oem.Public.MaxDatawidth, Oem.Public.LinkWidthAbility

4.2.18 查询网络适配器集合资源信息

【功能描述】

查询设备的网络适配器集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-39 查询网络适配器集合资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#NetworkAdapterCollection.NetworkAdapterCollection",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters",

"@odata.type": "#NetworkAdapterCollection.NetworkAdapterCollection",

"Description": "Collection of ethernet interfaces for this system",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM"

}

"Name": "NetworkAdapter Collection"

}

响应码：200

【输出说明】

表4-40 查询网络适配器集合资源信息返回值

字段	类型	字段说明
@odata.context	字符串	网络适配器集合资源模型的OData 描述信息
@odata.id	字符串	网络适配器集合资源的访问路径
@odata.type	字符串	网络适配器集合资源的类型
Description	字符串	网络适配器集合资源信息的描述
Members	网络适配器资源列表
@odata.id	字符串	单个网络适配器资源节点的访问路径
[email protected]	数值	网络适配器资源数量

4.2.19 查询网络适配器单个资源信息

【功能描述】

查询指定的网络适配器资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapter_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-41 查询网络适配器集合资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1
networkadapter_id	网络适配器ID	由“查询网络适配器集合资源信息”中获取

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例1】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6",

"@odata.type": "#NetworkAdapter.v1_1_0.NetworkAdapter",

"Controllers": [

{

"ControllerCapabilities": {

"NetworkPortCount": 2

"FirmwarePackageVersion": "1.1197.0",

"Links": {

"NetworkPorts": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/1"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/2"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/6"

}

"[email protected]": 1

}

"Id": "PCIeSlot6",

"Manufacturer": "Intel",

"Model": "CNA-10GE-2P-560F-B2-1",

"Name": "PCIeSlot6",

"NetworkPorts": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts"

"Oem": {

"Public": {

"CapableSpeedGbs": "10",

"CardManufacturer": "Intel",

"CardModel": "2*10GE",

"FirmwareVersion": "1.1197.0",

"NetworkTechnology": [

"Ethernet"

"DeviceLocator": "MEZZ2",

"PartNumber": "0302A3HQ",

"Position": "PCIeSlot6",

"RootBDF": "0000:5D:02.0",

"SerialNumber": "02A2N31234567890",

"TemperatureCelsius": 53,

"SlotNumber":6

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【应答实例2】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM",

"@odata.type": "#NetworkAdapter.v1_1_0.NetworkAdapter",

"Controllers": [

{

"ControllerCapabilities": {

"NetworkPortCount": 4

"FirmwarePackageVersion": "1.1767.0",

"Links": {

"NetworkPorts": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/1"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/2"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/3"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts/4"

}

"[email protected]": 4,

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3"

}

"[email protected]": 1

}

"Id": "mLOM",

"Manufacturer": "Intel",

"Model": "NIC-GE-4P-360T-L3",

"Name": "mLOM",

"NetworkPorts": {

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mLOM/NetworkPorts"

"Oem": {

"Public": {

"CapableSpeedGbs": "0",

"CardManufacturer": "Intel",

"CardModel": "4*0GE",

"FirmwareVersion": "1.1767.0",

"PartNumber": "0302A3HQ",

"Position": "mLOM",

"SerialNumber": "02A3GKH17B000267",

"TemperatureCelsius": "null",

"SlotNumber":9,

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【输出说明】

表4-42 查询单个网络适配器资源信息返回值

字段	类型	字段说明
@odata.context	字符串	指定网络适配器资源模型的OData 描述信息
@odata.id	字符串	指定网络适配器资源的访问路径
@odata.type	字符串	指定网络适配器资源的类型
Manufacturer	字符串	指定网络适配器的芯片制造商
Model	字符串	指定网络适配器的型号
Name	字符串	网络适配器资源名称
Id	字符串	网络适配器资源Id
Oem.Public	指定网络适配器自定义信息
CapableSpeedGbs	字符串	规格速率
FirmwareVersion	字符串	指定网络适配器的固件版本
NetworkTechnology	数组	指定网络适配器的网络协议(仅适配部分网卡)： Ethernet FC iSCSI FCoE OPA IB
DeviceLocator	字符串	指定网络适配器的丝印信息
PartNumber	字符串	指定网络适配器的部件号
Position	字符串	指定网络适配器的容器有"mLOM"，"sLOM"，"Embedded"…等
SerialNumber	字符串	序列号
Status	对象	指定管理资源的状态，包括： Health：指定网络适配器资源健康状态 State：指定网络适配器资源使能状态
TemperatureCelsius	字符串	温度
SlotNumber	数值	指定网络适配器的槽位号
RootBDF	字符串	指定网络适配器的root port BDF · G3适配产品：R4900G3、X10000、R4300G3、R6700G3、R5300G3产品 · G5全部适配
CardManufacturer	字符串	指定网络适配器的厂商
CardModel	字符串	指定网络适配器的接口类型
Controllers	描述适配器控制器的信息
FirmwarePackageVersion	字符串		固件包版本
Links	指定网络适配器的相关单个对象
NetworkPorts	指定网络适配器的相关网络端口对象集合

【修改记录】

(1) HDM-1.30.09：新增字段：RootBDF(仅R4900G3产品功能实现)，CardManufacturer，Controllers，Link，NetworkPorts

(2) HDM-1.30.14：字段RootBDF删除(除R4900G3)；字段Controllers内容格式{...}修改为Controller[{...}]；字段Controllers.PCIeDevices内容格式{...}修改为Controller[{...}]；新增字段Id；字段删除Oem.Publc.NegotiatedSpeedGTs

(3) HDM-1.30.17：字段RootBDF适配X10000产品；新增字段NetworkTechnology(仅适配部分网卡)

(4) 仅HDM-1.30.18P5X,B05：字段Controllers.Link名称修改成Controllers.Links

(5) HDM-2.08.00：Manufacturer的内容由制造商，修改成芯片厂商

(6) HDM-2.10.00：新增字段Oem.Publc.DeviceLocator

(7) HDM-2.11.92，HDM-2.25：新增字段Oem.Public.SlotNumber

(8) HDM-2.11.94，HDM-2.25：字段RootBDF新增R4300G3、R6700G3产品支持

(9) HDM-2.17.00：字段删除Oem.public.NIC_id，该字段前期固定返回1

(10) HDM-2.42：字段RootBDF新增R5300G3产品支持

(11) HDM-6.12：补充PartNumber字段说明

4.2.20 查询网络端口集合资源信息

【功能描述】

查询网络端口集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/

networkadapters_id/NetworkPorts

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-43 查询网络端口集合资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts",

"@odata.type": "#NetworkPortCollection.NetworkPortCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1"

{

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/2"

}

PATCH https://device_ip/ /redfish/v1/Chassis/1/Drives/AlarmThreshold

"Name": "Network Port Collection"

}

响应码：200

【输出说明】

表4-44 网络端口集合资源信息

字段	类型	字段说明
@odata.context	字符串	网络端口集合资源模型的 OData描述信息
@odata.id	字符串	网络端口集合资源的访问路径
@odata.type	字符串	网络端口集合资源的类型
Name	字符串	网络端口集合资源的名称
Members	网络适配器资源列表
@odata.id	字符串	网络端口资源列表
[email protected]	数值	网络端口资源数量

【修改记录】

(1) HDM-1.30.09 新增接口

4.2.21 查询网络端口单个资源信息

【功能描述】

查询指定服务器机箱的网络端口单个资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapteras_id/NetworkPorts/networkport_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-45 查询网络端口单个资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1
networkport_id	网络端口单个资源ID	由 “查询网络端口集合资源信息”中获取

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/4",

"@odata.type": "#NetworkPort.v1_1_0.NetworkPort",

"AssociatedNetworkAddresses": [

"60:0B:03:6F:E3:DE"

"Id": "4",

"Name": "4",

"Oem": {

"Public": {

"BDF": "0000:86:00.3",

"PortType": "ElectricalPort",

"AutoNeg": true,

"FullDuplex": true,

"PortMaxSpeed": "10000Mb/s",

"LldpService":{

"LldpEnabled": true,

"WorkMode": "Tx"

}

"PhysicalPortNumber": "4",

"LinkStatus": "N/A",

"CurrentLinkSpeedMbps": 10000

}

响应码：200

【输出说明】

表4-46 查询单个网络端口单个资源信息返回值

字段	类型	字段说明
@odata.context	字符串	网络端口资源模型的OData描述信息
@odata.id	字符串	网络端口资源的访问路径
@odata.type	字符串	网络端口资源的类型
AssociatedNetworkAddresses	数组	网口MAC地址
Id	字符串	网络端口资源ID
Name	字符串	网络端口资源名称
PhysicalPortNumber	字符串	指定网络端口的物理丝印号
LinkStatus	字符串	端口状态。(仅适配部分网卡) Up Down N/A：表示不支持、获取失败(如BIOS重启中，BIOS关机、NCSI禁用)
CurrentLinkSpeedMbps	数值	端口协商速率，单位Mbs
Oem.Public	自定义属性
PortType	字符串	指定网络端口的网口类型，包括： OpticalPort：光口 ElectricalPort：电口 N/A：网口类型未知
BDF	字符串	指定网络端口的BDF
AutoNeg	布尔	指定端口是否自动协商 true false
FullDuplex	布尔	指定端口是否全双工 true false
PortMaxSpeed	字符串	网络端口规格速率，单位Mb/s 如"10000Mb/s"
LldpService.LldpEnabled	布尔	指定网口的LLDP使能，包括： true：使能 false：禁止 null：不支持LldpService
LldpService.WorkMode	字符串	LLDP工作模式 Tx：发送模式

【修改记录】

(1) HDM-1.30.09 新增接口

(2) HDM-1.30.11字段AssociatedNetworkAddresses从字符串修改成数组，PhysicalPortNumber从数值修改成字符串

(3) HDM-1.30.13：新增字段LinkStatus, NegotiateSpeedGTs；仅HBA卡有效

(4) HDM-1.30.17字段LinkStatus新增部分网卡适配

(5) HDM-1.30.21，HDM-2.06.00字段NegotiateSpeedGTs名称修改成NegotiateSpeedGbs

(6) HDM-2.09.00：新增字段AutoNeg，FullDuplex

(7) HDM-2.10.00：新增字段CurrentLinkSpeedMbps，删除原有的非标准字段NegotiateSpeedGbs

(8) HDM-2.11.00：新增字段PortMaxSpeed

(9) HDM-2.11.92：新增字段Oem.Public.LldpService.WorkMode

(10) HDM-2.11.97，HDM-2.19：新增字段Oem.Public.LldpService.LldpEnabled

4.2.22 设置网络端口单个资源信息

【功能描述】

设置服务器机箱的网络端口单个资源信息。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapteras_id/NetworkPorts/networkport_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"Oem": {

"Public": {

"LldpService":{

"LldpEnabled": true,

}

【参数说明】

表4-47 设置网络端口单个资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
chassis_id	机箱资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
Oem.Public.LldpService.LldpEnabled	布尔	指定网口的LLDP使能，包括： true：使能 false：禁止

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Chassis/1/NetworkAdapters/Embedded/NetworkPorts/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Oem": {

"Public": {

"LldpService":{

"LldpEnabled": true,

}

响应码：200

【输出说明】

{

"@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",

"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeSlot6/NetworkPorts/4",

"@odata.type": "#NetworkPort.v1_1_0.NetworkPort",

"AssociatedNetworkAddresses": [

"60:0B:03:6F:E3:DE"

"Id": "4",

"Name": "4",

"Oem": {

"Public": {

"BDF": "0000:86:00.3",

"PortType": "ElectricalPort",

"AutoNeg": true,

"FullDuplex": true,

"PortMaxSpeed": "10000Mb/s"

"LldpService":{

"LldpEnabled": true,

"WorkMode": "Tx"

}

"PhysicalPortNumber": "4",

"LinkStatus": "N/A",

"CurrentLinkSpeedMbps": 10000

}

【修改记录】

(1) HDM-2.11.97，HDM-2.19：接口新增

4.2.23 获取存储介质告警水线

【功能描述】

获取存储介质告警阈值水线。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip//redfish/v1/Chassis/chassis_id/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-48 查询存储介质告警水线参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
chassis_id	机箱资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Chassis/1/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#AlarmThreshold.AlarmThreshold",

"@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold",

"@odata.type": "#AlarmThresholdService.v1_0_0.AlarmThresholdService",

"BadTrack": {

"AlarmLimit": 32767,

"EnableFlag": false

"Life": {

"AlarmLimit": 90,

"EnableFlag": true,

"MajorAlarmLimit": 95

"MediaError": {

"MediaErrorCnt": 32767,

"MediaErrorEnableFlag": false

"PredFail": {

"PredFailCnt": 255,

"PredFailEnableFlag": false

"RevBlock": {

"AlarmLimit": 10,

"EnableFlag": true

"UNC": {

"AlarmLimit": 255,

"EnableFlag": false

}

【返回值】

表4-49 查询存储介质告警水线返回值

字段	类型	字段说明
@odata.context	字符串	存储介质告警资源模型的OData 描述信息
@odata.id	字符串	存储介质告警资源的访问路径
@odata.type	字符串	存储介质告警资源的类型
BadTrack	硬盘坏道。该字段仅对HDD盘有效。
AlarmLimit	数值	坏道阈值 0~65535
EnableFlag	布尔型	true:开启 false:关闭
Life	硬盘擦写寿命百分比。该字段仅对SSD、NVMe盘有效。默认使能。AlarmLimit默认为90，MajorAlarmLimit默认为100。
AlarmLimit	数值	擦写轻微告警寿命阈值 0~100
MajorAlarmLimit	数值	擦写严重告警寿命阈值 0~100
EnableFlag	布尔型	true:开启 false:关闭
MediaError	Media error。该字段仅对HDD、SSD盘有效。
AlarmLimit	数值	Media error 阈值 0~65535
EnableFlag	布尔型	true:开启 false:关闭
PredFail	Pred fail。该字段仅对HDD、SSD盘有效。
AlarmLimit	数值	Pred fail 阈值 0~255；
EnableFlag	布尔型	true:开启 false:关闭
RevBlock	硬盘预留块。该字段仅对SSD盘有效。
AlarmLimit	数值	预留块阈值 0~100
EnableFlag	布尔型	true:开启 false:关闭
UNC	UNC。该字段仅对HDD、SSD盘有效。
AlarmLimit	数值	UNC阈值 0~255
EnableFlag	布尔型	true:开启 false:关闭

【修改记录】

(1) HDM-1.30.09接口新增

(2) HDM-3.46、HDM-6.02：Life下，新增字段MajorAlarmLimit，用于查询擦写严重告警阈值，原有AlarmLimit用作擦写轻微告警阈值。Life默认使能。

(3) HDM-6.16：补充应答示例中Life的EnableFlag字段

4.2.24 设置存储介质告警水线

【功能描述】

设置存储介质告警水线。

【所属权限模块】

维护诊断

【命令格式】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"BadTrack": {

"AlarmLimit": Limit,

"EnableFlag": Flag

"Life": {

"AlarmLimit": Limit,

"MajorAlarmLimit": Limit,

"EnableFlag": Flag

"MediaError": {

"MediaErrorCnt": Limit,

"MediaErrorEnableFlag": Flag

"PredFail": {

"PredFailCnt": Limit,

"PredFailEnableFlag": Flag

"RevBlock": {

"AlarmLimit": Limit,

"EnableFlag": Flag

"UNC": {

"AlarmLimit": Limit,

"EnableFlag": Flag

}

【参数说明】

表4-50 设置存储介质告警水线参数说明

字段	类型	字段说明
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
BadTrack	硬盘坏道。该字段仅对HDD盘有效。
AlarmLimit	数值	坏道阈值 0~65535
EnableFlag	布尔型	true:开启 false:关闭
Life	硬盘擦写寿命。该字段仅对SSD、NVMe盘有效。默认使能。AlarmLimit默认为90，MajorAlarmLimit默认为100。
AlarmLimit	数值	擦写轻微告警寿命阈值 0~100
MajorAlarmLimit	数值	擦写严重告警寿命阈值 0~100，不下发该参数时，默认使用100
EnableFlag	布尔型	true:开启 false:关闭
MediaError	Media error。该字段仅对HDD、SSD盘有效。
AlarmLimit	数值	Media error 阈值 0~65535
EnableFlag	布尔型	true:开启 false:关闭
PredFail	Pred fail。该字段仅对HDD、SSD盘有效。
AlarmLimit	数值	Pred fail 阈值 0~255
EnableFlag	布尔型	true:开启 false:关闭
RevBlock	硬盘预留块。该字段仅对SSD盘有效。
AlarmLimit	数值	预留块阈值 0~100
EnableFlag	布尔型	true:开启 false:关闭
UNC	UNC。该字段仅对HDD、SSD盘有效。
AlarmLimit	数值	UNC阈值 0~255
EnableFlag	布尔型	true:开启 false:关闭

【使用实例】

【请求样例】

PATCH https://192.168.20.207/redfish/v1/Chassis/1/Drives/AlarmThreshold

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"BadTrack": {

"AlarmLimit": 32767,

"EnableFlag": true

"Life": {

"AlarmLimit": 20,

"MajorAlarmLimit": 30,

"EnableFlag": true

"MediaError": {

"MediaErrorCnt": 32767,

"MediaErrorEnableFlag": true

"PredFail": {

"PredFailCnt": 213,

"PredFailEnableFlag": true

"RevBlock": {

"AlarmLimit": 10,

"EnableFlag": true

"UNC": {

"AlarmLimit": 177,

"EnableFlag": true

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#AlarmThreshold.AlarmThreshold",

"@odata.id": "/redfish/v1/Chassis/1/Drives/AlarmThreshold",

"@odata.type": "#AlarmThresholdService.v1_0_0.AlarmThresholdService",

"BadTrack": {

"AlarmLimit": 32767,

"EnableFlag": true

"Life": {

"AlarmLimit": 20,

"MajorAlarmLimit": 30,

"EnableFlag": true

"MediaError": {

"MediaErrorCnt": 32767,

"MediaErrorEnableFlag": true

"PredFail": {

"PredFailCnt": 213,

"PredFailEnableFlag": true

"RevBlock": {

"AlarmLimit": 10,

"EnableFlag": true

"UNC": {

"AlarmLimit": 177,

"EnableFlag": true

}

响应码：200

返回体字段说明同【获取存储介质告警水线】

【输出说明】

返回状态码200，表示操作成功。

【修改记录】

(1) HDM-1.30.09接口新增

(2) HDM-3.46、HDM-6.02：Life下，新增字段MajorAlarmLimit，用于设置擦写严重告警阈值，原有AlarmLimit用作擦写轻微告警阈值，默认使能擦写寿命告警。Life默认使能。

4.3 Systems 资源的操作

4.3.1 查询系统集合资源信息

【功能描述】

查询服务器当前系统集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-51 查询服务器当前系统集合资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection",

"@odata.id": "/redfish/v1/Systems",

"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

"Name": "Systems Collection"

}

响应码：200

【输出说明】

表4-52 查询主机系统集合资源信息返回值

字段	类型	字段说明
@odata.context	字符串	系统集合资源模型的OData 描述信息
@odata.id	字符串	系统集合资源的访问路径
@odata.type	字符串	系统集合资源的类型
Members	系统资源列表
@odata.id	字符串	单个系统资源节点的访问路径
[email protected]	数值	系统资源数量
Name	字符串	系统集合资源名称"Systems Collection"

4.3.2 查询指定系统资源信息

【功能描述】

查询服务器指定系统资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-53 查询指定系统资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",

"@odata.id": "/redfish/v1/Systems/1",

"@odata.type": "#ComputerSystem.v1_5_0.ComputerSystem",

"Actions": {

"#ComputerSystem.Reset": {

"On",

"ForceOff",

"ForceRestart",

"GracefulShutdown"

"Nmi",

"ForcePowerCycle"

"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"

}

"AssetTag": "ZB17-01-Unis Huashan 20110228",

"Bios": {

"@odata.id": "/redfish/v1/Systems/1/Bios"

"BiosVersion": "2.00.30 V100R001B02D030",

"Boot": {

"BootSourceOverrideEnabled": "Once",

"Once",

"Continuous"

"BootSourceOverrideMode": "None",

"None",

"Legacy",

"UEFI"

"BootSourceOverrideTarget": "None",

"None",

"Pxe",

"Hdd",

"Cd",

"BiosSetup"

]

"ChassisPartNumber": "0235AQ7",

"Description": "System 1",

"Healthstate": {

"OverallHealth": "Critical",

"board": "OK",

"fans": "OK",

"memory": "OK",

"pcie": "OK",

"power": "OK",

"processor": "OK",

"storage": "Critical",

"temperature": "OK"

"HostName": "HDM12315555777745557765",

"Id": "1",

"IndicatorLED": "Off",

"Links": {

"Chassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Systems/1/LogServices"

"MaintenanceSerialNumber": "210231A1110000000001",

"Manufacturer": "H3C",

"Memory": {

"@odata.id": "/redfish/v1/Systems/1/Memory"

"MemorySummary": {

"Count":5,

"Status":{

"Health":"OK",

"HealthRollup":"OK",

"State":"Enabled"

"TotalSystemMemoryGiB": 4

"Model": "RS33M2C9S",

"Name": "Computer System",

"NetworkInterfaces": {

"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"

"Oem": {

"Public": {

"BiosVendor": "AMI",

"IndependentPowerSupply": false,

"PowerOnStrategy": "RestorePreviousState"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0"

}

"PCIeFunctions": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0/Functions/1"

}

"PartNumber": "",

"PowerState": "On",

"ProcessorSummary": {

"Count": 2,

"Model": "Intel(R)?Genuine?processor",

"Status":{

"Health":"OK",

"HealthRollup":"OK",

"State":"Enabled"

"TotalCores": 32,

"TotalThreads": 64

"Processors": {

"@odata.id": "/redfish/v1/Systems/1/Processors"

"SecureBoot": {

"@odata.id": "/redfish/v1/Systems/1/SecureBoot"

"SerialNumber": "12315555777745557765",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Storage": {

"@odata.id": "/redfish/v1/Systems/1/Storages"

"SystemType": "Physical",

"UUID": "00000000-0000-03e2-b211-d21d7029e12c",

"Uptime_hours": "0",

"kvm": {

"@odata.id": "/redfish/v1/Systems/1/kvm"

}

响应码：200

【输出说明】

表4-54 查询系统指定资源信息返回值

字段	类型	字段说明
@odata.context	字符串	指定系统资源模型的OData 描述信息
@odata.id	字符串	指定系统资源的访问路径
@odata.type	字符串	指定系统资源的类型
Actions	Actions指定系统资源可执行的操作
ComputerSystem.Reset	对象	主机重启操作
[email protected]	数组	允许的主机重启操作类型，包括： "On"：上电 "ForceOff"：强制关机 "ForceRestart"：强制重启 "GracefulShutdown"：正常关机 "Nmi"：触发不可屏蔽中断 "ForcePowerCycle"：强制下电再上电
target	字符串	ComputerSystem.Reset系统操作路径
AssetTag	字符串	指定系统资源的资产标签
Bios	对象	Bios资源操作路径
BiosVersion	字符串	BIOS版本信息
Boot	指定系统资源的启动参数
BootSourceOverrideEnabled	字符串	系统启动参数的使能状态，包括： Once：仅生效一次，即下次重启时生效 Continuous：永久有效
[email protected]	数组	系统启动参数的使能状态操作，包括： Once：仅生效一次，即下次重启时生效 Continuous：永久有效
BootSourceOverrideMode	字符串	系统启动模式，包括： “None”，“Legacy”，“UEFI”
[email protected]	数组	支持的启动模式，包括： “None”，“Legacy”，“UEFI”
BootSourceOverrideTarget	字符串	系统启动设备，包括： "None"， "Hdd"， "Pxe"， "BiosSetup"， "Cd"
[email protected]	数组	Redfish 定义的启动设备，包括： "None"， "Hdd"， "Pxe"， "BiosSetup"， "Cd"
ChassisPartNumber	字符串	服务器套餐名
Healthstate	对象	系统健康状态
Healthstate.OverallHealth	字符串	整体健康状态
Healthstate.storage	字符串	存储健康状态，包括存储卡、硬盘、NVMe的健康状态
Healthstate.fans	字符串	风扇健康状态
Healthstate.memory	字符串	内存健康状态
Healthstate.pcie	字符串	PCIe卡健康状态
Healthstate.power	字符串	电压健康状态
Healthstate.processor	字符串	处理器健康状态
Healthstate.temperature	字符串	温度传感器健康状态
Healthstate.board	字符串	系统板卡健康状态
Id	字符串	指定系统资源的 ID
IndicatorLED	字符串	UID灯状态： Lit：常亮； Off：关闭； Blinking：闪烁
Links	关联服务资源
Chassis	对象数组	机箱资源节点的访问路径
ManagedBy	对象数组	管理资源资源节点的访问路径
LogServices	对象	日志服务集合资源节点的访问路径
MaintenanceSerialNumber	字符串	生产序列号
Manufacturer	字符串	生产厂商
Memory	对象	内存资源节点的访问路径
Model	字符串	产品型号
Name	字符串	系统资源信息名称
NetworkInterfaces	对象	网络接口资源节点的访问路径
Oem.Public.PowerOnStrategy	字符串	通电开机策略： TurnOn：保持上电RestorePreviousState：与之前保持一致StayOff：保持下电
Oem.Public.BiosVendor	字符串	指定系统资源的BIOS软件厂商
Oem.Public.IndependentPowerSupply	布尔型	标准PCIe Slot是否支持独立供电，目前就R5300 G3/5支持
PartNumber	字符串	产品部件号
PowerState	字符串	上电状态： On Off
Processors	对象	处理器资源节点访问路径
SerialNumber	字符串	产品序列号
SecureBoot	对象	SecureBoot资源节点的访问路径【当前未实现】
Status	对象	指定系统资源的状态，包括： Health：系统资源健康状态 State：系统资源使能状态
Storages	对象	存储资源节点的访问路径
SystemType	字符串	系统类型： "Physical" "Virtual"
UUID	字符串	设备的全局唯一标识符
Uptime_hours	字符串	主机上电时间
kvm	对象	KVM资源节点的访问路径
HostName	字符串	指定系统资源的主机名
PCIeDevices	对象	PCIe设备资源节点的访问路径
PCIeFunctions	对象	PCIe功能资源节点的访问路径
MemorySummary.TotalSystemMemoryGiB	数值	统总内存容量，单位GB
MemorySummary.Status.Health	字符串	系统当前内存的健康状态
MemorySummary.Status.State	字符串	系统当前内存的使能状态
MemorySummary.Status.HealthRollup	字符串	系统当前内存的健康状态
MemorySummary.Count	字符串	系统当前所接内存个数
ProcessorSummary.Count	数值	系统当前所接CPU个数
ProcessorSummary.Status.Health	字符串	系统当前CPU的健康状态
ProcessorSummary.Status.State	字符串	系统当前CPU的使能状态
ProcessorSummary.Status.HealthRollup	字符串	系统当前CPU的健康状态
ProcessorSummary.Model	字符串	系统第一个CPU的型号
ProcessorSummary.TotalCores	数值	系统所有CPU的总核数
ProcessorSummary.TotalThreads	数值	系统所有CPU的总线程数

【修改记录】

(1) HDM-1.11.30启动设备修改："None"， "Hdd"， "Pxe"，"BiosSetup"， "Cd"

(2) HDM-1.30.06 新增字段Oem.Public.PowerOnStrategy

(3) HDM-1.30.07 新增字段SerialNumber

(4) HDM-1.30.09 增加字段 HostName, PCIeDevices, PCIeFunctions, MemorySummary, ProcessorSummary

(5) HDM-1.30.11 字段Healthstate 增加raid的健康状态显示

(6) HDM-1.30.12 字段字段BootSourceOverrideEnabled、[email protected]删除Disabled选项；字段BootSourceOverrideMode、[email protected]，新增选项"None"

(7) HDM-1.30.14字段Healthstate 增加pcie、board的健康状态显示

(8) HDM-1.30.15P02新增字段Oem.Public.BiosVendor，未合B03主线，合入B05

(9) HDM-1.30.18SP91新增字段ProcessorSummary.{Status.Health, Status.State,Status.HealthRollup,Model，TotalCores,TotalThreads};MemorySummary.{Status.Health, Status.State,Status.HealthRollup,Count}

(10) (仅)HDM-1.30.18P5x,B05：字段AssetTag、HostName的支持长度修改为1~48

(11) HDM-2.0.07 字段Healthstate 增加HostSystem的健康状态显示

(12) HDM-2.13.00:参考web优化，重新组织Healthstate的返回值，删除current、disk、volatge、raid、HostSystem，新增storage

(13) HDM-2.93：新增字段Oem.Public.IndependentPowerSupply

(14) HDM-3.34：新增字段ChassisPartNumber

4.3.3 修改指定系统资源属性

【功能描述】

修改指定系统资源属性。

使用说明：

(1) BootSourceOverrideEnabled, BootSourceOverrideMode, BootSourceOverrideTarget三个参数需要一起下发。

(2) 当设置永久启动时，BootSourceOverrideMode, BootSourceOverrideTarget不能同时为None。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"AssetTag": "test_123",

"HostName": "123",

"Boot": {

"BootSourceOverrideMode": mode,

"BootSourceOverrideTarget": target

"BootSourceOverrideEnabled": enable

}

【参数说明】

表4-55 修改指定系统资源属性选项参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
AssetTag	资产标签	字符串，长度：1~48 null，设置为空
HostName	主机名	字符串，长度：1~63
Boot.BootSourceOverrideMode	下次启动模式	支持： "None"、"UEFI"、"Legacy"
Boot.BootSourceOverrideTarget	下次启动设备	支持： "None" "Pxe" "Hdd" "Cd" "BiosSetup"(BootSourceOverrideEnabled字段为Once时有效)
Boot.BootSourceOverrideEnabled	启动设置有效期	支持："Once"、 "Continuous" (G3刀箱产品不支持Continuous设置，G5都支持)

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/system_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"AssetTag": "test_123",

"HostName": "HDM12315555777745557765",

"Boot": {

"BootSourceOverrideMode": "UEFI",

"BootSourceOverrideTarget": "Pxe",

"BootSourceOverrideEnabled": "Once"

}

【返回样例】

{

"@odata.context": "/redfish/v1/$metadata#ComputerSystem.ComputerSystem(*)",

"@odata.id": "/redfish/v1/Systems/1",

"@odata.type": "#ComputerSystem.v1_5_0.ComputerSystem",

"Actions": {

"#ComputerSystem.Reset": {

"On",

"ForceOff",

"ForceRestart",

"GracefulShutdown"

"Nmi",

"ForcePowerCycle"

"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset"

}

"AssetTag": "ZB17-01-Unis Huashan 20110228",

"Bios": {

"@odata.id": "/redfish/v1/Systems/1/Bios"

"BiosVersion": "2.00.30 V100R001B02D030",

"Boot": {

"BootSourceOverrideEnabled": "Once",

"Once",

"Continuous"

"BootSourceOverrideMode": "Legacy",

"None",

"Legacy",

"UEFI"

"BootSourceOverrideTarget": "None",

"None",

"Pxe",

"Hdd",

"Cd",

"BiosSetup"

"Description": "System 1",

"Healthstate": {

"OverallHealth": "Critical",

"board": "OK",

"fans": "OK",

"memory": "OK",

"pcie": "OK",

"power": "OK",

"processor": "OK",

"storage": "Critical",

"temperature": "OK"

"HostName": "HDM12315555777745557765",

"Id": "1",

"IndicatorLED": "Off",

"Links": {

"Chassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagedBy": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Systems/1/LogServices"

"Maintenance serial number": "210231A1110000000001",

"Manufacturer": "H3C",

"Memory": {

"@odata.id": "/redfish/v1/Systems/1/Memory"

"MemorySummary": {

"TotalSystemMemoryGiB": 4

"Model": "RS33M2C9S",

"Name": "Computer System",

"NetworkInterfaces": {

"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces"

"Oem": {

"Public": {

"PowerOnStrategy": "RestorePreviousState"

}

"PCIeDevices": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0"

}

"PCIeFunctions": [

{

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/0/Functions/1"

}

"PartNumber": "",

"PowerState": "On",

"ProcessorSummary": {

"Count": 2

"Processors": {

"@odata.id": "/redfish/v1/Systems/1/Processors"

"SecureBoot": {

"@odata.id": "/redfish/v1/Systems/1/SecureBoot"

"SerialNumber": "12315555777745557765",

"Status": {

"Health": "Warning",

"State": "Enabled"

"Storage": {

"@odata.id": "/redfish/v1/Systems/1/Storages"

"SystemType": "Physical",

"UUID": "00000000-0000-03e2-b211-d21d7029e12c",

"Uptime_hours": "0",

"kvm": {

"@odata.id": "/redfish/v1/Systems/1/kvm"

}

响应码：200

【输出说明】

输出字段说明同【查询指定系统资源信息】

【修改记录】

(1) HDM-1.30.09接口新增

(2) HDM-1.30.11新增字段BootSourceOverrideEnabled

(3) HDM-1.30.12 字段字段Boot.BootSourceOverrideEnabled删除Disabled选项；字段Boot.BootSourceOverrideMode，新增选项"None"

(4) (仅)HDM-1.30.18P5x,B05：字段AssetTag、HostName的支持长度修改为1~48

(5) HDM-2.26：添加限制BootSourceOverrideMode、BootSourceOverrideTarget不能同时为None，以和web保持一致

(6) HDM-2.97：HostName的支持长度修改为1~63

4.3.4 服务器电源操作

【功能描述】

服务器电源进行操作，包括上电、强制下电、正常关机、强制重启等

【所属权限模块】

电源控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Actions/ComputerSystem.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType": state

}

【参数说明】

表4-56 服务器电源操作参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
ResetType	操作类型	· On：上电 · ForceOff：强制下电 · GracefulShutdown：正常关机 · ForceRestart：强制重启 · Nmi：触发不可屏蔽中断 · ForcePowerCycle：强制下电再上电

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Actions/ComputerSystem.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType": "GracefulShutdown"

}

【应答示例】

响应码：200

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. SeeExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type":"/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId":"Base.1.0.Success",

"RelatedProperties": [],

"Message": "SuccessfullyCompleted Request",

"MessageArgs": [],

"Severity": "OK",

"Resolution":"None"

}

]

}

【输出说明】

返回状态码200，表示操作成功。

【修改历史】

(1) 仅HDM-1.30.18P5X,B05：返回值新增字段RelatedProperties和MessageArgs

(2) 仅HDM-1.30.18P5X,B05：字段ResetType，新增参数值Nmi和ForcePowerCycle

4.3.5 查询CPU列表

【功能描述】

查询CPU列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-57 查询CPU列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#ProcessorCollection.ProcessorCollection",

"@odata.id": "/redfish/v1/Systems/1/Processors",

"@odata.type": "#ProcessorCollection.ProcessorCollection",

"Description": "Collection of processors for this system",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Processors/1"

{

"@odata.id": "/redfish/v1/Systems/1/Processors/2"

}

"Name": "Processors Collection",

"Oem": {

"Public": {

"CpuUsageRatePercent": 60

}

返回码200

【输出说明】

返回状态码200，表示操作成功。

表4-58 查询CPU列表信息返回值

字段	类型	字段说明
@odata.context	字符串	CPU列表资源模型的OData 描述信息
@odata.id	字符串	CPU列表资源的访问路径
@odata.type	字符串	CPU列表资源的类型
Description	字符串	CPU列表资源的描述信息
Members	数组	CPU查询路径
[email protected]	数值	CPU个数
Name	字符串	CPU资源信息名称
Oem.Public.CpuUsageRatePercent	数值	CPU使用率，范围：0~100（需安装FIST SMS才能正确显示使用率）获取失败返回为null

【修改记录】

(1) HDM-1.30.07：新增字段Oem.Public.CpuUsageRate(%)

(2) HDM-1.30.09：字段CpuUsageRate(%)名称修改为CpuUsageRatePercent

4.3.6 设置CPU占用率警告门限

【功能描述】

设置CPU占用率警告门限。

注：该接口不支持If-Match检查

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/ Systems/system_id/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Public":{

"UsageAlarmThreshold":value

}

【参数说明】

表4-59 设置CPU占用率警告门限选项参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
Oem.Public. UsageAlarmThreshold	数字	CPU使用率告警门限，0~100

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Processors

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Public":{

"UsageAlarmThreshold":75

}

【响应示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/Processors",

"Oem": {

"Public": {

"UsageAlarmThreshold": 75

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

【修改记录】

(1) HDM-1.30.07 接口新增

(2) HDM-1.30.09 返回码修改成200

4.3.7 查询指定CPU信息

【功能描述】

查询指定的CPU信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Processors/cpu_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【参数说明】

表4-60 查询CPU信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
cpu _id	CPU ID	由CPU集合中查询

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Processor.Processor(*)",

"@odata.id": "/redfish/v1/Systems/1/Processors/1",

"@odata.type": "#Processor.v1_3_0.Processor",

"Id": "1",

"InstructionSet": "x86-64",

"Manufacturer": "Intel(R) Corporation",

"MaxSpeedMHz": 3350,

"Model": "Intel(R) Genuine processor",

"Name": "CPU1",

"Oem": {

"Public": {

"L1CacheKiB": 1024,

"L2CacheKiB": 16384,

"L3CacheKiB": 22528,

"SerialNumber": "15-14-15-AD-95-11-69-A4", //Intel示例

"SerialNumber": "66CE9206611F", //海光示例

"Temperature": 61,

"FrequencyMHz": 2000

}

"Ppin": "15-14-15-AD-95-11-69-A4", //Intel示例

"Ppin": "N/A", //海光示例

"ProcessorArchitecture": "x86",

"ProcessorId": {

"IdentificationRegisters": "00-00-00-00-00-00-00-00"

"ProcessorType": "CPU",

"Socket": 1,

"Status": {

"Health": "OK",

"State": "Enabled"

"TotalCores": 16,

"TotalThreads": 32

}

【输出说明】

表4-61 查询CPU信息返回值

字段	类型	字段说明
@odata.context	字符串	指定CPU资源模型的OData 描述信息
@odata.id	字符串	指定CPU资源的访问路径
@odata.type	字符串	指定CPU资源的类型
Id	字符串	ID号
InstructionSet	字符串	指令集
Manufacturer	字符串	CPU厂商名称
MaxSpeedMHz	数值	CPU最大频率，(intel:睿频)
Model	字符串	CPU型号
Name	字符串	CPU名称
ProcessorType	字符串	指定 CPU 资源的类型 CPU;GPU;FPGA;DSP;Accelerator;OEM
Socket	数值	指定 CPU 资源的插槽号
Status.Health	字符串	指定CPU资源的健康状态
Status.State	字符串	指定CPU资源的使能状态
TotalCores	数值	总核数
TotalThreads	数值	总线程数
Oem.Public.L1CacheKiB	数值	L1缓存大小
Oem.Public.L2CacheKiB	数值	L2缓存大小
Oem.Public.L3CacheKiB	数值	L3缓存大小
Oem.Public.SerialNumber	字符串	CPU序列号
Oem.Public.Temperature	数值	CPU温度
Oem.Public.FrequencyMHz	数值	CPU基频
Ppin	字符串	Protected Processor Inventory Number
ProcessorArchitecture	字符串	CPU架构
ProcessorId	对象	指定CPU资源的Processor ID信息

【修改记录】

(1) HDM-1.30.08：增加字段PPIN

(2) HDM-1.30.09：增加字段Oem.Public.Temperature，PPIN字段删除

(3) HDM-1.30.10：增加字段Ppin(但功能暂未实现)

(4) HDM-1.30.11：字段ProcessorArchitecture，返回值"x86"修改成"x86_64"；字段Socket返回类型从字符串修改成数值；Ppin功能实现

(5) HDM-1.30.13：增加字段Oem.Public.FrequencyMHz;

(6) HDM-1.30.14：字段ProcessorArchitecture，返回值"x86_64"修改成"x86"

(7) HDM-1.30.15P02：新增字段Oem.Public.SerialNumber

(8) HDM-6.13：针对海光CPU刷新SerialNumber与PPIN的示例

4.3.8 查询内存列表

【功能描述】

查询内存列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Memory

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-62 查询内存列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Memory

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#MemoryCollection.MemoryCollection",

"@odata.id": "/redfish/v1/Systems/1/Memory",

"@odata.type": "#MemoryCollection.MemoryCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110"

{

"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM210"

}

GET https://device_ip/redfish/v1/Systems/system_id/Storages

"Name": "Memory Collection",

"Oem": {

"Public": {

"PowerWatts": "null"

}

响应码：200

【输出说明】

表4-63 查询内存列表信息返回值

字段	类型	字段说明
@odata.context	字符串	内存集合资源模型的OData 描述信息
@odata.id	字符串	内存集合资源的访问路径
@odata.type	字符串	内存集合资源的类型
Members	数组	内存资源列表
[email protected]	数值	内存资源数量
Name	字符串	内存集合资源的名称
Oem.Public.PowerWatts	字符串	内存功耗，不支持显示null

4.3.9 查询指定内存条信息

【功能描述】

查询指定内存信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Memory/memory_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-64 查询内存信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
memory_id	内存ID	由内存集合中查询

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Memory/DIMM110

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Memory.Memory(*)",

"@odata.id": "/redfish/v1/Systems/1/Memory/DIMM110",

"@odata.type": "#Memory.v1_5_0.Memory",

"BaseModuleType": "RDIMM",

"CapacityMiB": 8192,

"DataWidthBits": 0,

"DeviceLocator": "CPU1CH1A1",

"ErrorCorrection": "SingleBitECC",

"Id": "DIMM110",

"IsRankSpareEnabled": false,

"IsSpareDeviceEnabled": false,

"Manufacturer": "Hynix Semiconductor",

"MemoryDeviceType": "DDR4",

"MemoryLocation": {

"Channel": 1,

"Controller": 0,

"Slot": 0,

"Socket": 1

"Name": "DIMM110",

"Oem": {

"Public": {

"Authenticity": "Vendor certified",

"Model": "HMA81GR7AFR8N-VK",

"Technology": "RDIMM",

"VDDQVolt": "1.2 V"

}

"OperatingSpeedMhz": 2666,

"PartNumber": "HMA81GR7AFR8N-VK",

"PowerManagementPolicy": {

"PolicyEnabled": false

"RankCount": 1,

"SecurityCapabilities": {

"PassphraseCapable": false

"SerialNumber": "325C8E63",

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【输出说明】

表4-65 查询内存信息返回值

字段	类型	字段说明
@odata.context	字符串	指定内存资源模型的OData 描述信息
@odata.id	字符串	指定内存资源的访问路径
@odata.type	字符串	指定内存资源的类型
BaseModuleType	字符串	指定内存资源基本模块类型
DeviceLocator	字符串	指定内存丝印
CapacityMiB	数值	指定内存的容量，单位为MiB
DataWidthBits	数值	指定内存资源的数据带宽
ErrorCorrection	字符串	错误纠正，多字节纠正MultiBitECC
Id	字符串	ID号
IsRankSpareEnabled	布尔型	备用Rank使能(未实现，固定false)
IsSpareDeviceEnabled	布尔型	备用设备使能
MemoryDeviceType	字符串	内存类型，有： DDR3，DDR4，SDRAM…
MemoryLocation.Channel	数值	指定内存资源的通道号
MemoryLocation.Slot	数值	指定内存资源的槽位号(DIMM号)
MemoryLocation.Controller	数值	指定内存资源的控制器编号
MemoryLocation.Socket	数值	指定内存资源所属CPU槽位号
Oem.Public.Authenticity	字符串	内存认证： Vendor certified：厂家已经过认证 Normal：厂家未经过认证
Oem.Public.Model	字符串	指定内存资源的型号
Oem.Public.Technology	字符串	内存技术： RDIMM UDIMM SODIMM LRDIMM NVDIMM
Oem.Public.VDDQVolt	字符串	内存电压值
Name	字符串	名称
OperatingSpeedMhz	数值	指定内存资源的最大频率
PartNumber	字符串	部件号
PowerManagementPolicy.PolicyEnabled	布尔型	电源管理策略使能
RankCount	数值	Rank个数
SecurityCapabilities.PassphraseCapable	布尔型	支持安全加密功能
SerialNumber	字符串	指定内存序列号
Status.Health	字符串	指定内存资源的健康状态
Status.State	字符串	指定内存资源的使能状态
Manufacturer	字符串	厂商名称

【修改记录】

(1) HDM-1.11.29版本使用Manufacturer替代VendorID

(2) HDM-1.30.08增加字段SerialNumber

(3) HDM-1.30.09增加字段BaseModuleType、DeviceLocator、Oem.Public.Authenticity，字段SerialNumber删除

(4) HDM-1.30.10字段DeviceLocator值内容修改，格式如从”A1”修改成”CPU1A1”

(5) HDM-1.30.13字段增加SerialNumber

(6) HDM-1.30.15P02新增字段Oem.Public.Model，合入B05

(7) 仅HDM-1.30.18P5X,B05：字段MemoryLocation.Slot类型由字符串修改成数值

(8) HDM-1.30.19 新增字段MemoryLocation.Controller

(9) HDM-3.35 新增字段DataWidthBits

(10) HDM-6.14.01 内存的容量单位改成MiB

4.3.10 查询RAID卡列表

【功能描述】

查询RAID卡列表。

【所属权限模块】

查询模块

【命令格式】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-66 查询RAID卡列表参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	Ipv4或Ipv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#StorageCollection.StorageCollection",

"@odata.id": "/redfish/v1/Systems/1/Storages",

"@odata.type": "#StorageCollection.StorageCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0"

}

"Name": "Storage Collection"

}

响应码：200

【输出说明】

表4-67 查询RAID卡列表信息参数说明

字段	类型	字段说明
@odata.context	字符串	RAID卡列表资源模型的Odata 描述信息
@odata.id	字符串	RAID卡列表资源的访问路径
@odata.type	字符串	RAID卡列表资源的类型
Members	数组	RAID卡信息查询路径列表
[email protected]	数值	当前存储资源数量
Name	字符串	RAID卡列表资源的名称

【修改记录】

(1) HDM-1.11.27及以前版本路径为https://device_ip/redfish/v1/Systems/system_id/Storage

4.3.11 查询指定RAID卡信息

【功能描述】

查询指定的RAID卡信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-68 查询RAID卡信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
raid_id	RAID卡ID	由RAID卡集合中查询

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0",

"@odata.type": "#Storage.v1_4_0.Storage",

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront10"

}

"Id": "RAIDStorage0",

"Name": "RAIDStorage0",

"StorageControllers": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0#/StorageControllers/0",

"AssetTag": "RAID-LSI-9361-8i(2G)-1-X",

"CardManufacturer": "Broadcom",

"CardModel": "RAID-LSI-9361-8i(2G)-1-X",

"FirmwareVersion": "4.680.00-8442",

"Manufacturer": "LSI",

"MemberId": "0",

"Model": "RAID-LSI-9361-8i(2G)-1-X",

"Name": "RAID-LSI-9361-8i(2G)-1-X",

"Oem": {

"Public": {

"BBUstate": "Miss",

"ConfigurationVersion": "3.1705.00-0018",

"DDRECCCount": 0,

"ExternalPortCount": null,

"InternalPortCount": 8,

"JBODState": true,

"MaintainPDFailHistory": true,

"MaxStripeSizeBytes": 1048576,

"MinStripeSizeBytes": 65536,

"MemorySizeMiB": 2048,

"Mode": "RAID",

"PackageVersion": "50.1.0-0501",

"PatrolReadConfig": {

"CompletedCounts": 0,

"DelayToStart": "1/12/2021 ; 22:46:29",

"OperationMode": "Auto",

"PeriodOfHours": 3,

"RunningStatus": "Stopped",

"SupportSSD": "Enabled",

"TotalCounts": 64

"SASAddress": "null",

"CapacitanceStatus": {

"State": "Enabled",

"Health": "OK"

"SupportedRAIDLevels": [

"RAID0",

"RAID1",

"RAID5",

"RAID6",

"RAID10",

"RAID50",

"RAID60"

]

"TemperatureCelsius": 44,

"VolumeConsistencyCheckConfig": {

"CompletedVolumeCounts": 1,

"DelayToStart": "1/13/2021 ; 0:42:40",

"OperationMode": "Sequential",

"PeriodOfHours": 5,

"RunningStatus": "Stopped",

"TotalVolumeCounts": 1

}

"SmarterCopyBackState": false,

}

"SerialNumber": "SK92066892",

"SpeedGbps": 12,

"Status": {

"Health": "OK",

"State": "Enabled"

"SupportedDeviceProtocols": [

"SAS"

]

}

"Oem": {

"Public": {

"AssociatedCard": {

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/3

}

"Volumes": {

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes"

}

响应码：200

【输出说明】

表4-69 查询RAID卡信息返回值

字段	类型	字段说明
@odata.context	字符串	指定RAID卡资源模型的OData 描述信息
@odata.id	字符串	指定RAID卡资源的访问路径
@odata.type	字符串	指定RAID卡资源的类型
Drives	数组	物理盘资源访问集合
[email protected]	数值	物理盘资源数量
Id	字符串	指定存储资源的 ID
Name	字符串	指定存储资源的名称
StorageControllers.Model	字符串	指定RAID卡型号
StorageControllers.AssetTag	字符串	资产标签
StorageControllers.FirmwareVersion	字符串	固件版本
StorageControllers.Manufacturer	字符串	厂商
StorageControllers. CardManufacturer	字符串	指定存储控制器的型号，如： 9460-16i
StorageControllers.CardModel	字符串	指定存储控制器的生产厂商，如： Broadcom Microchip 3SNIC
StorageControllers.Name	字符串	RAID卡名称
StorageControllers.Oem.Public.MemorySizeMiB	数值	缓存大小，单位MiB
StorageControllers.Oem.Public.BBUstate	字符串	超级电容状态，不支持显示null
StorageControllers.Oem.Public.JBODState	布尔型	JBOD状态
StorageControllers.Oem.Public.SupportedRAIDLevels	数组	所支持raid级别
StorageControllers.Oem.Public.PackageVersion	字符串	LSI卡的PackageVersion
StorageControllers.Oem.Public.Mode	字符串	控制卡模式： Non-RAID RAID HBA Mixed JBOD SimpleVolume AutoVolume
StorageControllers.Oem.Public.ConfigurationVersion	字符串	控制卡配置版本
StorageControllers.Oem.Public.SASAddress	字符串	指定存储控制器地址，没有显示null
StorageControllers.Oem.Public.CapacitanceStatus	对象	指定存储控制器电容(BBU)状态，包括： · Health：存储控制器健康状态 · State：存储控制器使能状态： "Enabled"：设备使能 "Disabled"：不在位
StorageControllers.Oem.Public.AssociatedCard	对象	关联卡路径信息
StorageControllers.Oem.Public.TemperatureCelsius	数值	控制卡温度
StorageControllers.SerialNumber	字符串	序列号，没有显示null
StorageControllers.SpeedGbps	数值	接口速率
StorageControllers.Status.Health	字符串	控制器健康状态
StorageControllers.Status.State	字符串	控制器使能状态
StorageControllers.SupportedDeviceProtocols	数组	控制器支持协议
[email protected]	数值	存储控制器管理的驱动器个数
Volumes	字符串	逻辑盘查询路径
StorageControllers.Oem.Public.MaintainPDFailHistory	布尔型	指定存储驱动器故障记录功能的使能状态, 有些卡不支持该功能,需要处理成null
StorageControllers.Oem.Public.CopyBackState	布尔型	指定存储控制器回拷功能使能状态
StorageControllers.Oem.Public.MaxStripeSizeBytes	数值	控制器支持最大条带值
StorageControllers.Oem.Public.MinStripeSizeBytes	数值	控制器支持最小条带值
StorageControllers.Oem.Public.DDRECCCount	数值	指定存储控制器内存可纠错错误计数
StorageControllers.Oem.Public.PatrolReadConfig.OperationMode	字符串	操作模式 Auto :自动 Manual：手动 Disabled: 关闭不支持时，显示null
StorageControllers.Oem.Public.PatrolReadConfig.PeriodOfHours	数值	PR运行周期不支持时，显示null
StorageControllers.Oem.Public.PatrolReadConfig.RunningStatus	字符串	PR运行状态 Stopped：未开始 Ready：即将开始 Active：正在进行 Paused：暂停 Aborted：终止不支持时，显示null
StorageControllers.Oem.Public.PatrolReadConfig.TotalCounts	数值	能够同时进行PR的硬盘总数不支持时，显示null
StorageControllers.Oem.Public.PatrolReadConfig.CompletedCounts	数值	本次已完成PR的硬盘总数不支持时，显示null
StorageControllers.Oem.Public.PatrolReadConfig.DelayToStart	字符串	下次启动的时间不支持时，显示null
StorageControllers.Oem.Public.PatrolReadConfig.SupportSSD	字符串	PR是否支持SSD Enable：支持SSD Disable：不支持SSD OnlyMixed：不支持SSD 不支持时，显示null
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.OperationMode	字符串	操作模式 Disable：关闭cc Sequential：逻辑盘顺序执行cc Concurrent：卡下所有逻辑盘同时执行cc 不支持时，显示null
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.PeriodOfHours	数值	一致性校验周期不支持时，显示null
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.RunningStatus	字符串	cc运行状态 Stopped：未开始 Ready：即将开始 Active：正在进行 Aborted：终止不支持时，显示null
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.TotalVolumeCounts	数值	能够同时进行cc的逻辑盘总数不支持时，显示null
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.CompletedVolumeCounts	数值	已完成cc的逻辑盘总数不支持时，显示null
StorageControllers.Oem.Public.VolumeConsistencyCheckConfig.DelayToStart	字符串	下次启动的时间（操作模式为Disable时不显示）不支持时，显示null
StorageControllers.Oem.Public.SmarterCopyBackState	布尔型	SMART错误回拷状态
StorageControllers.Oem.Public.InternalPortCount	数值	内部端口数量不支持时，显示null
StorageControllers.Oem.Public.ExternalPortCount	数值	外部端口数量不支持时，显示null

【修改记录】

(1) HDM-1.11.27及以前版本路径为https://device_ip/redfish/v1/Systems/system_id/Storage/raid_id

(2) HDM-1.30.09删除字段Link

(3)HDM-1.30.10：新增字段Model, StorageControllers.SpeedGbps,StorageControllers.SupportedDeviceProtocols

(4)HDM-1.30.11 字段MemorySize名称修改为MemorySizeMiB，且返回值类型为数值；新增字段StorageControllers.Oem.Public.SASAddress

(5) 仅HDM-1.30.18P5X版本,B05：StorageControllers.Oem.Public.JBODState类型修改成布尔型

(7) HDM-2.0.03版本：新增字段StorageControllers.Oem.Public.{Mode,ConfigurationVersion}

(8) HDM-2.0.10：新增字段Oem.Public.AssociatedCard

(9) HDM-2.10.00：新增字段StorageControllers.Oem.Public.PackageVersion

(10) HDM-2.11.92：新增字段StorageControllers.Oem.Public.CapacitanceStatus

(11) HDM-2.33：控制卡模式新增JBOD,SimpleVolume,AutoVolume

(12) HDM-2.93: 新增字段Oem.Public.{DDRECCCount,MaintainPDFailHistory,MaxStripeSizeBytes,MinStripeSizeBytes, CopyBackState}

(13) HDM-2.93: 新增字段StorageControllers.Oem.Public.TemperatureCelsius

(14) HDM-6.05：新增字段：StorageControllers.Oem.Public.PatrolReadConfig下的OperationMode、PeriodOfHours、RunningStatus、TotalCounts、CompletedCounts、DelayToStart、SupportSSD；StorageControllers.Oem.Public. VolumeConsistencyCheckConfig下的OperationMode、PeriodOfHours、RunningStatus、TotalVolumeCounts、CompletedVolumeCounts、DelayToStart

(15) HDM-6.06：新增字段：StorageControllers.Oem.Public.SmarterCopyBackState

(16) HDM-6.08：新增字段：StorageControllers.Oem.Public.InternalPortCount、StorageControllers.Oem.Public.ExternalPortCount

(17) HDM-6.08：新增字段：StorageControllers. CardManufacturer、StorageControllers.CardModel

4.3.12 修改指定RAID卡信息

修改指定RAID卡属性

【功能描述】

修改指定RAID卡属性。仅实现LSI 9460-8i，9560-8i卡的相关功能，其他卡不涉及。

说明：因为阵列卡修改策略需要一定时间，所以返回体是未修改前的策略信息。

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"StorageControllers"：[{

"Oem":{

"Public": {

"VolumeConsistencyCheckConfig": {

"OperationMode": OperationMode,

"PeriodOfHours": PeriodOfHours,

"DelayToStart": DelayToStart

"PatrolReadConfig": {

"SupportSSD": SupportSSD,

"OperationMode": OperationMode,

"PeriodOfHours": PeriodOfHours,

"DelayToStart": DelayToStart

"CopyBackState":cb_state,

"SmarterCopyBackState":smartcb_state,

"JBODState": jbod_state,

"Mode":"mode",

}

}]

}

【所属权限模块】

远程控制

【参数说明】

表4-70 修改指定RAID卡属性参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
raid_id	RAID卡ID	由RAID卡集合中查询
VolumeConsistencyCheckConfig. OperationMode	字符串	操作模式 Disable：关闭cc Sequential：逻辑盘顺序执行cc Concurrent：卡下所有逻辑盘同时执行cc。
VolumeConsistencyCheckConfig. PeriodOfHours	数值	一致性校验周期。（单位：小时；可设置范围1~8640）
VolumeConsistencyCheckConfig. DelayToStart	数值	本次CC推迟多长时间启动（单位：分钟；可设置范围0~43200）
PatrolReadConfig.SupportSSD	字符串	PR是否支持SSD Enable：支持SSD Disable：不支持SSD
PatrolReadConfig.OperationMode	字符串	操作模式 Disable：关闭PR。 Enable：开启PR。关闭PR时，不需要附加其他参数
PatrolReadConfig.PeriodOfHours	数值	PR运行周期。（单位：小时。整数；可设置范围：1~8640）
PatrolReadConfig.DelayToStart	数值	本次PR推迟多长时间启动（单位：分钟。整数；可设置范围：0~43200）
CopyBackState	布尔型	回拷使能状态 (仅LSI卡MR支持) true false
SmarterCopyBackState	布尔型	SMART错误回拷使能状态 (仅LSI卡MR支持) true false
JBODState	布尔型	JBOD使能状态 (仅LSI卡MR支持) true false
Mode	字符串	存储控制器的模式 RAID HBA Mixed JBOD

【使用实例】

【请求样例】

PATCH https://172.14.33.150/redfish/v1/Systems/1/Storages/RAIDStorage2

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"StorageControllers":[

{

"Oem":{

"Public":{

"VolumeConsistencyCheckConfig": {

"OperationMode":"Sequential",

"PeriodOfHours":5,

"DelayToStart":0

"PatrolReadConfig": {

"SupportSSD":"Enable",

"OperationMode":"Enable",

"PeriodOfHours":3,

"DelayToStart":4

"CopyBackState":false,

"SmarterCopyBackState":false,

"JBODState": false,

"Mode":"RAID"

}

]

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Storage.Storage(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage2",

"@odata.type": "#Storage.v1_4_0.Storage",

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskRear30"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskRear31"

}

"Id": "RAIDStorage2",

"Name": "RAIDStorage2",

"StorageControllers": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage2#/StorageControllers/2",

"AssetTag": "RAID-LSI-9460-8i(2G)",

"FirmwareVersion": "5.160.00-3415",

"Manufacturer": "Broadcom",

"MemberId": "2",

"Model": "RAID-LSI-9460-8i(2G)",

"Name": "RAID-LSI-9460-8i(2G)",

"Oem": {

"Public": {

"AssociatedCard": {

"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/2"

"BBUstate": "Miss",

"CapacitanceStatus": {

"Health": null,

"State": "Disabled"

"ConfigurationVersion": "5.1600.00-0006",

"CopyBackState": true,

"DDRECCCount": 0,

"JBODState": true,

"MaintainPDFailHistory": true,

"MaxStripeSizeBytes": 1048576,

"MemorySizeMiB": 2048,

"MinStripeSizeBytes": 65536,

"Mode": "RAID",

"PackageVersion": "51.16.0-3804",

"PatrolReadConfig": {

"CompletedCounts": 0,

"DelayToStart": "1/12/2021 ; 22:46:29",

"OperationMode": "Auto",

"PeriodOfHours": 3,

"RunningStatus": "Stopped",

"SupportSSD": "Enabled",

"TotalCounts": 64

"SASAddress": "500062B20791F080",

"SupportedRAIDLevels": [

"RAID0",

"RAID1",

"RAID5",

"RAID6",

"RAID10",

"RAID50",

"RAID60"

"TemperatureCelsius": 61,

"VolumeConsistencyCheckConfig": {

"CompletedVolumeCounts": 1,

"DelayToStart": "1/13/2021 ; 0:42:40",

"OperationMode": "Sequential",

"PeriodOfHours": 5,

"RunningStatus": "Stopped",

"TotalVolumeCounts": 1

}

"SerialNumber": "SPB2200215",

"SpeedGbps": 12,

"Status": {

"Health": "OK",

"State": "Enabled"

"SupportedDeviceProtocols": [

"SAS"

]

}

"Volumes": {

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage2/Volumes"

}

【输出说明】

返回状态码200，表示操作成功。返回体同【查询指定RAID卡信息】

说明：因为阵列卡修改策略需要一定时间，所以返回体是未修改前的策略信息。

【修改记录】

(1) HDM-6.05，接口新增

(2) HDM-6.06：增加设置项CopyBackState, SmarterCopyBackState, JBODState, Mode

4.3.13 查询逻辑盘列表

【功能描述】

查询逻辑盘列表信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages/RAIDStorage_id/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-71 查询逻辑盘列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
RAIDStorage_id	RAID卡的ID	数值

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#VolumeCollection.VolumeCollection",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes",

"@odata.type": "#VolumeCollection.VolumeCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0"

}

PATCH https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

"Name": "Volume Collection"

}

响应码：200

【输出说明】

表4-72 查询逻辑盘列表信息返回值

字段	类型	字段说明
@odata.context	字符串	逻辑盘集合资源模型的OData 描述信息
@odata.id	字符串	逻辑盘集合资源的访问路径
@odata.type	字符串	逻辑盘集合资源的类型
Members	数组	逻辑盘查询路径
[email protected]	数值	逻辑盘个数
Name	字符串	逻辑盘集合资源的名称

【修改记录】

(1) HDM-1.11.27及以前版本路径为https://device_ip/redfish/v1/Systems/system_id/Storage/RAIDStorage0/Volumes

4.3.14 创建逻辑盘

【功能描述】

创建逻辑盘。

【所属权限模块】

远程控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Name":name,

"InitState": initstate,

"StripSize":stripsize,

"Level": raid_level,

"SpanNum": spanname,

"NumDrives": num_drives,

"ReadPolicy": read_policy,

"WritePolicy": write_policy,

"IOPolicy": io_policy,

"DriveCache": drive_cache_policy,

"AccessPolicy": access_policy,

"Size": size,

"SizeUnit": unit,

"AccelerationMethod": acceleration,

"PhysicalDiskList":

[{

"group_id":group_id,

"id":connnection_id

...

]

}

【支持卡说明】

LSI卡：9361，9440，9460，L460，P5408，H5408

PMC卡：H460，P460，且需支持MCTP

【参数说明】

表4-73 创建逻辑盘信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
Name	逻辑盘名称	字符串
InitState	初始化类型	初始化类型： No：不进行初始化 Fast：快速初始化 Full：完全初始化说明：PMC卡当前不支持；
StripSize	条带大小	说明： 1、 LSI 9440只支持"64KB" 2、 LSI 9361和LSI 9460支持"64KB"、"128KB"、"256KB"、"512KB"、"1MB" 3、 PMC卡支持"16KB"、"32KB"、"64KB"、"128KB"、"256KB"、"512KB"、"1MB"
Level	RAID级别	说明：PMC卡不支持RAID 00；支持"RAID 0", "RAID 1", "RAID 5", "RAID 6", "RAID 00", "RAID 10", "RAID 50", "RAID 60", "RAID 1 ADM"(仅支持3个盘),"RAID 10 ADM"
SpanNum	组个数	该字段为数值说明： PMC卡： · 当级别为0/1/5/6/10 , "RAID 1 ADM","RAID 10 ADM"时，PMC卡下组个数为0 · 当级别为50/60时，组个数需大于1 LSI卡： · 当级别是0/1/5/6，组个数为1 · 当级别为00/10/50/60时，组个数需大于1
NumDrives	每个组成员盘数	该字段为数值 LSI卡说明： 1、当级别为0时，每个组成员盘数需大于0，且不能超过当前物理盘个数 2、当级别为1时，每个组成员盘数需大于0的偶数 3、当级别为5时，每个组成员数需大于2 4、当级别为6时，每个组成员数需大于2 5、当级别为00时，每个组成员盘数需大于0，且与组个数的乘积在当前物理盘个数范围内 6、当级别为10时，每个组成员盘数需大于0的偶数，且与组个数的乘积在当前物理盘个数范围内 7、当级别为50时，每个组成员盘数需大于2，且与组个数的乘积在当前物理盘个数范围内 8、当级别为60时，每个组成员盘数需大于2，且与组个数的乘积在当前物理盘个数范围内 PMC卡说明： PMC：实际成员盘数
WritePolicy	写策略	支持"Write Through", "Write Back", "Always Write Back" 说明：PMC卡不支持该字段；
ReadPolicy	读策略	支持"No Read Ahead", "Read Ahead" 说明：PMC卡不支持该字段；
IOPolicy	Cache策略	支持"Direct", "Cached" 说明：PMC卡不支持该字段；
DriveCache	物理盘缓存策略	支持"Unchanged", "Enable", "Disable" 说明：PMC卡不支持该字段；
AccessPolicy	访问策略	支持"Read/Write", "Read only", "Blocked" 说明：PMC卡不支持该字段；
Size	容量数值	说明 1、该字段为数值 2、当填写内容为0，以实际默认最大容量创建逻辑盘（SizeUnit为”MB”时不可用，请搭配"GB", "TB"或其他单位使用） 3、数值应使用整数，如果使用小数，数值会被强转为整数
SizeUnit	容量单位	说明 1、支持"MB", "GB", "TB" 2、 ≥100MB
AccelerationMethod	加速策略	说明：该字段类型为字符串；该字段仅适用于PMC 且固件支持 MCTP的卡，可选类型为： "Controller Cache"（PMC 且固件支持 MCTP的卡） "None" "IO Bypass" (仅适用于SSD)
PhysicalDiskList	创建逻辑盘的物理盘列表
group_id	创建时物理盘所在的组ID	说明 1、 PMC卡不支持该字段； 2、该字段为数值 3、 LSI卡当级别为00/10/50/60时，多组创建时，每组的硬盘个数需相等
id	物理盘索引ID	物理盘ConnectionID，可通过查询指定物理盘信息获取

【使用实例】

【请求样例——LSI卡】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Name":"LogicalDisk0",

"InitState": "No",

"StripSize":"64KB",

"Level":"RAID 0",

"SpanNum": 1,

"NumDrives": 1,

"ReadPolicy": "Read Ahead",

"WritePolicy": "Write Through",

"IOPolicy": "Direct",

"DriveCache": "Disable",

"AccessPolicy": "Blocked",

"Size": 199,

"SizeUnit": "GB",

"PhysicalDiskList":

[{

"group_id":0,

"id":11

}]

}

【返回示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Create volume succesfully. See ExtendedInfo for more information."

}

响应码：200

【请求样例——PMC卡】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Name":"LogicalDisk1",

"StripSize":"32KB",

"Level":"RAID 0",

"SpanNum": 0,

"NumDrives": 1,

"Size": 199,

"SizeUnit": "GB",

"AccelerationMethod"："None",

"PhysicalDiskList":

[{

"id":5

}]

}

【返回示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Create volume succesfully. See ExtendedInfo for more information."

}

响应码：200

【请求样例——创建Raid 10 ADM】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Name":"LogicalDisk1",

"StripSize":"32KB",

"Level":"RAID 10 ADM",

"SpanNum": 0,

"NumDrives": 1,

"Size": 199,

"SizeUnit": "GB",

"AccelerationMethod":"None",

"PhysicalDiskList":

[{

"id":0

{

"id":1

{

"id":2

{

"id":3

{

"id":4

{

"id":5

}]

}

【返回示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Create volume succesfully. See ExtendedInfo for more information."

}

响应码：200

【输出说明】

返回状态码200，表示操作成功完成。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
@Message.ExtendedInfo.Message	字符串	ExtendedInfo中详细信息
MessageId	字符串	消息ID
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) HDM-1.11.28版本新增。

(2) HDM-1.11.32：字段DiskCachePolicy 修改成DriveCache

(3) HDM-1.12.05：新增对PMC卡支持，增加字段AccelerationMethod

(4) HDM-1.30.07：AccelerationMethod字段新增值“IO Bypass”

(5) HDM-1.30.12：增加返回体，返回码修改为200

(6) HDM-1.30.19：PMC卡新增"RAID 1 ADM","RAID 10 ADM"等级支持

(7) HDM-2.38：字段ReadPolicy、WritePolicy的取值的值为大写开头，如"Write through"修改成"Write Through"

(8) HDM-6.02：修正字段为Message

(9) HDM-6.08：补充Size在填写0时，搭配SizeUnit的使用限制说明

4.3.15 删除指定逻辑盘

【功能描述】

删除指定逻辑盘。

【所属权限模块】

远程控制

【命令格式】

DELETE https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/volume_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-74 删除用户信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
storage_id	RAID卡所在ID	如：RAIDStorage0
volume_id	逻辑盘编号	如：LogicalDrive0

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【返回示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "Delete volume succesfully. See ExtendedInfo for more information."

}

【输出说明】

返回状态码200，表示操作成功完成。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
@Message.ExtendedInfo.Message	字符串	ExtendedInfo中详细信息
MessageId	字符串	消息ID
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) HDM-1.11.28版本新增

(2) HDM-1.30.09响应码由204改为201

(3) HDM-1.30.12 增加返回体，返回码修改为200

(4) HDM-6.02：修正字段为Message

4.3.16 查询指定逻辑盘信息

【功能描述】

查询指定的逻辑盘信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Storages/storage_id/Volumes/logical_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-75 查询指定逻辑盘信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
storage_id	存储资源的 ID	由RAID卡列表中查询
logical_id	逻辑盘 ID	由逻辑盘集合中查询

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例1】PBSI PMC卡返回体

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 3837295591424,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

}

]

[email protected]:2

"Name": "",

"Oem": {

"Public": {

"RaidControllerID": 0,

"VolumeRaidLevel": "RAID0"

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

【应答示例2】MCTP PMC卡返回体

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 3840594149376,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

}

]

"Name": "Logical Drive 1",

"Oem": {

"Public": {

"AccelerationMethod": "IO Bypass",

"OptimumIOSizeBytes": 262144,

"RaidControllerID": 0,

"VolumeRaidLevel": "RAID0"

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

【应答示例2】LSI卡返回体

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 10737418240,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront1"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront3"

}

]

"Name": "l1",

"Oem": {

"Public": {

"AccessPolicy": "Read/Write",

"BootEnable": false,

"DriveCache": "Unchanged",

"IOPolicy": "Direct",

"NumDrivePerSpan": 2,

"OptimumIOSizeBytes": 65536,

"RaidControllerID": 0,

"ReadPolicy": "No Read Ahead",

"SpanNumber": 1,

"VolumeRaidLevel": "RAID0",

"WritePolicy": "Write Through"

"DefaultReadPolicy": "ReadAhead",

"DefaultWritePolicy": "WriteBackWithBBU",

"DefaultCachePolicy": "DirectIO",

"CurrentCachePolicy": "DirectIO",

"BGIEnable": true,

"SSDCachecadeVolume": false,

"ConsistencyCheck": false,

"SSDCachingEnable": null,

}

"RedundantType": "NonRedundant",

"Status": {

"Health": "OK",

"State": "Enabled"

}

【输出说明】

表4-76 查询逻辑盘信息返回值

字段	类型	字段说明
@odata.context	字符串	指定逻辑盘资源模型的OData 描述信息
@odata.id	字符串	指定逻辑盘资源的访问路径
@odata.type	字符串	指定逻辑盘资源的类型
CapacityBytes	数值	逻辑盘容量，单位Bytes
Encrypted	布尔型	是否加密
Id	字符串	逻辑盘ID
Links.Drives	字符串	逻辑盘下成员盘资源路径
[email protected]	数值	逻辑盘下物理盘个数
Name	字符串	逻辑盘名称
Oem.Public	指定逻辑盘自定义信息
AccessPolicy	字符串	访问策略支持"Read/Write", "Read only", "Blocked" 说明：PMC卡不支持该字段；
BootEnable	布尔型	是否是启动盘
DriveCache	字符串	物理盘缓存策略支持"Unchanged", "Enable", "Disable" 说明：PMC卡不支持该字段；
IOPolicy	字符串	Cache策略支持"Direct", "Cached" 说明：PMC卡不支持该字段；
NumDrivePerSpan	数值	组中成员盘个数说明：PMC卡不支持该字段
RaidControllerID	数值	逻辑盘所属控制器的 ID
ReadPolicy	字符串	读策略支持"No Read Ahead", "Read Ahead" 说明：PMC卡不支持该字段；
SpanNumber	数值	逻辑盘包含的组个数
VolumeRaidLevel	字符串	RAID 级别：说明：PMC卡不支持RAID00；支持"RAID0", "RAID1", "RAID5", "RAID6", "RAID00", "RAID10", "RAID50", "RAID60"
WritePolicy	字符串	写策略支持"Write Through", "Write Back", "Always Write Back" 说明：PMC卡不支持该字段；
DefaultReadPolicy	字符串	逻辑盘默认的读策略 NoReadAhead ReadAhead
DefaultWritePolicy	字符串	逻辑盘默认的写策略 WriteThrough WriteBack Always Writeack
DefaultCachePolicy	字符串	逻辑盘默认的Cache策略 CachedIO DirectIO
CurrentCachePolicy	字符串	逻辑盘当前Cache策略
BGIEnable	布尔	后台初始化使能状态
SSDCachecadeVolume	布尔	是否为CacheCade逻辑盘（目前获取不到，写死null）
ConsistencyCheck	布尔	一致性检查功能的启用状态
SSDCachingEnable	布尔	是否可使用CacheCade逻辑盘（目前获取不到，写死null）
OptimumIOSizeBytes	数值	条带大小说明： LSI 9440只支持"64KB" LSI 9361和LSI 9460支持"64KB"、"128KB"、"256KB"、"512KB"、"1MB" PMC卡支持"16KB"、"32KB"、"64KB"、"128KB"、"256KB"、"512KB"、"1MB" 16384, -- 16KB 32768, -- 32KB 65536, -- 64KB 131072, -- 128KB 262144, -- 256KB 524288, -- 512KB 1048576, -- 1MB
AccelerationMethod	字符串	加速策略，该字段仅PMC卡有效，可选类型为： "Controller Cache", "None" "IO Bypass"(仅适用于SSD)
Status.Health	字符串	逻辑盘健康状态
Status.State	字符串	逻辑盘使能状态
RedundantType	字符串	逻辑盘的冗余类型 ,冗余类型与raid级别对应RawDevice NonRedundant(raid0, raid00) Mirrored(raid1) StripedWithParity(raid5, raid6) SpannedMirrors(raid10) SpannedStripesWithParity(raid50, raid60)

【修改记录】

(1) HDM-1.11.27及以前版本路径为https://device_ip/redfish/v1/Systems/system_id/Storage/RAIDStorage0/Volumes/logical_id

(2) HDM-1.11.29：增加字段BootDrive

(3) HDM-1.11.31：字段BootDrive修改成BootEnable，DiskCachePolicy 修改成DriveCache

(4) HDM-1.30.06 ：增加字段NumDrivePerSpan, SpanNumber

(5) HDM-1.30.09 ：修改字段BootEnable为布尔型，增加字段Oem.Public.OptimumIOSizeBytes

(6) HDM-1.30.10：增加字段Oem.Public.AccelerationMethod

(7) HDM-1.30.11：字段OptimumIOSizeBytes返回值类型从字符串修改成数值

(8) HDM-2.11.92,HDM-2.25：VolumeRaidLevel，取值由"RAID x"修改成"RAIDx"，即删除空格; 新增字段[email protected]

(9) HDM-2.93：新增字段RedundantType，Oem.Public.{DefaultReadPolicy,DefaultWritePolicy,DefaultCachePolicy,CurrentCachePolicy,BGIEnable,SSDCachecadeVolume,ConsistencyCheck,SSDCachingEnable}

4.3.17 修改指定逻辑盘属性

【功能描述】

修改指定逻辑盘的属性。PMC卡不支持。

说明：因为阵列卡修改策略需要一定时间，所以返回体是未修改前的策略信息。

【命令格式】

PATCH https://device_ip/redfish/v1f

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Public": {

"WritePolicy": read_policy,

"ReadPolicy": write_policy ,

"AccessPolicy":access_policy,

"DriveCache":drive_cache

}

【所属权限模块】

远程控制

【参数说明】

表4-77 修改逻辑盘信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
storage_id	存储资源的 ID	由RAID卡列表中查询
logical_id	逻辑盘 ID	由逻辑盘集合中查询
WritePolicy	写策略	支持"Write Through", "Write Back", "Always Write Back" 说明：PMC卡不支持该字段；
ReadPolicy	读策略	支持"No Read Ahead", "Read Ahead" 说明：PMC卡不支持该字段；
AccessPolicy	访问策略	访问策略支持"Read/Write", "ReadOnly", "Blocked" 说明：PMC卡不支持该字段；
DriveCache	物理盘缓存策略	物理盘缓存策略支持"Unchanged", "Enable", "Disable" 说明：PMC卡不支持该字段；

【使用实例】

【请求样例】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Public": {

"WritePolicy": "Write Through",

"ReadPolicy": "Read Ahead",

"AccessPolicy":"ReadOnly",

"DriveCache":"Unchanged"

}

【应答示例】LSI卡返回体

{

"@odata.context": "/redfish/v1/$metadata#Volume.Volume(*)",

"@odata.etag": "W/\"1598299739\"",

"@odata.id": "/redfish/v1/Systems/1/Storages/RAIDStorage0/Volumes/LogicalDrive0",

"@odata.type": "#Volume.v1_0_3.Volume",

"CapacityBytes": 8000046628864,

"Encrypted": false,

"Id": "LogicalDrive0",

"Links": {

"Drives": [

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront7"

{

"@odata.id": "/redfish/v1/Chassis/1/Drives/DiskFront8"

}

]

"Name": "111",

"Oem": {

"Public": {

"AccessPolicy": "Read/Write",

"BootEnable": true,

"DriveCache": "Unchanged",

"IOPolicy": "Direct",

"NumDrivePerSpan": 2,

"OptimumIOSizeBytes": 262144,

"RaidControllerID": 0,

"ReadPolicy": "No Read Ahead",

"SpanNumber": 1,

"VolumeRaidLevel": "RAID 1",

"WritePolicy": "Write Back"

}

"Status": {

"Health": "OK",

"State": "Enabled"

}

【输出说明】

返回状态码200，表示操作成功。返回体同【查询指定逻辑盘信息】

说明：因为阵列卡修改策略需要一定时间，所以返回体是未修改前的策略信息。

【修改记录】

(1)HDM-2.33：接口新增

(2)HDM-2.38：字段ReadPolicy、WritePolicy的取值的值为大写开头，如"Write through"修改成"Write Through"

(3)HDM-6.06：新增AccessPolicy和DriveCache属性设置

4.3.18 查询BIOS选项列表

【功能描述】

查询BIOS选项信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Bios

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-78 查询BIOS选项列表说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例1】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@Redfish.Settings": {

"@odata.type": "Settings.v1_0_4.Settings",

"SettingsObject": {

"@odata.id": "/redfish/v1/Systems/1/Bios/Settings"

}

"@odata.context": "/redfish/v1/$metadata#Bios.Bios",

"@odata.id": "/redfish/v1/Systems/1/Bios",

"@odata.type": "#Bios.v1_0_3.Bios",

"Actions": {

"#Bios.ChangePassword": {

"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword"

"#Bios.ResetBios": {

POST https://192.168.18.18/redfish/v1/Systems/1/kvm

"Reset"

"target": "/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios"

}

"AttributeRegistry": "BiosAttributeRegistry0ACLC.0.42.0",

"Attributes": {

…

"Description": "BIOS Configuration Current Settings",

"Id": "Bios",

"Name": "BIOS Configuration Current Settings"

}

响应码：200

【使用实例2】

可使用curl工具，将本接口返回的json格式内容，导出到指定文件。

如示例中，可导出到bios.json文件。

[root@localhost test]# curl -k -X GET -H "X-Auth-Token:oKaC4f9YeGAiydbTLsqtPuhmngO7rYaW4NxHg6unV5c=" "https://192.168.34.218/redfish/v1/Systems/1/Bios" -o bios.json

【输出说明】

表4-79 查询BIOS选项列表返回值

字段	类型	字段说明
SettingsObject	配置BIOS属性
@odata.id	字符串	配置BIOS属性的访问路径
@odata.context	字符串	BIOS 资源模型的 OData描述信息
@odata.id	字符串	BIOS 资源的访问路径
@odata.type	字符串	BIOS 资源的类型
AttributeRegistry	字符串	BIOS 属性注册资源 ID
Actions	Redfish 允许的指定 BIOS 资源可执行操作
Bios.ResetBios	对象	恢复 BIOS 项默认配置
[email protected]	数组	恢复BIOS项默认值可选择值 "Reset"
target	字符串	恢复BIOS属性默认值的路径
Bios.ChangePassword	对象	修改BIOS密码
target	字符串	修改BIOS 密码的路径
Attributes	对象	支持修改的BIOS选项及对应的参数可查看第五章BIOS选项参数及说明
Description	字符串	BIOS选项列表资源描述信息
Id	字符串	BIOS选项列表资源Id
Name	字符串	BIOS选项列表资源名称

【修改记录】

(1) HDM-1.30.09 修改字段SD为Settings，同时SD保留

(2) HDM-2.16.00 返回字段Description与Name显示内容修改

(3) 添加使用示例2，可将回复内容，导出到指定json文件中

4.3.19 查询待生效的BIOS选项信息

【功能描述】

查询待生效的BIOS选项信息。

【所属权限模块】

查询模块

【命令格式】

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

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-80 查询待生效的BIOS选项信息说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Bios/Settings

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Bios.Bios",

"@odata.id": "/redfish/v1/Systems/1/Bios/Settings",

"@odata.type": "#Bios.v1_0_1.Bios",

"AttributeRegistry": "BiosAttributeRegistry0ACLC.0.33.0",

"Attributes": {

"BootOrder1": "Hard Disk",

"BootOrder2": "Network",

"BootOrder3": "CD/DVD",

"BootOrder4": "Other Device"

"Description": "BIOS Configuration Pending Settings",

"Id": "Settings",

"Name": "BIOS Configuration Pending Settings"

}

响应码：200

【输出说明】

表4-81 查询待生效的BIOS选项信息返回值

字段	类型	字段说明
@odata.context	字符串	BIOS 资源模型的 OData描述信息
@odata.id	字符串	BIOS 资源的访问路径
@odata.type	字符串	BIOS 资源的类型
AttributeRegistry	字符串	BIOS 属性注册资源 ID
Attributes	对象	待生效的BIOS选项信息
Description	字符串	待生效的BIOS选项列表资源描述信息
Id	字符串	待生效的BIOS选项列表资源Id
Name	字符串	待生效的BIOS选项列表资源名称

【修改记录】

(1) HDM-1.30.09 修改字段SD为Settings，同时SD保留

(2) HDM-1.30.10 名称修改，原有名称“查询下次启动设备”

(3) HDM-1.30.11字段删除"BootSourceOverrideMode","BootSourceOverrideTarget"

(4) HDM-2.16.00 返回字段Description与Name显示内容修改

4.3.20 设置指定的BIOS选项

【功能描述】

修改指定的BIOS选项。

【所属权限模块】

远程控制

【命令格式】

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

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"Attributes": {

"BootOrder1": BootOrder1,

"BootOrder2": BootOrder2,

"BootOrder3": BootOrder3,

"BootOrder4": BootOrder4

}

【参数说明】

表4-82 设置指定BIOS选项参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
Attributes	指定要设置的BIOS选项	支持修改的BIOS选项及对应的参数可查看第五章BIOS选项参数及说明说明：关于永久启动项： · 4个启动项需要同时下发 · 下发不同启动项的值要唯一

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Bios/Settings

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Attributes": {

"BootOrder1": "Hard Disk",

"BootOrder2": "Network",

"BootOrder3": "CD/DVD",

"BootOrder4": "Other Device"

}

【返回示例】

{

"@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",

"AttributeRegistry": "BiosAttributeRegistry.1.0.1",

"Attributes": {

"BootOrder1": "Hard Disk",

"BootOrder2": "Network",

"BootOrder3": "CD/DVD",

"BootOrder4": "Other Device"

"Description": "BIOS Configuration Pending Settings",

"Id": "Settings",

"Name": "BIOS Configuration Pending Settings"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同“查询待生效的BIOS选项信息”。

【修改记录】

(1) HDM-1.30.09 修改字段SD为Settings，修改响应码，增加响应体，同时SD保留

(2) HDM-1.30.11字段删除"BootSourceOverrideMode","BootSourceOverrideTarget";

(3) G5产品，BIOS选项中BootOption#1~4修改成 BootOrder1~4

(4) HDM-2.17.00：设置启动项时4个启动项需要同时下发

4.3.21 修改BIOS密码

【功能描述】

修改BIOS密码。

注：该接口不支持If-Match检查。修改密码后，BIOS需重启1~2次生效，请勿在重启过程中进行服务器操作，以避免出现密码不生效等情况。

【所属权限模块】

远程控制

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ChangePassword

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"UserName":name,

"Password":password

}

【参数说明】

表4-83 设置BIOS密码参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
UserName	指定要设置用户名称	支持“Admin”、“User”
Password	字符串	BIOS密码设置需符合以下要求： l 密码长度为8～20个字符，仅支持字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}\|;':",./<>?，区分大小写； l 至少包含大写字母、小写字母和数字中的两种字符； l 至少包含一个空格或特殊字符。

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Systems/1/Bios/Actions/Bios.ChangePassword

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"UserName":"User",

"Password":"Password@_"

}

【返回示例】

空

响应码：204

【输出说明】

返回状态码204，表示操作成功。

【修改记录】

(1) HDM-1.30.09 新增密码复杂度检查，与BIOS界面保持一致

4.3.22 恢复BIOS属性默认值

【功能描述】

恢复BIOS属性默认值

【所属权限模块】

远程控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Bios/Actions/Bios.ResetBios

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType": "Reset"

}

【参数说明】

表4-84 恢复BIOS属性默认值参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
ResetType	恢复默认值名称	“Reset”

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Bios/Actions/Bios.ResetBios

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType": "Reset"

}

【返回示例】

空

响应码：204

【输出说明】

返回状态码204，表示操作成功。

4.3.23 创建KVM资源信息

【功能描述】

创建KVM资源信息。

【所属权限模块】

远程控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/kvm

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【参数说明】

表4-85 创建KVM资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例1】

【请求样例】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadataSystems/1",

"@odata.id": "/redfish/v1/Systems/1/kvm",

"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",

"H5_KVM_Authority": {

"@odata.id": "/redfish/v1/Systems/1/kvm/doo64Mgdr3bd6Ph5"

}

【输出说明】

表4-86 查询H5 KVM资源信息返回值

字段	类型	字段说明
@odata.context	字符串	KVM资源模型的OData 描述信息
@odata.id	字符串	KVM资源的访问路径
@odata.type	字符串	KVM资源的类型
H5_KVM_Authority	对象	KVM免加密资源访问路径使用说明： http://+路径中表明是H5 KVM非加密， https://+路径表明是H5 KVM加密

【使用实例2】

【示例目的】

使用redfish获取的kvm资源信息进行免密登录

【使用方法】

使用【应答示例1】中获取的H5 KVM资源访问路径，在浏览中登录

https://192.168.18.18/redfish/v1/Systems/1/kvm/doo64Mgdr3bd6Ph5

即可获取对访问服务器进行H5 KVM的远程控制。

【修改记录】

(1) HDM-1.30.09接口功能不可用

(2) HDM-1.30.11接口功能恢复

(3) HDM-2.13.00操作由GET修改成POST，同时请求体由空修改成{}

4.3.24 查询事件日志服务集合资源信息

【功能描述】

查询服务器当前事件日志服务集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-87 查询事件日志服务集合资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogServiceCollection.LogServiceCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices",

"@odata.type": "#LogServiceCollection.LogServiceCollection",

"Description": "Collection of log services for this system",

"Members": [

"/redfish/v1/Systems/1/LogServices/Log1"

"Name": "Log Services Collection"

}

响应码：200

【输出说明】

表4-88 查询事件日志服务集合资源信息返回值

字段	类型	字段说明
@odata.context	字符串	事件日志服务集合资源模型的 OData描述信息
@odata.id	字符串	事件日志服务集合资源的访问路径
@odata.type	字符串	事件日志服务集合资源的类型
Name	字符串	事件日志服务集合资源的名称
[email protected]	数字	当前事件日志服务资源数量
Members	事件日志服务资源列表

【修改记录】

(1) HDM-1.30.06 接口新增

4.3.25 查询指定事件日志服务集合资源信息

【功能描述】

查询服务器当前事件日志服务资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-89 查询指定事件日志服务资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogService.LogService(DateTimeLocalOffset,Id,Name,ServiceEnabled,MaxNumberOfRecords,DateTime,OverWritePolicy,[email protected],Entries)",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1",

"@odata.type": "#LogService.v1_1_0.LogService",

"Actions": {

"#LogService.ClearLog": {

" "

"target": "/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog"

}

"DateTime": "2019-11-04T08:20:22+08:00",

"DateTimeLocalOffset": "UTC+08:00",

"Entries": {

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries"

"Id": "Log1",

"MaxNumberOfRecords": 3639,

"Name": "System Service Log",

"OverWritePolicy": "WrapsWhenFull",

"Unknown",

"WrapsWhenFull",

"NeverOverWrites"

"ServiceEnabled": true,

}

响应码：200

【输出说明】

表4-90 查询指定事件日志服务集合资源信息返回值

字段	类型	字段说明
@odata.context	字符串	指定事件日志服务资源模型的 OData描述信息
@odata.id	字符串	指定事件日志服务资源的访问路径
@odata.type	字符串	指定事件日志服务资源的类型
Id	字符串	指定事件日志服务资源的ID
Name	字符串	指定事件日志服务资源的名称
MaxNumberOfRecord	数字	指定事件日志服务资源的最大可记录事件日志条数
OverWritePolicy	字符串	指定事件日志服务资源的覆盖策略： Unknown WrapsWhenFull NeverOverWrites
[email protected]	数组	覆盖策略允许值列表
DateTime	字符串	指定事件日志服务资源的系统时间
DateTimeLocalOffset	字符串	指定事件日志服务资源的时区
ServiceEnabled	字符串	指定事件日志服务资源的启用状态 true false
Actions #LogService.ClearLog	对象	清空事件日志操作
target	字符串	Action操作路径
Entries	对象	事件日志集合资源的访问路径

【修改记录】

(1) HDM-1.30.06接口新增

(2) HDM-1.30.10字段DateTimeLocalOffset显示从"UTC"修改成"UTC+08:00"的格式

4.3.26 查询事件日志集合资源信息

【功能描述】

查询服务器当前事件日志集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-91 查询事件日志集合资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例1】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"Description": "Collection of entries for this log service",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1716"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1715"

…

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/3"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/2"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1"

}

"[email protected]": 1716,

"[email protected]": "/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=50",

"Name": "Log Service Entries Collection"

}

响应码：200

【使用实例2】

查询第10~20条事件日志，并展开显示日志内容

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries?$skip=10&$top=10&$expand=*

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries",

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"Description": "Collection of entries for this log service",

"Members": [

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1875",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1875",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1875",

"SensorName": "Disk_F3_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1874",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1874",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1874",

"SensorName": "Disk_F2_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1873",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1873",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1873",

"SensorName": "Disk_F1_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1872",

"Created": "2021-06-05T06:30:20+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1872",

"Level": "Info",

"Message": "Drive Presence",

"MessageArgs": [

"1"

"Name": "Log Entry 1872",

"SensorName": "Disk_F0_Status",

"SensorType": "Drive Slot (Bay)",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1871",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1871",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1871",

"SensorName": "CPU4_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1870",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1870",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1870",

"SensorName": "CPU3_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1869",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1869",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1869",

"SensorName": "CPU2_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1868",

"Created": "2021-06-05T06:30:18+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1868",

"Level": "Info",

"Message": "Processor Presence detected",

"MessageArgs": [

"1"

"Name": "Log Entry 1868",

"SensorName": "CPU1_Status",

"SensorType": "Processor",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1867",

"Created": "2021-06-05T06:30:09+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1867",

"Level": "Info",

"Message": "S0 / G0 \"working\"",

"MessageArgs": [

"1"

"Name": "Log Entry 1867",

"SensorName": "ACPI_State",

"SensorType": "System ACPI Power State",

"Severity": "OK"

{

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/1866",

"Created": "2021-06-05T06:30:06+08:00",

"Description": "System Event Log",

"EntryCode": "Asserted",

"EntryType": "Event",

"Id": "1866",

"Level": "Info",

"Message": "Transition to Running",

"MessageArgs": [

"1"

"Name": "Log Entry 1866",

"SensorName": "FAN4_D_R_Status",

"SensorType": "Fan",

"Severity": "OK"

}

"[email protected]": 1885,

"Name": "Log Service Entries Collection"

}

【输出说明】

表4-92 查询事件日志集合资源返回值

字段	类型	字段说明
@odata.context	字符串	事件日志集合资源模型的 OData描述信息
@odata.id	字符串	事件日志集合资源的访问路径
@odata.type	字符串	事件日志集合资源的类型
Name	字符串	事件日志集合资源的名称
[email protected]	数字	当前事件日志资源数量
[email protected]	字符串	用于分页展示的路径(默认是全部展示)
Members	事件日志资源列表

【修改记录】

(1) HDM-1.30.06 接口新增

4.3.27 查询事件日志资源信息

【功能描述】

查询服务器当前事件日志资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https: //device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Entries/Entry_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-93 查询事件日志资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Entries/29

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry(EntryCode,Level,Id,SensorType,Name,MessageArgs,Message,EntryType,Description,Severity,SensorName,Created)",

"@odata.id": "/redfish/v1/Systems/1/LogServices/Log1/Entries/29",

"@odata.type": "#LogEntry.v1_3_0.LogEntry",

"Created": "2019-11-04T07:39:56+08:00",

"Description": "System Event Log",

"Severity": "OK",

"EntryCode": "Asserted",

"EntryType": "Event",

"EventTimestamp": "2019-11-04T07:39:56+08:00",

"Id": "29",

"Level": "Info",

"Message": "Drive presence",

"MessageArgs": [

"1"

"Name": "Log Entry 29",

"SensorName": "HDD_F05_Status",

"SensorType": "Drive Slot (Bay)"

}

响应码：200

【输出说明】

表4-94 查询事件日志资源返回值

字段	类型	字段说明
@odata.context	字符串	事件日志资源模型的 OData描述信息
@odata.id	字符串	事件日志资源的访问路径
@odata.type	字符串	事件日志资源的类型
Name	字符串	事件日志资源的名称
Description	字符串	事件日志资源描述信息
Severity	字符串	严重性，Redfish支持的严重级别包括： OK、 Warning、Critical
Level	字符串	自定义安全级别： Info Minor Major Critical
Created	字符串	事件日志创建时间
EntryType	字符串	事件日志类型： Event SEL Oem
EventTimestamp	字符串	事件产生时间
Message	字符串	事件日志描述信息
Id	字符串	事件ID
EntryCode	字符串	Asserted：触发 Deasserted ：解除
MessageArgs	数组	消息参数
SensorName	字符串	传感器名称
SensorType	字符串	传感器类型

【修改记录】

(1) HDM-1.30.06接口新增

(2) HDM-2.16.00字段Id类型修改成字符串，EntryCode取值修改成Asserted, Deasserted

(3) HDM-2.52字段新增EventTimestamp

4.3.28 清空事件日志信息

【功能描述】

清空事件日志信息。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/LogServices/LogService_id/Actions/

LogService.ClearLog

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【参数说明】

表4-95 清空事件日志参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/LogServices/Log1/Actions/LogService.ClearLog【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【应答示例】

{

"eroor": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

【修改记录】

(1) HDM-1.30.06 接口新增

(2) HDM-1.30.09 修改响应码为200，增加响应体

(3) HDM-2.25 模块权限修改成常规配置

4.3.29 查询GPU信息

【功能描述】

查询GPU信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET http://172.16.13.176/redfish/v1/Systems/1/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/GPU",

"Description": "Get GPU info for this system",

"GPUMaxNum":8,

"Healthstate": {

"OverallHealth": "Critical"

"GPU": [

{

"FirmwareVersion": "88.00.1A.00.03",

"ID": "0x1",

"Manufacture": "NVIDIA",

"Model": "Tesla V100-PCIE-16GB",

"Name": "Tesla V100-PCIE-16GB",

"PartNumber": "1DB4-893-A1",

"PowerConsumedWatts": 0,

"SerialNumber": "0323617020478",

"SlotNum": 2,

"HBMTemperature": 45, //燧原GPU特有字段，非燧原GPU不回显

"DriverVersion": V1.2, //燧原GPU特有字段，非燧原GPU不回显

"ECCEnable": Enable, //燧原GPU特有字段，非燧原GPU不回显

"GCUVoltage": 1.203, //燧原GPU特有字段，非燧原GPU不回显

"HBMVoltage": 1.0, //燧原GPU特有字段，非燧原GPU不回显

"Status": {

"Health": "OK",

"State": "Enable"

"TemperatureCelsius": 50

}

"Oem":{

"Public":{

"PowerControl": [

{

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 2000,

"PowerLimitEnable": true,

"PowerMetrics": {

"MaxConsumedWatts": 4000,

"MinConsumedWatts": 1000

}

]

}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定系统资源模型的OData 描述信息
@odata.id	字符串	指定系统资源的访问路径
Description	字符串	接口功能描述
GPU.FirmwareVersion	字符串	固件版本
GPU.ID	字符串	GPU编号
GPU.Manufacture	字符串	厂商名称
GPU.Model	字符串	产品型号
GPU.Name	字符串	产品名称
GPU.PartNumber	字符串	部件号
GPU.PowerConsumedWatts	数值	功率；当功率为0时需要在OS下安装驱动
GPU.SerialNumber	字符串	序列号
GPU.SlotNum	数值	槽位号
DriverVersion	字符串	驱动版本号（仅燧原GPU支持）
ECCEnable	布尔型	ECC使能状态（仅燧原GPU支持）
GCUVoltage	数值	GCU电压（仅燧原GPU支持），单位：V
HBMVoltage	数值	HBM电压（仅燧原GPU支持），单位：V
HBMTemperature	数值	HBM芯片温感值（仅燧原GPU支持），单位：摄氏度
GPU.Status.Health	字符串	健康状态
GPU.Status.State	字符串	在位状态
GPU.TemperatureCelsius	数值	温度，单位：摄氏度
[email protected]	数值	GPU数量
PowerControl.PowerLimit.CorrectionInMs	数值	功率封顶调整的时间，时间ms
PowerControl.PowerLimit.LimitException	字符串	功率封顶失效动作： "NoAction"：无操作 "HardPowerOff "：关机
PowerControl.PowerLimit.LimitInWatts	数值	功率封顶值
PowerControl.PowerLimit.PowerLimitEnable	布尔型	功率封顶使能
PowerControl.PowerMetrics.MaxConsumedWatts	数值	功率封顶的最大值
PowerControl.PowerMetrics.MinConsumedWatts	数值	功率封顶的最小值
GPUMaxNum	数值	最大GPU数量(5300 Gpu板支持的数量,其余slotnum数量)
OverallHealth	字符串	GPU总体健康状态

【修改记录】

(1) HDM-1.30.09接口新增

(2) HDM-2.33字段新增Oem.Public.PowerControl

(3) HDM-2.93：新增字段GPUMaxNum,Healthstate.OverallHealth

(4) HDM-3.26：新增字段DriverVersion,ECCEnable,GCUVoltage,HBMVoltage

(5) HDM-3.35：更正“燧原GPU”描述

(6) HDM-3.39.01 新增字段 HBMTemperature

4.3.30 设置GPU信息

【功能描述】

设置GPU功率封顶。

支持机型：R5500 G5。

【所属权限模块】

电源控制

【命令格式】

PATCH https://device_ip/redfish/v1/Systems/system_id/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Oem":{

"Public":{

"PowerControl":[

{

"PowerLimit":{

"LimitInWatts":2000,

"LimitException":"NoAction"

}

]

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
system_id	系统资源的ID	当前所有机型取值为1
PowerControl.PowerLimit.LimitException	字符串	功率封顶失效动作： "NoAction"：无操作 "HardPowerOff "：关机
PowerControl.PowerLimit.LimitInWatts	数值	功率封顶值, 范围1000~4000W；设置1000~4000W会直接开启功率封顶；null 的表明是关闭功率封顶，且封顶值和失效动作维持上一次状态

【使用实例】

【请求样例】

PATCH http://172.16.13.176/redfish/v1/Systems/1/GPU

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

//开启并设置GPU功率封顶参数

{

"Oem":{

"Public":{

"PowerControl":[

{

"PowerLimit":{

"LimitInWatts":2000,

"LimitException":"NoAction"

}

]

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Systems/1/GPU",

"Description": "Get GPU info for this system",

"GPU": [

{

"FirmwareVersion": "88.00.1A.00.03",

"ID": "0x1",

"Manufacture": "NVIDIA",

"Model": "Tesla V100-PCIE-16GB",

"Name": "Tesla V100-PCIE-16GB",

"PartNumber": "1DB4-893-A1",

"PowerConsumedWatts": 0,

"SerialNumber": "0323617020478",

"SlotNum": 2,

"Status": {

"Health": "OK",

"State": "Enable"

"TemperatureCelsius": 50

}

"Oem":{

"Public":{

"PowerControl": [

{

"PowerLimit": {

"CorrectionInMs": 30000,

"LimitException": "HardPowerOff",

"LimitInWatts": 2000,

"PowerLimitEnable": true,

"PowerMetrics": {

"MaxConsumedWatts": 4000,

"MinConsumedWatts": 1000

}

]

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

返回参数说明同【查询GPU信息】

【修改记录】

(1) HDM-2.33 字段新增Oem.Public.PowerControl

4.3.31 查询主机资源监控信息

【功能描述】

查询主机资源监控信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-96 查询主机资源监控信息参数说明

1 参数	1 参数说明	1 取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#PerformanceMonitoring.PerformanceMonitoring",

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring",

"@odata.type": "#PerformanceMonitoring.v1_0_0.PerformanceMonitoring",

"DriveHistoryUsageRate": {

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate"

"MemoryHistoryUsageRate": {

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate"

}

响应码：200

【输出说明】

表4-97 查询主机资源监控信息返回值

1 字段	1 类型	1 字段说明
@odata.context	字符串	主机资源监控资源模型的OData 描述信息
@odata.id	字符串	主机资源监控资源的访问路径
@odata.type	字符串	主机资源监控资源的类型
MemoryHistoryUsageRate	对象	内存占用率资源访问路径
DriveHistoryUsageRate	对象	磁盘占用率资源访问路径

【修改记录】

(1) HDM-6.01 接口新增

4.3.32 查询内存占用率资源信息

【功能描述】

查询内存占用率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-98 查询内存占用率资源信息参数说明

2 参数	2 参数说明	2 取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#MemoryHistoryUsageRate.MemoryHistoryUsageRate",

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/MemoryHistoryUsageRate",

"@odata.type": "#MemoryHistoryUsageRate.v1_0_0.MemoryHistoryUsageRate",

"HistoricalUsageRate": [

{

"Time": "2023-05-24T05:55:05+08:00",

"UsageRatePercents": 0

}

]

}

响应码：200

【输出说明】

表4-99 查询内存占用率资源信息返回值

1 字段	1 类型	1 字段说明
@odata.context	字符串	内存历史占用率资源模型的OData 描述信息
@odata.id	字符串	内存历史占用率资源的访问路径
@odata.type	字符串	内存历史占用率资源的类型
HistoricalUsageRate	数组	历史数据
HistoricalUsageRate.UsageRatePercents	数值	数据产生时的使用率
HistoricalUsageRate.Time	字符串	数据产生时的时间

【修改记录】

(1) HDM-6.01 接口新增

(2) HDM-6.09 修正数据描述为“数据产生时”的信息

4.3.33 查询磁盘占用率资源信息

【功能描述】

查询磁盘占用率资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Systems/system_id/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【参数说明】

表4-100 查询磁盘占用率资源信息参数说明

3 参数	3 参数说明	3 取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
system_id	系统资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#DriveHistoryUsageRate.DriveHistoryUsageRate",

"@odata.id": "/redfish/v1/Systems/1/Oem/Public/PerformanceMonitoring/DriveHistoryUsageRate",

"@odata.type": "#DriveHistoryUsageRate.v1_0_0.DriveHistoryUsageRate",

"HistoricalUsageRate": [

{

"Time": "2021-01-26T04:49:30-03:00",

"TotalCapacityMB": 47897200,

"UsageRatePercents": 4.04,

"UsedCapacityGB": 1934608

}

]

}

响应码：200

【输出说明】

表4-101 查询磁盘占用率资源信息返回值

1 字段	1 类型	1 字段说明
@odata.context	字符串	磁盘历史占用率资源模型的OData 描述信息
@odata.id	字符串	磁盘历史占用率资源的访问路径
@odata.type	字符串	磁盘历史占用率资源的类型
HistoricalUsageRate	数组	历史数据
HistoricalUsageRate.UsageRatePercents	数值	数据产生时的使用率
HistoricalUsageRate.TotalCapacityMB	数值	数据产生时的分区总容量
HistoricalUsageRate.UsedCapacityGB	数值	（数据产生时的分区已使用容量）暂不关注该字段
HistoricalUsageRate.Time	字符串	数据产生时的时间

【修改记录】

(1) HDM-6.01 接口新增

(2) HDM-6.09 修正数据描述为“数据产生时”的信息

4.3.34 清除指定RAID卡下物理盘Foreign状态

【功能描述】

清除指定RAID卡下物理盘Foreign状态

【所属权限模块】

远程控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id/Actions/Oem/Public/Storage.ClearForeignConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
system_id	系统资源的ID	当前所有机型取值为1
raid_id	RAID卡ID	由RAID卡集合中查询
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearForeignConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"@Message.ExtendedInfo": [

{

"@odata.type": "#Message.v1_1_1.Message",

"Message": "Successfully Completed Request",

"MessageArgs": [],

"MessageId": "Base.1.8.1.Success",

"Severity": "OK",

"Resolution": "None"

}

"Oem": {

"Public": {

"CompletionCode": 0,

"Description": "Success"

}

响应码：200

【输出说明】

字段	类型	字段说明
@Message.ExtendedInfo	错误消息扩展信息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改记录】

(1) HDM-6.06：接口新增

4.3.35 清除指定RAID卡的所有配置

【功能描述】

清除指定RAID的默认配置

【所属权限模块】

远程控制

【命令格式】

POST https://device_ip/redfish/v1/Systems/system_id/Storages/raid_id/Actions/Oem/Public/Storage.ClearConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
system_id	系统资源的ID	当前所有机型取值为1
raid_id	RAID卡ID	由RAID卡集合中查询

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Systems/1/Storages/RAIDStorage0/Actions/Oem/Public/Storage.ClearConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type:application/json

【请求消息体】

{

}

【应答示例】

{

"@Message.ExtendedInfo": [

{

"@odata.type": "#Message.v1_1_1.Message",

"Message": "Successfully Completed Request",

"MessageArgs": [],

"MessageId": "Base.1.8.1.Success",

"Severity": "OK",

"Resolution": "None"

}

"Oem": {

"Public": {

"CompletionCode": 0,

"Description": "Success"

}

响应码：200

【输出说明】

字段	类型	字段说明
@Message.ExtendedInfo	错误消息扩展信息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性，Redfish支持的严重级别，包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改记录】

(1) HDM-6.06：接口新增

4.4 Managers 资源的操作

4.4.1 查询管理集合资源

【功能描述】

查询服务器当前管理集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-102 查询管理资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#ManagerCollection.ManagerCollection",

"@odata.id": "/redfish/v1/Managers",

"@odata.type": "#ManagerCollection.ManagerCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

"Name": "Manager Collection"

}

响应码：200

【输出说明】

表4-103 查询管理资源信息返回值

字段	类型	字段说明
@odata.context	字符串	管理集合资源模型的OData 描述信息
@odata.id	字符串	管理集合资源的访问路径
@odata.type	字符串	管理集合资源的类型
Members	管理资源列表
@odata.id	字符串	管理资源节点的访问路径
[email protected]	数值	当前管理资源数量
Name	字符串	管理集合资源的名称

4.4.2 查询指定管理资源信息

【功能描述】

查询服务器指定管理资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-104 查询指定管理资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Manager.Manager(*)",

"@odata.id": "/redfish/v1/Managers/1",

"@odata.type": "#Manager.v1_4_0.Manager",

"Actions": {

"#Manager.Reset": {

"ForceRestart"

"target": "/redfish/v1/Managers/1/Actions/Manager.Reset"

"#Manager.RollBack": {

" "

"target": "/redfish/v1/Managers/1/Actions/Manager.RollBack"

}

"CommandShell": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"DateTime": "2020-12-03T19:46:32-08:00",

"DateTimeLocalOffset": "UTC-08:00",

"Description": "BMC",

"EthernetInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"

"FirmwareVersion": "2.17 HDM V100R001B05D020_DEBUG",

"GraphicalConsole": {

"ConnectTypesSupported": [

"KVMIP"

"MaxConcurrentSessions": 4,

"ServiceEnabled": true

"Id": "1",

"KvmService": {

"@odata.id": "/redfish/v1/Managers/1/KvmService"

"Links": {

"ManagerForChassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagerForServers": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

]

"LogServices": {

"@odata.id": "/redfish/v1/Managers/1/LogServices"

"ManagerType": "BMC",

"Model": "HDM",

"Name": "Manager",

"NetworkProtocol": {

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"

"NtpService": {

"@odata.id": "/redfish/v1/Managers/1/NtpService"

"Oem": {

"Public": {

"FirmwareVendor": "AMI",

"LanguageSet": "EN, CN"

}

"SerialConsole": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"SerialInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"

"ServiceEntryPointUUID": "acc120aa-307b-03d7-e611-b6cf70fd67de",

"SmtpService": {

"@odata.id": "/redfish/v1/Managers/1/SmtpService"

"LldpService": {

"@odata.id": "/redfish/v1/Managers/1/LldpService"

"SnmpService": {

"@odata.id": "/redfish/v1/Managers/1/SnmpService"

"Status": {

"Health": "OK",

"State": "Enabled"

"SyslogService": {

"@odata.id": "/redfish/v1/Managers/1/SyslogService"

"UUID": "acc120aa-307b-03d7-e611-b6cf70fd67de",

"VirtualMedia": {

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia"

"VncService": {

"@odata.id": "/redfish/v1/Managers/1/VncService"

}

响应码：200

【输出说明】

表4-105 查询指定管理资源信息返回值

字段	类型	字段说明
@odata.context	字符串	指定管理集合资源模型的OData 描述信息
@odata.id	字符串	指定管理集合资源的访问路径
@odata.type	字符串	指定管理集合资源的类型
Actions	Actions指定管理资源可执行的操作
Manager.Reset	对象	HDM重启
Manager.RollBack	对象	HDM主备切换
Manager.FactoryReset	对象【未实现】	HDM恢复出厂设置【未实现】
CommandShell	命令控制台属性
ConnectTypesSupported	数组	支持连接类型： "SSH"
MaxConcurrentSessions	数值	最大连接数
ServiceEnabled	布尔型	使能状态
DateTime	字符串	指定管理资源的系统时间
DateTimeLocalOffset	字符串	指定管理资源的时区
Description	字符串	指定管理资源的描述信息，BMC
EthernetInterfaces	对象	网口信息的访问路径
FirmwareVersion	字符串	HDM固件版本信息
GraphicalConsole	图形控制台属性
ConnectTypesSupported	数组	支持连接类型： "KVMIP"
MaxConcurrentSessions	数值	最大连接数
ServiceEnabled	布尔型	使能状态
Id	字符串	指定管理集合资源的ID
KvmService	字符串	KVM信息资源的访问路径
Links	对象	指定管理资源的关联对象
LogServices	对象	日志服务集合资源节点的访问路径
ManagerType	字符串	指定管理资源的类型： "BMC"
Model	字符串	指定管理资源的型号：HDM
Name	字符串	指定管理集合资源的名称
NetworkProtocol	对象	服务信息访问路径
NtpService	对象	NTP信息访问路径
Oem.Public.FirmwareVendor	字符串	指定系统管理资源的FW的厂商
Oem.Public.LanguageSet	字符串	可支持语言
Oem.Public.Wireless	对象	无线管理资源的访问路径，仅G5部分产品支持
SerialConsole	串口控制台属性
ConnectTypesSupported	数组	支持连接类型： "SSH"
MaxConcurrentSessions	数值	最大连接数
ServiceEnabled	布尔型	使能状态
SerialInterfaces	对象	串口信息访问路径
ServiceEntryPointUUID	字符串	服务入口点标识符
SmtpService	对象	SMTP信息访问路径
SnmpService	对象	SNMP信息访问路径
LldpService	对象	LLDP服务资源信息访问路径
Status	对象	指定管理资源的状态，包括： Health：管理资源健康状态 State：管理资源使能状态
SyslogService	对象	Syslog信息访问路径
UUID	字符串	指定管理资源的全局唯一标识符
VirtualMedia	对象	VirtualMedia信息访问路径
VncService	对象	VNC信息访问路径

【修改记录】

(1) HDM-1.30.09：新增字段LanguageSet,Model,Links

(2) HDM-1.30.10 CommandShell.ConnectTypesSupported、SerialConsole.ConnectTypesSupported删除IPMI支持，且最大会话数修改成3，以和页面保持一致

(3) HDM-1.30.1P01新增字段Oem.Public.FirmwareVendor，未合B03主线，合入B05

(4) 仅HDM-1.30.18P5X,B05：字段Model的值修改成"HDM"

(5) HDM-2.17.00：新增字段Oem.Public.Wireless

(6) HDM-2.42：新增字段LldpService

4.4.3 修改服务器指定管理资源信息

【功能描述】

修改服务器指定管理资源(时区)信息。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"DateTimeLocalOffset": "UTC-04:30"

}

【参数说明】

表4-106 修改服务器指定管理资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
DateTimeLocalOffset	字符串	时区信息

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"DateTimeLocalOffset": "UTC-04:30"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功，且返回响应体：

{

"@odata.context": "/redfish/v1/$metadata#Manager.Manager(*)",

"@odata.id": "/redfish/v1/Managers/1",

"@odata.type": "#Manager.v1_4_0.Manager",

"Actions": {

"#Manager.Reset": {

"ForceRestart"

"target": "/redfish/v1/Managers/1/Actions/Manager.Reset"

"#Manager.RollBack": {

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/SyslogService.SubmitTestEvent

" "

"target": "/redfish/v1/Managers/1/Actions/Manager.RollBack"

}

"CommandShell": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"DateTime": "2017-05-17T12:08:01-04:30",

"DateTimeLocalOffset": "UTC-04:30",

"Description": "BMC",

"EthernetInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces"

"FirmwareVersion": "2.42 HDM V100R001B05D052_DEBUG",

"GraphicalConsole": {

"ConnectTypesSupported": [

"KVMIP"

"MaxConcurrentSessions": 4,

"ServiceEnabled": true

"Id": "1",

"KvmService": {

"@odata.id": "/redfish/v1/Managers/1/KvmService"

"Links": {

"ManagerForChassis": [

{

"@odata.id": "/redfish/v1/Chassis/1"

}

"ManagerForServers": [

{

"@odata.id": "/redfish/v1/Systems/1"

}

]

"LldpService": {

"@odata.id": "/redfish/v1/Managers/1/LldpService"

"LogServices": {

"@odata.id": "/redfish/v1/Managers/1/LogServices"

"ManagerType": "BMC",

"Model": "HDM",

"Name": "Manager",

"NetworkProtocol": {

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol"

"NtpService": {

"@odata.id": "/redfish/v1/Managers/1/NtpService"

"Oem": {

"Public": {

"#Manager.ExportConfiguration": {

"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration"

"#Manager.ImportConfiguration": {

"target": "/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration"

"FirmwareVendor": "AMI",

"LanguageSet": "EN, CN",

"Wireless": {

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless"

}

"SerialConsole": {

"ConnectTypesSupported": [

"SSH"

"MaxConcurrentSessions": 3,

"ServiceEnabled": true

"SerialInterfaces": {

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces"

"ServiceEntryPointUUID": "6b567877-c434-04a1-e611-37d02a72d9d0",

"SmtpService": {

"@odata.id": "/redfish/v1/Managers/1/SmtpService"

"SnmpService": {

"@odata.id": "/redfish/v1/Managers/1/SnmpService"

"Status": {

"Health": "OK",

"State": "Enabled"

"SyslogService": {

"@odata.id": "/redfish/v1/Managers/1/SyslogService"

"UUID": "6b567877-c434-04a1-e611-37d02a72d9d0",

"VirtualMedia": {

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia"

"VncService": {

"@odata.id": "/redfish/v1/Managers/1/VncService"

}

【修改记录】

(1) HDM-2.51 接口新增

4.4.4 查询NTP信息

【功能描述】

查询NTP信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-107 查询NTP信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#NtpService.NtpService",

"@odata.id": "/redfish/v1/Managers/1/NtpService",

"@odata.type": "#NtpService.v1_0_0.NtpService",

"AlternateNtpServer": "2.cn.pool.ntp.org",

"Description": "NtpService Gettings",

"NtpAddressOrigin": "Static",

"Oem": {

"Public": {

"TimeZone": "UTC+8",

"TertiaryNtpServer": "3.cn.pool.ntp.org",

"RefreshInterval":652

}

"PreferredNtpServer": "1.cn.pool.ntp.org",

"ServiceEnabled": true

}

响应码：200

【输出说明】

表4-108 查询NTP信息返回值

字段	类型	字段说明
@odata.context	字符串	NTP信息资源模型的OData 描述信息
@odata.id	字符串	NTP信息资源的访问路径
@odata.type	字符串	NTP信息资源的类型
AlternateNtpServer	字符串	次选NTP服务地址
PreferredNtpServer	字符串	首选NTP服务地址
Description	字符串	NTP服务描述
NtpAddressOrigin	字符串	NTP服务器地址模式，当前只支持Static
ServiceEnabled	布尔型	NTP服务器是否使能
Oem.Public.TimeZone	字符串	时区
Oem.Public.TertiaryNtpServer	字符串	三级NTP服务地址
Oem.Public.RefreshInterval	数值	NTP刷新周期，单位秒,最小600秒，最大2592000秒

【修改记录】

(1) HDM-1.30.09 新增字段NtpAddressOrigin

(2) HDM-1.30.12 新增字段Oem.Public.TertiaryNtpServer

(3) HDM-2.13.00新增字段Oem.Public.RefreshInterval

4.4.5 设置NTP信息

【功能描述】

设置NTP信息。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"AlternateNtpServer": AlternateNtpServer,

"PreferredNtpServer": PreferredNtpServer,

"ServiceEnabled": true,

"Oem":{

"Public":{

"TimeZone":"UTC+3",

"TertiaryNtpServer": TertiaryNtpServer,

"RefreshInterval":652

}

【参数说明】

表4-109 设置NTP信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
PreferredNtpServer	字符串	首选NTP服务地址
AlternateNtpServer	字符串	次选NTP服务地址
ServiceEnabled	布尔型	NTP服务器是否使能
Oem.Public.TimeZone	字符串	时区
Oem.Public.TertiaryNtpServer	字符串	三级NTP服务地址
Oem.Public.RefreshInterval	数值	NTP刷新周期，单位秒，最小600秒，最大2592000秒

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/NtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"AlternateNtpServer": "192.168.1.1",

"PreferredNtpServer": "192.168.1.2",

"ServiceEnabled": true,

"Oem":{

"Public":{

"TimeZone":"UTC+3",

"TertiaryNtpServer": "192.168.1.3",

"RefreshInterval":652

}

响应码：200

【输出说明】

返回状态码200，表示操作成功，且返回响应体：

{

"@odata.context": "/redfish/v1/$metadata#NtpService.NtpService",

"@odata.id": "/redfish/v1/Managers/1/NtpService",

"@odata.type": "#NtpService.v1_0_0.NtpService",

"AlternateNtpServer": "192.168.1.1",

"Description": "NtpService Gettings",

"NtpAddressOrigin": "Static",

"Oem": {

"Public": {

"TimeZone": "UTC+3",

"TertiaryNtpServer": "192.168.1.3",

"RefreshInterval":652

}

"PreferredNtpServer": "192.168.1.2",

"ServiceEnabled": false

}

【修改记录】

(1) HDM-1.30.09修改响应码，并新增响应体

(2) HDM-1.30.12新增字段Oem.Public.TertiaryNtpServer

(3) HDM-2.13.00新增字段Oem.Public.RefreshInterval

4.4.6 查询SNMP信息

【功能描述】

查询SNMP信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-110 查询SNMP信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService(SnmpV3PrivProtocol,Id,ReadOnlyCommunity,Name,SnmpV3Enabled,SnmpTrapNotification,LongPasswordEnabled,ReadWriteCommunity,SnmpV2CEnabled,SnmpV3AuthProtocol,SnmpV1Enabled,Actions,Description)",

"@odata.id": "/redfish/v1/Managers/1/SnmpService",

"@odata.type": "#SnmpService.v1_0_0.SnmpService",

"Actions": {

"#SnmpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent"

}

"Description": "SnmpService Gettings",

"Id": "SnmpService",

"LongPasswordEnabled": false,

"Name": "SNMP",

"ReadOnlyCommunity": "******",

"ReadWriteCommunity": "",

"SnmpV3EngineID": "0x80001f880300180a0a0168d72c",

"SnmpTrapNotification": {

"AlarmSeverity": "Minor+Major+Critical",

"CommunityName": "public",

"ServiceEnabled": true,

"TrapMode": "NodeMode",

"TrapServer": [

{

"Enabled": true,

"MemberId": "1",

"TrapServerAddress": "10.99.160.48",

"TrapServerPort": 65535

{

"Enabled": true,

"MemberId": "2",

"TrapServerAddress": "10.99.160.216",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "3",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "4",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "5",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "6",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "7",

"TrapServerAddress": "",

"TrapServerPort": 162

{

"Enabled": true,

"MemberId": "8",

"TrapServerAddress": "",

"TrapServerPort": 162

}

"TrapServerIdentity": "HDM638889",

"TrapV3User": "",

"TrapVersion": "v2c"

"SnmpV1Enabled": false,

"SnmpV2CEnabled": true,

"SnmpV3AuthProtocol": "",

"SnmpV3Enabled": true,

"SnmpV3PrivProtocol": ""

}

响应码：200

【输出说明】

表4-111 查询SNMP信息返回值

字段	类型	字段说明
@odata.context	字符串	SNMP信息资源模型的OData 描述信息
@odata.id	字符串	SNMP信息资源的访问路径
@odata.type	字符串	SNMP信息资源的类型
Actions	Actions指定管理资源可执行的操作
SnmpService.SubmitTestEvent	对象	SNMP测试报警操作
Description	字符串	SNMP资源描述
Id	字符串	SNMP资源的ID
LongPasswordEnabled	布尔型	超长口令使能状态
Name	字符串	SNMP资源的名称
ReadOnlyCommunity	字符串	只读团体名
ReadWriteCommunity	字符串	读写团体名
SnmpTrapNotification.CommunityName	字符串	Trap团体名
SnmpTrapNotification.ServiceEnabled	字符串	Trap服务使能状态
SnmpTrapNotification.TrapMode	字符串	Trap模式： NodeMode：模块OID模式 EventMode：事件OID模式
SnmpTrapNotification.AlarmSeverity	字符串	可修改的告警等级，包括： "Major+Critical" "Minor+Major+Critical" "All" 为腾讯CID时，等级包括： "Critical" "Warning+Critical" "All"
SnmpTrapNotification.TrapServer	Trap服务器参数数组集合
TrapServer.Enabled	布尔型	Trap服务器使能
TrapServer.MemberId	字符串	Trap服务器ID：1~8
TrapServer.TrapServerAddress	字符串	Trap服务器地址
TrapServer.TrapServerPort	数值	Trap服务器端口号
SnmpTrapNotification.TrapServerIdentity	字符串	主机标识
SnmpTrapNotification.TrapV3User	字符串	V3用户
SnmpTrapNotification.TrapVersion	字符串	Trap版本
SnmpV1Enabled	布尔型	Snmp V1使能
SnmpV2CEnabled	布尔型	Snmp V2C使能
SnmpV3AuthProtocol	字符串	SnmpV3鉴权算法： sha md5
SnmpV3Enabled	布尔型	Snmp V3使能
SnmpV3PrivProtocol	字符串	SnmpV3加密算法： des aes
SnmpV3EngineID	字符串	SNMP引擎ID，自动生成

【修改记录】

(1) HDM-1.12.05：接口删除

(2) HDM-1.30.06：接口新增，相对B02版本主要修改：新增字段AlarmSeverity，支持4个TrapServer

(3) HDM-1.30.09：字段TrapServer.TrapServerPort类型从字符串修改成数值

(4) HDM-1.30.10：字段AlarmSeverity值取值为："Critical","Major+Critical","ALL"

(5) HDM-1.30.11：字段新增SnmpTrapNotification.TrapMode

(6) HDM-1.30.11P01：字段AlarmSeverity值取值为："Critical","Minor+Major+Critical","All"

(7) HDM-1.30.12：字段AlarmSeverity返回值中"ALL"修改成"All"；腾讯CID下AlarmSeverity取值为"Critical","Warning+Critical ","All"

(8) HDM-2.10.00：字段AlarmSeverity的可选值由" Critical"修改成"Major+Critical"

(9) HDM-2.33：SnmpTrap新增支持到8个服务器

(10) HDM-6.13：返回体中新增SnmpV3EngineID字段

4.4.7 设置SNMP信息

【功能描述】

设置SNMP信息。

说明：设置SNMP V3用户前需使能对应用户的SNMP扩展权限。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"SnmpV1Enabled":false,

"SnmpV2CEnabled":true,

"SnmpV3Enabled":true,

"LongPasswordEnabled":false,

"ReadOnlyCommunity":readonlycommunity,

"ReadWriteCommunity":readwritecommunity,

"CommunityName":communityname,

"ServiceEnabled":true,

"TrapVersion":"v3",

"TrapV3User":username,

"AlarmSeverity": alarmseverity,

"TrapMode": trapmode,

"TrapServer":

[

{

"MemberId":"1",

"Enabled":true,

"TrapServerPort":TrapServer1_portnumber,

"TrapServerAddress": TrapServer1_address

}

]

}

【参数说明】

表4-112 设置SNMP信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
SnmpV1Enabled	布尔型	SNMP协议版本1使能状态
SnmpV2CEnabled	布尔型	SNMP协议版本2使能状态
LongPasswordEnabled	布尔型	超长口令使能状态
ReadOnlyCommunity	字符串	只读团体名字符串为空表明是删除
ReadWriteCommunity	字符串	读写团体名字符串为空表明是删除
CommunityName	字符串	Trap团体名，最大长度31
ServiceEnabled	字符串	Trap服务使能
TrapVersion	字符串	Trap版本：v1、v2c、v3 注：选择v3时，不需要携带CommunityName参数
TrapV3User	字符串	Trap V3用户
AlarmSeverity	字符串	告警等级：可修改的告警等级，包括： "Major+Critical" "Minor+Major+Critical" "All" 为腾讯CID时，等级包括： "Critical" "Warning+Critical" "All"
TrapMode	字符串	Trap模式： NodeMode：模块OID模式 EventMode：事件OID模式
TrapServer	Trap服务器参数数组集合注：设置V3的TrapServer时，需要设置TrapV3User选项
TrapServer.MemberId	字符串	Trap服务器ID：1~8
TrapServer.Enabled	布尔型	Trap服务器使能
TrapServer.TrapServerPort	数值	Trap服务器端口号
TrapServer.TrapServerAddress	字符串	Trap服务器地址，支持IPv4 IPv6
SnmpV3Enabled	布尔型	SNMP协议版本3使能状态（关闭时，只关闭SNMP功能，不影响trap）

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/SnmpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"SnmpV1Enabled":false,

"SnmpV2CEnabled":true,

"SnmpV3Enabled":true,

"LongPasswordEnabled":false,

"ReadOnlyCommunity":"rocommstr",

"ReadWriteCommunity":"rwcommstr",

"CommunityName":"public",

"ServiceEnabled":true,

"TrapVersion":"v1",

"TrapV3User":"admin",

"AlarmSeverity": "Major+Critical",

"TrapMode":"EventMode",

"TrapServer":

[

{

"MemberId":"1",

"Enabled":true,

"TrapServerPort":TrapServer1_portnumber,

"TrapServerAddress": TrapServer1_address

}

]

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#SnmpService.SnmpService(SnmpV3PrivProtocol,Id,ReadOnlyCommunity,Name,SnmpV3Enabled,LongPasswordEnabled,ReadWriteCommunity,SnmpV2CEnabled,SnmpV3AuthProtocol,SnmpV1Enabled,SnmpTrapNotification,Description)",

"@odata.id": "/redfish/v1/Managers/1/SnmpService",

"@odata.type": "#SnmpService.v1_0_0.SnmpService",

"Actions": {

"#SnmpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent"

}

"Description": "SnmpService Gettings",

"Id": "SnmpService",

"LongPasswordEnabled": false,

"Name": "SNMP",

"ReadOnlyCommunity": "rocommstr",

"ReadWriteCommunity": "rwcommstr",

"SnmpTrapNotification": {

"AlarmSeverity": "Major+Critical",

"CommunityName": "public",

"ServiceEnabled": true,

"TrapMode":"EventMode",

"TrapServer": [

{

"Enabled": false,

"MemberId": "1",

"TrapServerAddress": "192.168.11.11",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "2",

"TrapServerAddress": "192.168.11.22",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "3",

"TrapServerAddress": "192.168.11.33",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "4",

"TrapServerAddress": "192.168.11.44",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "5",

"TrapServerAddress": "192.168.11.55",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "6",

"TrapServerAddress": "192.168.11.66",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "7",

"TrapServerAddress": "192.168.11.77",

"TrapServerPort": 163

{

"Enabled": false,

"MemberId": "8",

"TrapServerAddress": "192.168.11.88",

"TrapServerPort": 163

}

"TrapServerIdentity": "HDM12345678912345678900",

"TrapV3User": "",

"TrapVersion": "v1"

"SnmpV1Enabled": false,

"SnmpV2CEnabled": true,

"SnmpV3AuthProtocol": "",

"SnmpV3Enabled": false,

"SnmpV3PrivProtocol": ""

}

响应码：200

【输出说明】

返回状态码200，表示操作成功

【修改记录】

(1) HDM-1.12.05:接口删除

(2) HDM-1.30.06:接口新增，相对B02版本主要修改：新增字段AlarmSeverity，将TrapServerPort放到各个TrapServer配置下，支持4个TrapServer。

(3) HDM-1.30.09:字段TrapServer.TrapServerAddress，新增IPv6支持；增加响应体

(4) HDM-1.30.10:字段AlarmSeverity值取值为："Critical","Major+Critical","All"

(5) HDM-1.30.11:字段新增SnmpTrapNotification.TrapMode

(6) HDM-1.30.11P01:字段AlarmSeverity值取值为："Critical","Minor+Major+Critical","All"

(7) HDM-1.30.12:腾讯CID下AlarmSeverity取值为"Critical","Warning+Critical ","All"

(8) HDM-2.10.00:字段AlarmSeverity的可选值由" Critical"修改成"Major+Critical"

(9) HDM-2.25:字符串ReadOnlyCommunity、ReadWriteCommunity添加为空处理

(10) HDM-2.33: SnmpTrap新增支持到8个服务器

(11) HDM-2.52: TrapVersion选择v3时，不需要携带CommunityName参数

(12) HDM-6.13：新增字段SnmpV3Enabled，取值true或者false

4.4.8 发送SNMP测试警报

【功能描述】

发送SNMP测试警报。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SnmpService/Actions/SnmpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"MemberId": "id"

}

【参数说明】

表4-113 发送SNMP测试警报参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
MemberId	字符串	Trap成员ID：1~8

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SnmpService/Actions/SnmpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"MemberId":"1" --

}

【响应样例】

响应码：200

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

【输出说明】

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息。
@odata.type	字符串	消息资源的OData描述信息
@Message.ExtendedInfo	字符串	错误消息扩展信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性Redfish支持的严重级别包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改记录】

(1) HDM-1.12.05 接口删除

(2) HDM-1.30.06 接口新增，接口新增，相对B02版本修改：新增字段MemberId

(3) HDM-1.30.09增加响应体

(4) HDM-2.33: SnmpTrap新增支持到8个服务器

4.4.9 查询SMTP信息

【功能描述】

查询SMTP信息。非admin用户只能查看自身的RecipientAddresses信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-114 查询SMTP信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SmtpService.SmtpService(AnonymousLoginEnabled,ServerPort,Name,ServiceEnabled,Id,RecipientAddresses,TLSEnabled,SenderAddress,Description,AlarmSeverity,Actions,ServerAddress)",

"@odata.id": "/redfish/v1/Managers/1/SmtpService",

"@odata.type": "#SmtpService.v1_0_0.SmtpService",

"Actions": {

"#SmtpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent"

}

"AlarmSeverity": "Critical",

"AnonymousLoginEnabled": true,

"Description": "Smtpservice Gettings",

"Id": "Smtp",

"Name": "Smtp",

"RecipientAddresses": [

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "1"

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "9"

…

"SenderAddress": "",

"ServerAddress": "",

"ServerPort": 25,

"ServiceEnabled": true,

"TLSEnabled": false

}

【输出说明】

表4-115 查询SMTP返回值

字段	类型	字段说明
@odata.context	字符串	SMTP信息资源模型的OData 描述信息
@odata.id	字符串	SMTP信息资源的访问路径
@odata.type	字符串	SMTP信息资源的类型
Actions	Actions指定管理资源可执行的操作
SmtpService.SubmitTestEvent	对象	SMTP测试报警操作
AlarmSeverity	字符串	可修改的告警等级，包括： "Critical" "Major+Critical" "Minor+Major+Critical" "All" 为腾讯CID时，等级包括： "Critical" "Warning+Critical" "All"
AnonymousLoginEnabled	布尔型	匿名登录使能
SenderAddress	字符串	发送者地址
ServerAddress	字符串	服务地址
ServerPort	数值	服务端口
ServiceEnabled	布尔型	服务使能
TLSEnabled	布尔型	TLS使能
RecipientAddresses.EmailAddress	字符串	接收者邮件地址
RecipientAddresses.Enabled	布尔型	接收者邮件使能
RecipientAddresses.MemberId	字符串	接收告警邮件地址的ID

【修改记录】

(1) HDM-1.30.08:新增字段AlarmSeverity

(2) HDM-1.30.09:字段AlarmSeverity值取值为："Critical","Warning+Critical","ALL"

(3) HDM-1.30.10:字段AlarmSeverity值取值为："Critical","Major+Critical","ALL"

(4) HDM-1.30.11P01:字段AlarmSeverity值取值为："Critical","Minor+Major+Critical","All"

(5) HDM-1.30.12:字段AlarmSeverity返回值中"ALL"修改成"All"；腾讯CID下AlarmSeverity取值为"Critical","Warning+Critical ","All"

(6) HDM-3.30:字段AlarmSeverity新增支持"Major+Critical"

4.4.10 设置SMTP信息

【功能描述】

设置SMTP信息。

【所属权限模块】

常规配置

说明：非Administrator角色权限组中的用户只能配置自身的RecipientAddresses。

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"ServiceEnabled":true,

"ServerAddress":serveraddress,

"ServerPort":portnumber,

"TLSEnabled":false,

"AnonymousLoginEnabled":false,

"SenderUserName":username,

"SenderPassword":password,

"SenderAddress":senderaddress,

"AlarmSeverity": AlarmSeverity_value,

"RecipientAddresses":[

{

"MemberId":"15",

"Enabled":false,

"UserName":"admin",

"Description":"1"

}

]

}

【设置说明】

请求体当中的字段必须要全部一起设置，否则会引起配置错误。

【参数说明】

表4-116 设置SMTP返回值

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
ServiceEnabled	布尔型	SMTP使能
ServerAddress	字符串	服务地址
ServerPort	数值	服务端口
TLSEnabled	布尔型	TLS使能
AnonymousLoginEnabled	布尔型	匿名登录使能
SenderUserName	字符串	发送者用户名
SenderPassword	字符串	发送者密码
SenderAddress	字符串	发送者地址
AlarmSeverity	字符串	可修改的告警等级，包括： "Critical" "Major+Critical" "Minor+Major+Critical" "All" 为腾讯CID时，等级包括： "Critical" "Warning+Critical" "All"
RecipientAddresses	PEF/告警邮件/设置接收告警的邮件地址
RecipientAddresses.MemberId	字符串	成员ID (1~15)
RecipientAddresses.Enabled	布尔型	添加删除改成员ID的告警邮件配置
RecipientAddresses.UserName	字符串	用户名
RecipientAddresses.Description	字符串	主题

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/SmtpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"ServiceEnabled":true,

"ServerAddress":"192.168.1.3",

"ServerPort":26,

"TLSEnabled":false,

"AnonymousLoginEnabled":false,

"SenderUserName":"Public",

"SenderPassword":"public@123",

"SenderAddress":"[email protected]",

"AlarmSeverity": "Critical",

"RecipientAddresses":[

{

"MemberId":"15",

"Enabled":false,

"UserName":"admin",

"Description":"1"

{

"MemberId":"1",

"Enabled":false,

"UserName":"admin",

"Description":"2"

…

]

}

【响应样例】

{

"@odata.id": "/redfish/v1/Managers/1/SmtpService",

"@odata.type": "#SmtpService.v1_0_0.SmtpService",

"Actions": {

"#SmtpService.SubmitTestEvent": {

"target": "/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent"

}

"AlarmSeverity": "Critical",

"AnonymousLoginEnabled": false,

"Description": "Smtpservice Gettings",

"Id": "Smtp",

"Name": "Smtp",

"RecipientAddresses": [

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "1"

{

"EmailAddress": "",

"Enabled": false,

"MemberId": "2"

…

"SenderAddress": "[email protected]",

"SenderPassword": "null",

"SenderUserName": "Public",

"ServerAddress": "192.168.1.3",

"ServerPort": 26,

"ServiceEnabled": true,

"TLSEnabled": false

}

【输出说明】

返回状态码200，表示操作成功。

返回字段说明同“查询SMTP信息”。

【修改记录】

(1) HDM-1.30.08：新增字段AlarmSeverity

(2) HDM-1.30.09：字段AlarmSeverity值取值为："Critical","Warning+Critical","All"

(3) HDM-1.30.10：字段AlarmSeverity值取值为："Critical","Major+Critical","All":

(4) HDM-1.30.10：新增字段RecipientAddresses{MemberId,Enabled,UserName,Description}

(5) HDM-1.30.11P01：字段AlarmSeverity值取值为："Critical","Minor+Major+Critical","All"

(6) HDM-1.30.12：字段MemberId类型从数值修改成字符串；腾讯CID下AlarmSeverity取值为"Critical","Warning+Critical ","All"

(7) HDM-2.17.00：添加限制：非Administrator角色权限组中的用户只能配置自身的RecipientAddresses

(8) HDM-3.30：字段AlarmSeverity新增支持"Major+Critical"

4.4.11 发送SMTP测试警报

【功能描述】

发送SMTP测试警报。

【所属权限模块】

常规配置

说明：非Administrator角色权限组中的用户只能测试发送自身邮箱。

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SmtpService/Actions/SmtpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"MemberId": "id"

}

【参数说明】

表4-117 发送SMTP测试警报信息说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
MemberId	字符串	接收告警邮件地址的ID

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SmtpService/Actions/SmtpService.SubmitTestEvent

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"MemberId": "1"

}

【应答示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

响应码 200

【输出说明】

返回状态码200，表示操作成功。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
@Message.ExtendedInfo.Message	字符串	ExtendedInfo中详细信息
MessageId	字符串	消息ID
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) HDM-1.30.09：修改响应码为200，增加响应体

(2) HDM-2.17.00添加限制：非Administrator角色权限组中的用户只能测试发送自身邮箱

(3) HDM-6.02：修正字段为Message

4.4.12 查询SYSLOG信息

【功能描述】

查询SYSLOG信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-118 查询SYSLOG信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SyslogService.SyslogService(*)",

"@odata.id": "/redfish/v1/Managers/1/SyslogService",

"@odata.type": "#HwSyslogService.v1_0_0.HwSyslogService",

"Actions": {

"#SyslogService.ImportClientCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportClientCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate"

"#SyslogService.ImportPrivateKeyCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportPrivateKeyCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate"

"#SyslogService.ImportRootCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportRootCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate"

}

"#SyslogService.SubmitTestEvent": {

"target":"/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent",

"@Redfish.ActionInfo":"/redfish/v1/Managers/1/SyslogService/SubmitTestEventActionInfo"

}

"AlarmSeverity": "Normal",

"AuthenticateMode": "TwoWay",

"Id": "SyslogService",

"Name": "Syslog Service",

"ServerIdentitySource": "HostName",

"MessageFormat":"Custom",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "10.99.205.123",

"Enabled": true,

"LogType": [

"OperationLog"

"MemberId": "1",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"LogType": [],

"MemberId": "2",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"LogType": [],

"MemberId": "3",

"Port": 514

{

"Address": "10.0.0.1",

"Enabled": true,

"LogType": [

"OperationLog",

"EventLog",

"SecurityLog"

"MemberId": "4",

"Port": 514

{

"Address": "192.168.10.51",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "5",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "6",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "7",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "8",

"Port": 514

}

"TransmissionProtocol": "UDP"

}

响应码：200

【输出说明】

表4-119 查询SYSLOG信息返回值

字段	类型	字段说明
@odata.context	字符串	SYSLOG信息资源模型的OData 描述信息
@odata.id	字符串	SYSLOG信息资源的访问路径
@odata.type	字符串	SYSLOG信息资源的类型
ServiceEnabled	布尔型	SYSLOG服务是否使能
AlarmSeverity	字符串	日志等级： Normal
TransmissionProtocol	字符串	SYSLOG服务传输协议： "UDP"、 "TCP"、 "TLS"
MessageFormat	字符串	SYSLOG报文格式： "Custom"、 "RFC3164"、 "RFC5424"
AuthenticateMode	字符串	认证模式 OneWay TwoWay
ServerIdentitySource	字符串	SYSLOG主机标识：主机名"HostName" 主板序列号"BoardSN" 产品资产标签"ProductAssetTag" 产品序列号”ProductSN”
SyslogServers.Address	字符串	SyslogServers服务地址
SyslogServers.Enabled	布尔型	SyslogServers服务是否使能
SyslogServers.MemberId	字符串	SyslogServers服务序列号：1~8
SyslogServers.Port	数值	SyslogServers服务端口
SyslogServers.LogType	数组	SyslogServers服务日志类型：操作日志"OperationLog", 事件日志 "EventLog", 安全日志"SecurityLog"
Actions	Syslog 资源的 action 相关操作
SyslogService.ImportRootCertificate	对象	导入 syslog 根证书
target	字符串	操作路径
Redfish.ActionInfo	字符串	操作信息查询路径
SyslogService.ImportClientCertificate	对象	导入 syslog 本地证书
SyslogService.SubmitTestEvent	对象	发送测试事件

【修改记录】

(1) HDM-1.30.08：版本接口不可用

(2) HDM-1.30.09：适应新Syslog需求，版本接口功能恢复，但变动较大，需重新适配

(3) HDM-1.30.10：字段ServerIdentitySource内容修改："Host name","Product Serial number","Asset tag"

(4) HDM-1.30.11：字段ServerIdentitySource内容修改："HostName","ProductSN","ProductAssetTag"

(5) (仅)HDM-1.30.18P5X,B05：字段ServerIdentitySource中删除ProductSN添加BoardSN；

(6) (仅)HDM-1.30.18P5X,B05：字段TransmissionProtocol新增TLS取值，新增字段AuthenticateMode, Actions

(7) HDM-2.11.92：新增字段@odata.type

(8) HDM-2.33：Syslog新增支持到8个服务器

(9) HDM-2.75：字段ServerIdentitySource新增值ProductSN

(10) HDM-3.35：新增字段SyslogService.SubmitTestEvent

(11) HDM-6.03：Syslog新增MessageFormat字段

4.4.13 设置SYSLOG信息

【功能描述】

设置SYSLOG信息。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"ServerIdentitySource": "HostName",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "192.168.10.11",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "1",

"Port": 514

}

"TransmissionProtocol": "UDP",

"MessageFormat": "Custom"

}

响应码：200

【参数说明】

表4-120 设置SYSLOG信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
ServiceEnabled	布尔型	SYSLOG服务是否使能
TransmissionProtocol	字符串	SYSLOG服务传输协议："UDP"、"TCP"、"TLS"
MessageFormat	字符串	SYSLOG报文格式："Custom"、"RFC3164"、"RFC5424" 不指定该字段时，默认使用"Custom"
AuthenticateMode	字符串	认证模式 OneWay TwoWay
ServerIdentitySource	字符串	SYSLOG主机标识：主机名"HostName" 产品序列号"BoardSN" 产品资产标签"ProductAssetTag" 产品序列号”ProductSN”
SyslogServers.Address	字符串	SyslogServers服务地址
SyslogServers.Enabled	布尔型	SyslogServers服务是否使能
SyslogServers.MemberId	字符串	SyslogServers服务序列号：1~8
SyslogServers.Port	数字	SyslogServers服务端口
SyslogServers.LogType	数组	SyslogServers服务日志类型：操作日志"OperationLog", 事件日志 "EventLog", 安全日志"SecurityLog"

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/SyslogService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"ServerIdentitySource": "HostName",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "192.168.10.11",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "1",

"Port": 514

}

"TransmissionProtocol": "UDP",

"MessageFormat": "Custom"

}

响应码：200

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/SyslogService",

"@odata.type": "#SyslogService.v1_0_0.SyslogService",

"Id": "SyslogService",

"Name": "Syslog Service",

"Actions": {

"#SyslogService.ImportClientCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportClientCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportClientCertificate"

"#SyslogService.ImportPrivateKeyCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportPrivateKeyCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportPrivateKeyCertificate"

"#SyslogService.ImportRootCertificate": {

"@Redfish.ActionInfo": "/redfish/v1/Managers/1/SyslogService/ImportRootCertificateActionInfo",

"target": "/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.ImportRootCertificate"

}

"ServerIdentitySource": "HostName",

"ServiceEnabled": true,

"SyslogServers": [

{

"Address": "192.168.10.11",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "1",

"Port": 514

{

"Address": "192.168.10.22",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "2",

"Port": 514

{

"Address": "192.168.10.33",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "3",

"Port": 514

{

"Address": "192.168.10.44",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "4",

"Port": 514

{

"Address": "192.168.10.51",

"Enabled": true,

"LogType": [

"EventLog",

"SecurityLog"

"MemberId": "5",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "6",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "7",

"Port": 514

{

"Address": "127.0.0.1",

"Enabled": false,

"MemberId": "8",

"Port": 514

}

"TransmissionProtocol": "UDP",

"MessageFormat": "Custom"

}

【修改记录】

(1) HDM-1.30.08：版本接口不可用

(2) HDM-1.30.09：适应新Syslog需求，版本接口功能恢复，但变动较大，需重新适配

(3) HDM-1.30.10：字段ServerIdentitySource内容修改："Host name","Product Serial number","Asset tag"

(4) HDM-1.30.11：字段ServerIdentitySource内容修改："HostName","ProductSN","ProductAssetTag"

(5) (仅)HDM-1.30.18P5X,B05：字段ServerIdentitySource中删除ProductSN添加BoardSN；

(6) (仅)HDM-1.30.18P5X,B05：字段TransmissionProtocol新增TLS取值，新增字段AuthenticateMode, Actions

(7) HDM-2.33: Syslog新增支持到8个服务器

(8) HDM-2.75：字段ServerIdentitySource新增值ProductSN

(9) HDM-6.03:Syslog新增MessageFormat字段，不指定该字段时，默认使用"Custom"

4.4.14 SYSLOG发送测试事件

【功能描述】

发送测试事件

【命令格式】

【请求头】

X-Auth-Token: auth_value

Content-Type: header_type

【请求消息体】

{

"MemberId":value

}

【参数说明】

表4-121 SYSLOG发送测试事件参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
manager_id	管理资源ID	针对机架服务器，取值为1 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade0” 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N表示交换模块槽位号），例如“Swi0”
auth_value	请求消息的鉴权参数	可通过/redfish/v1/SessionService/Sessions创建会话时获得
header_type	请求消息的格式	支持的消息格式包括： application/json application/json;charset=utf-8
value	序号	字符，可用范围0~3

【使用指南】

无

【使用实例】

请求样例：

POST https://10.10.10.10/redfish/v1/Managers/1/SyslogService/Actions/SyslogService.SubmitTestEvent

请求头：

X-Auth-Token: 6599174c38c36838737d9749179e1ee1

Content-Type: application/json

请求消息体：

{

"MemberId":"0"

}

响应样例：

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.Success",

"RelatedProperties": [],

"Message": "Successfully Completed Request",

"MessageArgs": [],

"Severity": "OK",

"Resolution": "None"

}

]

}

响应码：200

【输出说明】

表4-122 Syslog发送测试事件信息

字段	类型	说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性 Redfish支持的严重级别包括：OK、Warning、Critical
Resolution	字符串	解决建议

【修改记录】

(1) HDM-3.35：接口新增

4.4.15 导入Syslog根证书

【功能描述】

导入Syslog根证书。

【所属权限模块】

安全配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/

SyslogService.ImportRootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":type,

"Content":value

}

【参数说明】

表4-123 查询SYSLOG信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
type	导入syslog证书的方式	text，表明value值是证书内容 URI，表明value值是URI（本地或者远程）
value	内容	1：可以是证书的内容 2：可以是证书远程路径（支持的文件传输的协议有sftp） 3： value的含义由type表示

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/

SyslogService.ImportRootCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cacert.pem"

}

【应答示例】

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.CertImportOKNone",

"RelatedProperties": "[]",

"Message": "The certificate has been imported successfully.",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

响应码：200

【输出说明】

表4-124 导入根证书信息返回值

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性 Redfish支持的严重级别包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改历史】

(1) (仅)HDM-1.30.18P5X,B05：接口新增

4.4.16 导入本地证书

【功能描述】

导入Syslog本地证书。

【所属权限模块】

安全配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/

SyslogService.ImportClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":type,

"Content":value

}

【参数说明】

表4-125 导入本地证书参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
type	导入syslog证书的方式	text，表明value值是证书内容 URI，表明value值是URI（本地或者远程）
value	内容	1：可以是证书的内容 2：可以是证书远程路径（支持的文件传输的协议有sftp） 3： value的含义由type表示

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/

SyslogService.ImportClientCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/cert.pem"

}

【应答示例】

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.CertImportOKNone",

"RelatedProperties": "[]",

"Message": "The certificate has been imported successfully.",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

响应码：200

【输出说明】

表4-126 导入本地证书信息返回值

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性 Redfish支持的严重级别包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改历史】

(1) (仅)HDM-1.30.18P5X,B05：接口新增

4.4.17 导入私钥证书

【功能描述】

导入私钥证书。

【所属权限模块】

安全配置

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/SyslogService/Actions/

SyslogService.ImportPrivateKeyCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":type,

"Content":value

}

【参数说明】

表4-127 导入私钥证书信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
type	导入syslog证书的方式	text，表明value值是证书内容 URI，表明value值是URI（本地或者远程）
value	内容	1：可以是证书的内容 2：可以是证书远程路径（支持的文件传输的协议有sftp） 3： value的含义由type表示

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/SyslogService/Actions/

SyslogService.ImportPrivateKeyCertificate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type": "URI",

"Content":"sftp://y17057:[email protected]/key.pem"

}

【应答示例】

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.CertImportOKNone",

"RelatedProperties": "[]",

"Message": "The certificate has been imported successfully.",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

响应码：200

【输出说明】

表4-128 导入私钥证书信息返回值

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性 Redfish支持的严重级别包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改历史】

(1) (仅)HDM-1.30.18P5X,B05：接口新增

4.4.18 查询服务信息

【功能描述】

查询HTTPS、IPMI、KVM、SNMP、SSH、虚拟媒体、Remote-Xdp|iHDT、VNC等服务的端口信息及使能情况等。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-129 查询服务信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",

"@odata.type": "#ManagerNetworkProtocol.v1_2_0.ManagerNetworkProtocol",

"CD-Media": {

"Port": 5120,

"ProtocolEnabled": true

"Description": "Network Protocol Details",

"FQDN": "HDM638889.h3c.com",

"FD-Media": {

"Port": 5122,

"ProtocolEnabled": true

"HTTP": {

"Port": 80,

"ProtocolEnabled": true

"HTTPS": {

"Port": 443,

"ProtocolEnabled": true

"HD-Media": {

"Port": 5123,

"ProtocolEnabled": true

"HostName": "HDM638889",

"IPMI": {

"Port": 623,

"ProtocolEnabled": true

"Id": "NetworkProtocol",

"KVMIP": {

"Port": 7578,

"ProtocolEnabled": true

"Name": "Manager Network Protocol",

"Remote-Xdp": {

"Port": 6868,

"ProtocolEnabled": false

"SNMP": {

"Port": 161,

"ProtocolEnabled": true

"SSH": {

"Port": 22,

"ProtocolEnabled": true

"Status": {

"Health": "OK",

"State": "Enabled"

"Telnet": {

"Port": 23,

"ProtocolEnabled": false

"VNC": {

"Port": 5900,

"ProtocolEnabled": false

}

响应码：200

【输出说明】

表4-130 查询服务返回值

字段	类型	字段说明
@odata.context	字符串	服务信息资源模型的OData 描述信息
@odata.id	字符串	服务信息资源的访问路径
@odata.type	字符串	服务信息资源的类型
Description	字符串	服务信息资源的描述
HTTPS.Port	数值	HTTPS服务端口（Web服务的安全端口）
HTTPS.ProtocolEnabled	布尔型	HTTPS服务使能
HTTP.Port	数值	HTTP服务端口（Web服务的非安全端口）
HTTP.ProtocolEnabled	布尔型	HTTP服务使能
IPMI.Port	数值	IPMI非安全端口
IPMI.ProtocolEnabled	布尔型	IPMI服务使能
KVMIP.Port	数值	KVM非安全端口
KVMIP.ProtocolEnabled	布尔型	KVM服务使能
Remote-Xdp.Port或 iHDT.Port	数值	Xdp或iHDT非安全端口 Intel机型显示Remote-Xdp G5-AMD机型显示iHDT
Remote-Xdp.ProtocolEnabled或 iHDT. ProtocolEnabled	布尔型	Xdp或iHDT服务使能 Intel机型显示Remote-Xdp G5-AMD机型显示iHDT
SNMP.Port	数值	SNMP非安全端口
SNMP.ProtocolEnabled	布尔型	SNMP服务使能
SSH.Port	数值	SSH安全端口
SSH.ProtocolEnabled	布尔型	SSH服务使能
FD-Media.Port	数值	FD媒体非安全端口
FD-Media.ProtocolEnabled	布尔型	FD媒体使能
CD-Media.Port	数值	CD媒体非安全端口
CD-Media.ProtocolEnabled	布尔型	CD媒体使能
HD-Media.Port	数值	HD媒体非安全端口
HD-Media.ProtocolEnabled	布尔型	HD媒体使能
Telnet Port	数值	Telnet非安全端口
Telnet.ProtocolEnabled	布尔型	Telnet服务使能
VNC.Port	数值	VNC非安全端口
VNC.ProtocolEnabled	布尔型	VNC服务使能
HostName	字符串	主机名
FQDN	字符串	HDM的全称域名
Id	字符串	服务信息的ID名称
Name	字符串	服务集合资源名称
Status.Health	字符串	健康状态
Status.State	字符串	使能状态

【修改记录】

(1) HDM-1.30.09版本：新增字段HTTP、Remote、Solssh、Fd-Media、Cd-Media、Hd-Media、Telnet、VNC、FQDN

(2) HDM-1.30.10版本：字段名称Cd-Media Fd-Media Hd-Media 修改成CD-Media FD-Media HD-Media

(3) HDM-1.30.11版本：删除获取Solssh服务信息

(4) HDM-1.30.14版本：IPMI.Port仅指非安全端口

(5) HDM-2.19版本：新增iHDT服务支持

4.4.19 设置服务信息

【功能描述】

设置IPMI、KVM、SNMP、SSH、虚拟媒体、Remote-Xdp|iHDT、VNC等服务的端口信息及使能状态。

【所属权限模块】

安全配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"ServerType": {

"Port": portid,

"ProtocolEnabled": state

}

【参数说明】

表4-131 设置服务信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
ServerType	待设置的服务类型	可修改的服务类型，包括： IPMI、KVMIP、SNMP、SSH、CD-Media、VNC、Remote-Xdp\|iHDT
ServerType.Port	数值	服务端口号(端口号说明参考【查询服务信息】，为IPMI端口时指非安全端口)
ServerType.ProtocolEnabled	布尔型	服务的使能状态：true或者false

【使用指南】

每次只修改一个服务的参数。

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/NetworkProtocol

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"SSH": {

"Port": 123,

"ProtocolEnabled": true

}

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata#ManagerNetworkProtocol.ManagerNetworkProtocol",

"@odata.id": "/redfish/v1/Managers/1/NetworkProtocol",

"@odata.type": "#ManagerNetworkProtocol.v1_2_0.ManagerNetworkProtocol",

"CD-Media": {

"Port": 777,

"ProtocolEnabled": true

"Description": "Network Protocol Details",

"FD-Media": {

"Port": 5122,

"ProtocolEnabled": true

"FQDN": "HDM22222A45B0B004.h3c.com",

"HD-Media": {

"Port": 5123,

"ProtocolEnabled": true

"HTTP": {

"Port": 80,

"ProtocolEnabled": true

"HTTPS": {

"Port": 443,

"ProtocolEnabled": true

"HostName": "HDM22222A45B0B004",

"IPMI": {

"Port": 664,

"ProtocolEnabled": true

"Id": "NetworkProtocol",

"KVMIP": {

"Port": 7578,

"ProtocolEnabled": true

"Name": "Manager Network Protocol",

"Remote-Xdp": {

"Port": 6868,

"ProtocolEnabled": false

"SNMP": {

"Port": 161,

"ProtocolEnabled": true

"SSH": {

"Port": 123,

"ProtocolEnabled": true

"Solssh": {

"Port": 52123,

"ProtocolEnabled": false

"Status": {

"Health": "OK",

"State": "Enabled"

"Telnet": {

"Port": 23,

"ProtocolEnabled": false

"VNC": {

"Port": 5900,

"ProtocolEnabled": true

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

【修改记录】

(1) HDM-1.30.10版本：字段VirtualMedia修改成CD-Media

(2) HDM-1.30.14版本：ServerType.Port，为IPMI端口时指非安全端口

(3) HDM-2.19版本：新增iHDT服务支持

(4) HDM-2.27版本：支持Remote-Xdp设置

4.4.20 HDM重启

【功能描述】

HDM重启。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType":type

}

【参数说明】

表4-132 HDM重启参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ResetType	字符串	ForceRestart重启HDM

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Manager.Reset

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ResetType":"ForceRestart"

}

【应答示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
@Message.ExtendedInfo.Message	字符串	ExtendedInfo中详细信息
MessageId	字符串	消息ID
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) HDM-1.30.09：修改响应码为200，增加响应体

(2) HDM-6.02：修正字段为Message

4.4.21 HDM主备切换

【功能描述】

HDM固件主备切换。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Manager.RollBack

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【参数说明】

表4-133 HDM主备切换参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/Actions/Manager.RollBack

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

}

【应答示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageId": "Base.1.0.Success",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
@Message.ExtendedInfo.Message	字符串	ExtendedInfo中详细信息
MessageId	字符串	消息ID
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) 1.30.09：响应码为200，增加响应体

(2) HDM-6.02：修正字段为Message

4.4.22 查询网口列表

【功能描述】

查询网口列表。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-134 查询网口列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",

"@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",

"Description": "Collection of Ethernet Interfaces for this Manager",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0"

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1"

}

"Name": "Ethernet Network Interface Collection",

"Oem": {

"Public": {

"PortMode": "Bonding",

"NcsiEnabled"：false

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

表4-135 查询网口列表信息返回值

字段	类型	字段说明
@odata.context	字符串	网口列表资源的OData描述信息
@odata.id	字符串	网口集合资源的访问路径
@odata.type	字符串	网口集合资源类型
Description	字符串	网络列表资源信息的描述
Members	数组	网口列表信息查询路径
[email protected]	数值	网口设备个数
Oem.Public.PortMode	字符串	网口模式： Normal：正常模式 Bonding：bonding模式 Activestandby: 网口自适应模式
Oem.Public.NcsiEnabled	布尔	NCSI使能 true false

【修改记录】

(1) HDM-1.30.09调整网口集合显示

(2) HDM-1.30.12新增字段Oem.Public.PortMode

(3) HDM-2.52 新增字段Oem.Public.NcsiEnabled

4.4.23 设置网口模式

【功能描述】

设置BMC网口模式

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"Oem":{

"Public":{

"PortMode":value

}

【参数说明】

表4-136 设置网口模式参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
Oem.Public.PortMode	字符串	网口模式： Normal：正常模式 Bonding：bonding模式 Activestandby：网口自适应模式

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Oem":{

"Public":{

"PortMode": "Bonding"

}

【返回示例】

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterfaceCollection.EthernetInterfaceCollection",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces",

"@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",

"Description": "Collection of Ethernet Interfaces for this Manager",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0"

{

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth1"

}

"Name": "Ethernet Network Interface Collection",

"Oem": {

"Public": {

"PortMode": "Bonding"

}

响应码：200

【输出说明】

返回状态码200，表示操作成功。

【修改记录】

(1) HDM-1.30.07接口新增

(2 HDM-1.30.12功能名称从“设置网口自适应开闭”修改成“设置网口模式”；相应的删除字段ActiveStandbyMode；新增字段Oem.Public.PortMode

4.4.24 查询指定网口信息

【功能描述】

查询指定网口信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/networkinterface_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-137 查询网络信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
networkinterface_id	指定网口的ID名称	由网口列表中查询

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

"@odata.id": "/redfish/v1/Managers/manager_id/EthernetInterfaces/eth0",

"@odata.type": "#EthernetInterface.v1_4_0.EthernetInterface",

"AutoNeg": true,

"Description": "Ethernet Interface eth0",

"FQDN": "HDM638889.h3c.com",

"FullDuplex": true,

"HostName": "HDM638889",

"IPv4Addresses": [

{

"Address": "0.0.0.0",

"AddressOrigin": "DHCP",

"Gateway": "0.0.0.0",

"SubnetMask": "0.0.0.0"

}

"IPv6Addresses": [

{

"Address": "fe80::327b:acff:fec1:20ab",

"AddressOrigin": "LinkLocal",

"PrefixLength": 64

}

"IPv6DefaultGateway": "::",

"IPv6StaticAddresses": [],

"Id": "eth0",

"InterfaceEnabled": true,

"Links": {

"Oem": {

"Public": {

"EthernetInterface": {

"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"

}

"MACAddress": "30:7B:AC:C1:20:AB",

"MTUSize": 1500,

"MaxIPv6StaticAddresses": 16,

"Name": "eth0",

"NameServers": [

"10.99.205.2"

"Oem": {

"Public": {

"IPv4Enabled":true,

"IPv6Enabled":true,

"AdaptiveFlag": false,

{

"LinkStatus": "Connected",

"Location": "PCIeSlot1"

"Type": "Dedicated"

{

"LinkStatus": "Connected",

"Location": "PCIeSlot1"

"PortNumber": 0,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"Location": "PCIeSlot1"

"PortNumber": 1,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"Location": "PCIeSlot1"

"PortNumber": 2,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"Location": "PCIeSlot1"

"PortNumber": 3,

"Type": "Shared"

}

]

}

"PermanentMACAddress": "30:7B:AC:C1:20:AB",

"SpeedMbps": 1000,

"Status": {

"Health": "OK",

"State": "Enabled"

"VLAN": {

"VLANEnable": false,

"VLANId": 0

}

响应码：200

【输出说明】

表4-138 查询网口信息返回值

字段	类型	字段说明
@odata.context	字符串	指定网口资源模型的OData描述信息
@odata.id	字符串	指定网口资源的访问路径
@odata.type	字符串	指定网口资源类型
Description	字符串	指定网口资源信息的描述
AutoNeg	布尔型	自动协商是否开启
FQDN	字符串	HDM的全称域名
FullDuplex	布尔型	全双工是否开启
HostName	字符串	主机名
IPv4Addresses.Address	字符串	IPv4地址
IPv4Addresses.AddressOrigin	字符串	IPv4协议类型
IPv4Addresses.Gateway	字符串	IPv4网关
IPv4Addresses.SubnetMask	字符串	IPv4子网掩码
IPv6Addresses.Address	字符串	IPv6地址
IPv6Addresses.AddressOrigin	字符串	IPv6协议类型
IPv6Addresses.PrefixLength	数值	IPv6前缀长度
IPv6DefaultGateway	字符串	IPv6默认网关
IPv6StaticAddresses	数组	IPv6静态地址
Id	字符串	网口ID
Link.Oem.Public.EthernetInterface	数组	网口资源路径
[email protected]	数组
LinkStatus	字符串	端口连接状态： Connected Disconnected
PortNumber	数值	共享端口的端口号
Type	字符串	端口类型： Dedicated专用口 Shared 共享口
InterfaceEnabled	布尔型	网口是否使能
MACAddress	字符串	MAC地址
MTUSize	字符串	MTU最大值
MaxIPv6StaticAddresses	字符串	IPv6静态地址最大长度
Name	字符串	网口名称
NameServers	数组	DNS服务器IP地址信息列表
Oem.Public.IPv4Enabled	布尔	IPv4使能
Oem.Public.IPv6Enabled	布尔	IPv6使能
Oem.Public.AdaptiveFlag	布尔型	端口自适应模式 true：打开 false：关闭
PermanentMACAddress	字符串	固定MAC地址
SpeedMbps	字符串	传输速率，单位Mbps
VLAN.VLANEnable	字符串	VLAN是否使能
VLAN.VLANId	数值	VLAN ID
Status.Health	字符串	健康状态
Status.State	字符串	健康状态使能
Location	字符串	网卡位置：主板显示“mainboard”其余显示PCIeSlot+slot

【修改记录】

(1) HDM-1.30.06 新增字段Oem.Public.AdaptiveFlag

(2) HDM-1.30.09 新增字段Link.Oem.Public.EthernetInterface和IPv6StaticAddresses

(3) HDM-1.30.13新增字段[email protected]{LinkStatus, PortNumber, Type}

(4) HDM-2.92：新增字段Oem.Public.Location

(5) HDM-2.97：新增字段Oem.Public.{IPv4Enabled,IPv6Enabled}

4.4.25 设置网口信息

【功能描述】

设置指定的网口信息。

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/EthernetInterfaces/networkinterface_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"IPv4Addresses":[{

"Address":"10.10.10.10",

"SubnetMask":"255.255.255.0",

"Gateway":"10.10.10.1",

"AddressOrigin":"Static"

}],

"IPv6Addresses":[{

"Address":"2015::1",

"PrefixLength":64,

"AddressOrigin":"Static"

}],

"IPv6StticAddresses":[{

"Address":"2015::1",

"PrefixLength":64

}],

"IPv6DefaultGateway":"2015::9",

"HostName":"HDM2019",

"VLAN":{

"VLANEnable":true,

"VLANId":60

"NameServers": [

"10.10.10.254",

"10.10.10.253"

"Oem":{

"Public":{

"IPv4Enabled":true,

"IPv6Enabled":true

}

【参数说明】

表4-139 设置网络信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
networkinterface_id	网络名称	由网口列表中查询
IPv4Addresses.Address	字符串	IPv4地址
IPv4Addresses.Gateway	字符串	IPv4网关
IPv4Addresses.SubnetMask	字符串	IPv4子网掩码
IPv4Addresses.AddressOrigin	字符串	IPv4地址获取模式： “Static”或“DHCP”
IPv6Addresses.Address	字符串	IPv6地址
IPv6Addresses.PrefixLength	数值	ipv6地址前缀长度
IPv6Addresses.AddressOrigin	字符串	IPv6地址获取模式“Static”或“DHCPv6”
IPv6StaticAddresses	数组	IPv6静态地址
IPv6DefaultGateway	字符串	IPv6默认网关
HostName	字符串	主机名
Vlan	数值	VLAN ID
NameServers	数组	BMC管理网口地址为动态模式时，所需的DNS服务器信息。格式为： [ "主DNS服务器IPv4或IPv6地址", "备DNS服务器IPv4或IPv6地址" ]
Oem.Public.IPv4Enabled	布尔	IPv4使能
Oem.Public.IPv6Enabled	布尔	IPv6使能

【使用说明】

· 当设置IP地址获取模式为“DHCP” 、“DHCPv6”时，不可同时设置其他参数。

· Oem.Public.{IPv4Enabled,IPv6Enabled}两个字段，对共享口全部设置为false时，可用于关闭共享口。注意：专用口暂不支持该方式禁用。

【使用实例1】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/EthernetInterfaces/eth0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"IPv4Addresses":[{

"Address":"10.10.10.10",

"SubnetMask":"255.255.255.0",

"Gateway":"10.10.10.1",

"AddressOrigin":"Static"

}],

"IPv6Addresses":[{

"Address":"2015::1",

"PrefixLength":64,

"AddressOrigin":"Static"

}],

"IPv6StaticAddresses":[{

"Address":"2015::1",

"PrefixLength":64

}],

"IPv6DefaultGateway":"2015::9",

"HostName":"HDM638889",

"VLAN":{

"VLANEnable":true,

"VLANId":60

}

"NameServers": [

"10.10.10.254",

"10.10.10.253"

"Oem":{

"Public":{

"IPv4Enabled":true,

"IPv6Enabled":true

}

响应码：200

【输出说明1】

返回状态码200，返回值如下：

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface",

"@odata.id": "/redfish/v1/Managers/manager_id/EthernetInterfaces/eth0",

"@odata.type": "#EthernetInterface.v1_4_0.EthernetInterface",

"AutoNeg": true,

"Description": "Ethernet Interface eth0",

"FQDN": "HDM638889.h3c.com",

"FullDuplex": true,

"HostName": "HDM638889",

"IPv4Addresses":[

{

"Address":"10.10.10.10",

"SubnetMask":"255.255.255.0",

"Gateway":"10.10.10.1",

"AddressOrigin":"Static"

}

"IPv6Addresses":[

{

"Address": "fe80::c636:6bff:fe3f:aa22",

"AddressOrigin": "LinkLocal",

"PrefixLength": 64

{

"Address":"2015::1",

"PrefixLength":64,

"AddressOrigin":"Static"

}

"IPv6DefaultGateway":"2015::9",

"IPv6StaticAddresses":[

{

"Address":"2015::1",

"AddressOrigin": "Static",

"PrefixLength":64

}

"Id": "eth0",

"InterfaceEnabled": true,

"Links": {

"Oem": {

"Public": {

"EthernetInterface": {

"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces"

}

"MACAddress": "30:7B:AC:C1:20:AB",

"MTUSize": 1500,

"MaxIPv6StaticAddresses": 16,

"Name": "eth0",

"NameServers": [

"10.10.10.254",

"10.10.10.253"

"Oem": {

"Public": {

"IPv4Enabled":true,

"IPv6Enabled":true,

"AdaptiveFlag": false,

{

"LinkStatus": "Connected",

"Type": "Dedicated"

{

"LinkStatus": "Connected",

"PortNumber": 0,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"PortNumber": 1,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"PortNumber": 2,

"Type": "Shared"

{

"LinkStatus": "Disconnected",

"PortNumber": 3,

"Type": "Shared"

}

]

}

"PermanentMACAddress": "30:7B:AC:C1:20:AB",

"SpeedMbps": 1000,

"Status": {

"Health": "OK",

"State": "Enabled"

"VLAN":{

"VLANEnable":true,

"VLANId":60

}

【使用实例2-关闭共享口】

【请求样例】

PATCH https://192.168.34.157/redfish/v1/Managers/1/EthernetInterfaces/eth0

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Oem":{

"Public":{

"IPv4Enabled":false,

"IPv6Enabled":false

}

响应码：200

【输出说明2】

返回状态码200，返回值如下：

{

"@odata.context": "/redfish/v1/$metadata#EthernetInterface.EthernetInterface(FQDN,Id,NameServers,AutoNeg,SpeedMbps,HostName,FullDuplex,Description,Status,MACAddress,Name,Oem,MaxIPv6StaticAddresses,Links,MTUSize,PermanentMACAddress,InterfaceEnabled)",

"@odata.id": "/redfish/v1/Managers/1/EthernetInterfaces/eth0",

"@odata.type": "#EthernetInterface.v1_4_0.EthernetInterface",

"FQDN": "HDM.",

"HostName": "HDM",

"Id": "eth0",

"MACAddress": "3C:22:03:01:10:49",

"MTUSize": 1500,

"MaxIPv6StaticAddresses": 16,

"Name": "Manager Ethernet Interface",

"NameServers": [

"::"

"PermanentMACAddress": "3C:22:03:01:10:49",

"SpeedMbps": 10,

"VLAN": []

}

【修改记录】

(1) HDM-1.11.31添加字段AddressOrigin

(2) HDM-1.30.09添加字段IPv6StaticAddresses、IPv6DefaultGateway、HostName、Vlan

(3) 修改响应码为200，增加响应体

(4) (仅)HDM-1.30.18P5X,B05：增加字段NameServers

(5) HDM-2.97：新增字段Oem.Public.{IPv4Enabled,IPv6Enabled}

(6) HDM-3.36：补充说明与示例【使用实例2-关闭共享口】，Oem.Public.{IPv4Enabled,IPv6Enabled}，对共享口全部设置false时，可关闭共享口

4.4.26 查询虚拟媒体集合资源

【功能描述】

查询虚拟媒体集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

无

【参数说明】

表4-140 查询虚拟媒体集合资源参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#VirtualMediaCollection.VirtualMediaCollection",

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia",

"@odata.type": "#VirtualMediaCollection.VirtualMediaCollection",

"Description": "Collection of Virtual Media redirected to host via this Manager",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/HD"

{

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD"

}

"Name": "Virtual Media Collection"

}

响应码：200

【输出说明】

表4-141 查询虚拟媒体集合资源返回参数说明

字段	类型	字段说明
@odata.context	字符串	虚拟媒体集合资源模型的OData 描述信息
@odata.id	字符串	虚拟媒体集合资源的访问路径
@odata.type	字符串	虚拟媒体集合资源的类型
Description	字符串	虚拟媒体集合资源的描述
Name	字符串	虚拟媒体集合资源的名称
[email protected]	数值	当前可以连接的虚拟媒体资源数量
Members	虚拟媒体资源列表
@odata.id	字符串	单个虚拟媒体节点的访问路径

4.4.27 查询虚拟媒体CD资源

【功能描述】

查询虚拟媒体CD资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

无

【参数说明】

表4-142 查询虚拟媒体CD资源参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia(Name,Id)"

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/CD",

"@odata.type": "#VirtualMedia.v1_0_3.VirtualMedia",

"Connected": [

{

"ImageName": "bnx2x-1.714.18-dd-xs6.5-3.10.0+2-x86_64.iso",

"MediaIndex": "0",

"MediaTypes": "CD/DVD"

{

"ImageName": "netxtreme2-7.14.46-dd-sles11sp3-3.0.76_0.11-x86_64.iso",

"MediaIndex": "1",

"MediaTypes": "CD/DVD"

}

"Id": "CD",

"Name": "VirtualMedia",

"NotConnected": [

{

"ID": "1",

"ImageName": "netxtreme2-7.14.46-dd-sles12sp2-4.4.21_69-x86_64.iso",

"MediaTypes": "CD/DVD"

{

"ID": "3",

"ImageName": "REPO-1.11.02.iso",

"MediaTypes": "CD/DVD"

{

"ID": "2",

"ImageName": "ONEStor-Ubuntu_14.04.3.18.iso",

"MediaTypes": "CD/DVD"

}

]

}

响应码：200

【输出说明】

表4-143 查询虚拟媒体CD资源返回参数说明

字段	类型	字段说明
@odata.context	字符串	虚拟媒体CD资源模型的OData描述信息
@odata.id	字符串	虚拟媒体CD资源的访问路径
@odata.type	字符串	虚拟媒体CD资源的类型
Id	字符串	虚拟媒体资源的ID
Name	字符串	虚拟媒体资源的名称
MediaTypes	字符串	媒体镜像类型： "CD/DVD"
ImageName	字符串	镜像名称
MediaIndex	字符串	媒体实例
Connected	字符串	已连接的镜像
NotConnected	字符串	未连接的镜像

4.4.28 查询虚拟媒体HD资源

【功能描述】

查询虚拟媒体HD资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/HD

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

无

【参数说明】

表4-144 查询虚拟媒体HD资源参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/HD

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#VirtualMedia.VirtualMedia(Name,Id)",

"@odata.id": "/redfish/v1/Managers/1/VirtualMedia/HD",

"@odata.type": "#VirtualMedia.v1_2_0.VirtualMedia",

"Id": "HD",

"Name": "VirtualMedia",

"Connected": [

{

"MediaIndex": "0",

"ImageName": "testa.img",

"MediaTypes": "Hard disk"

{

"MediaIndex ": "1",

"ImageName": "testb.img",

"MediaTypes": "Hard disk"

}

"NotConnected": [

{

"ID": "1",

"ImageName": "test1.img",

"MediaTypes": "Hard disk"

{

"ID": "2",

"ImageName": "test2.img",

"MediaTypes": "Hard disk"

}

]

}

说明：与CD一致

响应码：200

【输出说明】

表4-145 查询虚拟媒体HD资源返回参数说明

字段	类型	字段说明
@odata.context	字符串	虚拟媒体HD资源模型的OData 描述信息
@odata.id	字符串	虚拟媒体HD资源的访问路径
@odata.type	字符串	虚拟媒体HD资源的类型
Id	字符串	虚拟媒体资源的ID
Name	字符串	虚拟媒体资源的名称
MediaIndex	字符串	虚拟媒体索引
MediaTypes	字符串	媒体镜像类型： "Hard disk"
ImageName	字符串	镜像名称

4.4.29 连接虚拟媒体CD

【功能描述】

连接虚拟媒体。

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

NFS:

{

"VmmControlType":"Connect",

"Image":"nfs://IP/Share/ERP.iso"

}

CIFS:

{

"VmmControlType":"Connect",

"Image":"cifs://user:password@IP/img/ERP.iso"

}

表4-146 连接虚拟媒体参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
VmmControlType	虚拟媒体操作类型	Connect：连接虚拟媒体
Image	虚拟媒体镜像 uri	uri连接：支持协议： NFS、CIFS image_name名称(如：ERP.iso)长度最长128.

【使用实例1】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"VmmControlType":"Connect",

"Image":"nfs://192.168.190.51/Share/image.so"

}

【返回示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Media Mounting Task",

"StartTime": "2020-08-11T21:28:30+09:00",

"TaskState": "Mounting"

}

返回码202

【使用实例2】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"VmmControlType":"Connect",

"Image":"cifs://user123:[email protected]/img/image.so"

}

【返回示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Media Mounting Task",

"StartTime": "2020-08-11T21:28:30+09:00",

"TaskState": "Mounting"

}

返回码202

【输出说明】

返回状态码202，表示操作成功。

字段	类型	字段说明
@odata.context	字符串	连接虚拟媒体资源TaskService的OData 描述信息
@odata.type	字符串	连接虚拟媒体资源TaskService的类型
@odata.id	字符串	连接虚拟媒体资源TaskService的访问路径
Id	字符串	连接虚拟媒体资源TaskService的ID
Messages	字符串	连接虚拟媒体资源TaskService的详细信息
Name	字符串	连接虚拟媒体资源TaskService的名称
StartTime	字符串	连接虚拟媒体资源TaskService的开始时间
TaskState	字符串	连接虚拟媒体资源TaskService的任务状态

【修改记录】

(1) HDM-1.30.06：协议新增CIFS支持

(2) HDM-1.30.12：增加返回体，返回码修改为200

(3) HDM-2.09.00：返回体修改，返回码由200修改成202

(4) HDM-2.99：image_name名称长度最长由256修改成128

4.4.30 连接虚拟媒体HD

【功能描述】

连接虚拟媒体。

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

NFS:

{

"VmmControlType":"Connect",

"Image":"nfs://IP/Share/ERP.iso"

}

CIFS:

{

"VmmControlType":"Connect",

"Image":"cifs://user:password@IP/img/ERP.iso"

}

表4-147 连接虚拟媒体参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
VmmControlType	虚拟媒体操作类型	Connect：连接虚拟媒体
Image	虚拟媒体镜像 uri	uri连接：支持协议： NFS、CIFS image_name名称(如：ERP.iso)长度最长128.

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"VmmControlType":"Connect",

"Image":"nfs://192.168.190.51/Share/image.so"

}

【返回示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Media Mounting Task",

"StartTime": "2020-08-11T21:28:30+09:00",

"TaskState": "Mounting"

}

返回码202

【输出说明】

返回状态码202，表示操作成功。

字段	类型	字段说明
@odata.context	字符串	连接虚拟媒体资源TaskService的OData 描述信息
@odata.type	字符串	连接虚拟媒体资源TaskService的类型
@odata.id	字符串	连接虚拟媒体资源TaskService的访问路径
Id	字符串	连接虚拟媒体资源TaskService的ID
Messages	字符串	连接虚拟媒体资源TaskService的详细信息
Name	字符串	连接虚拟媒体资源TaskService的名称
StartTime	字符串	连接虚拟媒体资源TaskService的开始时间
TaskState	字符串	连接虚拟媒体资源TaskService的任务状态

【修改记录】

(1) HDM-3.31：接口新增

4.4.31 断开虚拟媒体CD

【功能描述】

断开虚拟媒体。

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

{

"VmmControlType": value

}

【参数说明】

表4-148 断开虚拟媒体参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
value	断开连接	Disconnect：断开虚拟媒体

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/CD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"VmmControlType":"Disconnect"

}

【返回示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": " VirtualMedia has been disconnected succesfully. See ExtendedInfo for more information."

}

返回码200

【输出说明】

返回状态码200，表示操作成功。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
Message	字符串	ExtendedInfo中详细信息
MessageArgs	数组	信息参数
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) HDM-1.30.12：增加返回体，返回码修改为200

(2) HDM-6.02：修正字段为Message

4.4.32 断开虚拟媒体HD

【功能描述】

断开虚拟媒体。

【所属权限模块】

远程媒体

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

{

"VmmControlType": value

}

【参数说明】

表4-149 断开虚拟媒体参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
value	断开连接	Disconnect：断开虚拟媒体

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/Managers/1/VirtualMedia/HD/Oem/Public/Actions/VirtualMedia.VmmControl

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"VmmControlType":"Disconnect"

}

【返回示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": " VirtualMedia has been disconnected succesfully. See ExtendedInfo for more information."

}

返回码200

【输出说明】

返回状态码200，表示操作成功。

字段	类型	字段说明
@odata.type	字符串	消息资源的 OData 描述信息
Message	字符串	ExtendedInfo中详细信息
MessageArgs	数组	信息参数
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Resolution	字符串	解决建议
Severity	字符串	严重性：Redfish 支持的严重级别包括： OK、 Warning、Critical
code	字符串	指示消息注册表中特定消息 ID 的字符串
message	字符串	详细信息

【修改记录】

(1) HDM-3.31：接口新增

(2) HDM-6.02：修正字段为Message

4.4.33 查询日志服务集合资源信息

【功能描述】

查询服务器当前日志服务集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求体】

无

【参数说明】

表4-150 查询日志服务集合资源参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【输出说明】

{

"@odata.context": "/redfish/v1/$metadata#LogServiceCollection.LogServiceCollection",

"@odata.id": "/redfish/v1/Managers/1/LogServices",

"@odata.type": "#LogServiceCollection.LogServiceCollection",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/FirmwareUpdateLog"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/ConfigurationLog"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/HardwareUpdateLog"

}

"[email protected]": 4,

"Name": "LogService Collection"

}

响应码：200

表4-151 查询日志服务集合资源返回参数说明

字段	类型	字段说明
@odata.context	字符串	日志服务集合资源模型OData 描述信息
@odata.id	字符串	日志服务集合资源模型的访问路径
@odata.type	字符串	日志服务集合资源模型的类型
Name	字符串	日志服务集合资源模型的名称
[email protected]	数值	当前日志服务资源数量
Members	日志服务资源列表
@odata.id	字符串	单个日志服务资源节点的访问路径

【修改记录】

(1) HDM-1.30.06 接口新增

4.4.34 查询指定日志服务资源信息

【功能描述】

查询服务器当前日志服务资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogService_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-152 查询指定日志服务资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogService.LogService(MaxNumberOfRecords,DateTime,Entries,Id,DateTimeLocalOffset,Description,Name,ServiceEnabled)",

"@odata.type": "#LogService.v1_1_0.LogService",

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog",

"DateTime": "2019-11-04T09:15:47+08:00",

"DateTimeLocalOffset": "UTC+08:00",

"Description": "AuditLog for this manager",

"Entries": {

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries"

"Id": "AuditLog",

"MaxNumberOfRecords": 1000,

"Name": "AuditLog",

"ServiceEnabled": true,

}

响应码：200

【输出说明】

表4-153 指定日志服务资源信息返回值

字段	类型	字段说明
@odata.context	字符串	指定日志服务资源模型的OData描述信息
@odata.id	字符串	指定日志服务资源的访问路径
@odata.type	字符串	指定日志服务资源的类型
Id	字符串	指定日志服务资源的ID
Name	字符串	指定日志服务资源的名称
Description	字符串	指定日志服务资源的描述信息
MaxNumberOfRecord	数字	指定日志服务资源的最大可记录日志条数
DateTime	字符串	指定日志服务资源的系统时间
DateTimeLocalOffset	字符串	指定日志服务资源的时区
ServiceEnabled	字符串	指定日志服务资源的启用状态： true false
Entries	对象	日志集合资源的访问路径

【修改记录】

(1) HDM-1.30.06 接口新增

(2) HDM-1.30.10 字段DateTimeLocalOffset显示从"UTC"修改成"UTC+08:00"的格式

4.4.35 查询日志集合资源信息

【功能描述】

查询服务器当前日志集合资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https: //device_ip/redfish/v1/ Managers/manager_id/LogServices/Log_id/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-154 查询日志集合资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog/Entries

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogEntryCollection.LogEntryCollection",

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries",

"@odata.type": "#LogEntryCollection.LogEntryCollection",

"Description": "Collection of entries for this log service",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/38"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/37"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/36"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/35"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/34"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/33"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/32"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/31"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/30"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/29"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/28"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/27"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/26"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/25"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/24"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/23"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/22"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/21"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/20"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/19"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/18"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/17"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/16"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/15"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/14"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/13"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/12"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/11"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/10"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/9"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/8"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/7"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/6"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/5"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/4"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/3"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/2"

{

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/1"

}

"[email protected]": 38,

"[email protected]": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries?$skip=50",

"Name": "Log Service Entries Collection"

}

响应码：200

【输出说明】

表4-155 查询日志集合资源返回值

字段	类型	字段说明
@odata.context	字符串	日志集合资源模型的 OData描述信息
@odata.id	字符串	日志服务集合资源的访问路径
@odata.type	字符串	日志集合资源的类型
Name	字符串	日志集合资源的名称
[email protected]	数字	当前日志资源数量
Members	日志资源列表
@odata.id	字符串	单个日志资源节点的访问路径
[email protected]	字符串	下一分页的URL路径

【修改记录】

(1) HDM-1.30.06 接口新增

4.4.36 查询日志资源信息

【功能描述】

查询服务器当前日志资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LogServices/LogService_id/Entries/Entries_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-156 查询日志资源说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/LogServices/AuditLog/Entries/145

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry(Oem,Id,Name,Message,Created)",

"@odata.id": "/redfish/v1/Managers/1/LogServices/AuditLog/Entries/145",

"@odata.type": "#LogEntry.v1_1_1.LogEntry",

"Created": "2019-11-04 08:37:55.941",

"EntryType": "Oem",

"Id": 145,

"Message": "HTTPS login from IP:192.168.10.26 user:admin",

"Name": "AuditLog",

"Oem": {

"Public": {

"Address": "192.168.10.26",

"Hostname": "HDM210200A00TH177000003",

"Interface": "LAN",

"User": "admin"

}

响应码：200

【输出说明】

表4-157 查询日志资源返回值

字段	类型	字段说明
@odata.context	字符串	日志资源模型的 OData描述信息
@odata.id	字符串	日志资源的访问路径
@odata.type	字符串	日志资源的类型
Name	字符串	日志资源的名称
Created	字符串	日志创建时间
EntryType	字符串	日志类型： Event SEL Oem
Message	字符串	日志描述信息
Id	数字	事件ID
Oem.Public.Address	字符串	主机地址
Oem.Public.Hostname	字符串	主机名
Oem.Public.Interface	字符串	接口类型： "N/A"：Unknow session type "LAN" "SERIAL" "SERIAL_TERMINAL" "KCS" "BT" "IPMB" "WEB" "USB" "USB_SPECIAL" "SSIF" "KVM" "CLI" "SNMP"
Oem.Public.User	字符串	用户名

【修改记录】

(1) HDM-1.30.06 接口新增

4.4.37 查询VNC信息

【功能描述】

查询VNC信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-158 查询VNC信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#VncService.VncService(ComplexityCheck,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/VncService",

"@odata.type": "#VncService.v1_0_0.VncService",

"ComplexityCheck": false,

"MaximumNumberOfSessions": 2,

"NumberOfActivatedSessions": 0,

"SessionTimeoutMinutes": 10

}

响应码：200

【输出说明】

表4-159 查询VNC信息返回值

字段	类型	字段说明
@odata.context	字符串	VNC信息资源模型的OData 描述信息
@odata.id	字符串	VNC信息资源的访问路径
@odata.type	字符串	VNC信息资源的类型
MaximumNumberOfSessions	数值	VNC最大会话数
NumberOfActivatedSessions	数值	VNC当前会话数
ComplexityCheck	布尔型	VNC密码复杂度检查
SessionTimeoutMinutes	数值	会话超时时间

【修改记录】

(1) HDM-1.30.09 接口新增

(2) HDM-1.30.10 字段SSLEncryptionEnabled名称修改成ComplexityCheck

4.4.38 设置VNC信息

【功能描述】

设置VNC信息。

【所属权限模块】

安全控制

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"SessionTimeoutMinutes": SessionTimeoutMinutes_value,

"ComplexityCheck": ComplexityCheck_value,

"Password":" Password_value"

}

【参数说明】

表4-160 设置VNC信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
SessionTimeoutMinutes_value	数值	会话超时时间（分钟），5~30
ComplexityCheck_value	布尔型	使能VNC密码复杂度检查关闭该功能时，密码要求如下： · 密码长度为1～8个字符； · 仅支持字母、数字、空格和特殊字符`~!@#$%^&()_+-=[]\{}\|;':",./<>?，区分大小写。 · 开启该功能时，密码要求如下： · 密码长度为8个字符，仅支持字母、数字、空格和特殊字符`~!@#$%^&()_+-=[]\{}\|;':",./<>?，区分大小写； · 至少包含大写字母、小写字母和数字中的两种字符； · 至少包含一个空格或特殊字符；
Password_value	字符串	密码

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/VncService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"SessionTimeoutMinutes":10,

"ComplexityCheck": false,

"Password":"root"

}

响应码：200

【输出说明】

{

"@odata.context": "/redfish/v1/$metadata#VncService.VncService(ComplexityCheck,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/VncService",

"@odata.type": "#VncService.v1_0_0.VncService",

"ComplexityCheck": false,

"MaximumNumberOfSessions": 2,

"NumberOfActivatedSessions": 0,

"SessionTimeoutMinutes": 10

}

返回状态码200，表示操作成功。

表4-161 设置VNC信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	VNC信息资源模型的OData 描述信息
@odata.id	字符串	VNC信息资源的访问路径
@odata.type	字符串	VNC信息资源的类型
MaximumNumberOfSessions	数值	VNC最大会话数
NumberOfActivatedSessions	数值	VNC当前会话数
ComplexityCheck	布尔型	VNC密码复杂度检查
SessionTimeoutMinutes	数值	会话超时时间

【修改记录】

(1) HDM-1.30.09 接口新增

(2) HDM-1.30.10 字段SSLEncryptionEnabled名称修改成ComplexityCheck

4.4.39 查询KVM信息

【功能描述】

查询KVM信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-162 查询KVM信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/Managers/1/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#KvmService.KvmService(PersistentUSBConnectionEnabled,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/KvmService",

"@odata.type": "#KvmService.v1_0_0.KvmService",

"MaximumNumberOfSessions": 4,

"NumberOfActivatedSessions": 0,

"PersistentUSBConnectionEnabled": true,

"SessionTimeoutMinutes": 13

}

响应码：200

【输出说明】

表4-163 查询KVM信息返回值

字段	类型	字段说明
@odata.context	字符串	KVM信息资源模型的OData 描述信息
@odata.id	字符串	KVM信息资源的访问路径
@odata.type	字符串	KVM信息资源的类型
MaximumNumberOfSessions	数值	KVM最大会话数
NumberOfActivatedSessions	数值	KVM当前会话数
PersistentUSBConnectionEnabled	布尔型	虚拟键盘、鼠标持续连接使能
SessionTimeoutMinutes	数值	会话超时时间

【修改记录】

(1) HDM-1.30.10 接口新增

4.4.40 设置KVM信息

【功能描述】

设置KVM信息。

【所属权限模块】

安全控制

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"SessionTimeoutMinutes": SessionTimeoutMinutes_value

}

【参数说明】

表4-164 设置VNC信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
SessionTimeoutMinutes	数值	会话超时时间（分钟）

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/Managers/1/KvmService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"SessionTimeoutMinutes":10

}

响应码：200

【输出说明】

{

"@odata.context": "/redfish/v1/$metadata#KvmService.KvmService(PersistentUSBConnectionEnabled,NumberOfActivatedSessions,SessionTimeoutMinutes,MaximumNumberOfSessions)",

"@odata.id": "/redfish/v1/Managers/1/KvmService",

"@odata.type": "#KvmService.v1_0_0.KvmService",

"MaximumNumberOfSessions": 4,

"NumberOfActivatedSessions": 0,

"PersistentUSBConnectionEnabled": true,

"SessionTimeoutMinutes": 13

}

返回状态码200，表示操作成功。

表4-165 设置KVM信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	KVM信息资源模型的OData 描述信息
@odata.id	字符串	KVM信息资源的访问路径
@odata.type	字符串	KVM信息资源的类型
MaximumNumberOfSessions	数值	KVM最大会话数
NumberOfActivatedSessions	数值	KVM当前会话数
PersistentUSBConnectionEnabled	布尔型	虚拟键盘、鼠标持续连接使能
SessionTimeoutMinutes	数值	会话超时时间

【修改记录】

(1) HDM-1.30.10 接口新增

4.4.41 查询串口列表

【功能描述】

查询串口列表。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SerialInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-166 查询串口列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET http://192.168.25.83/redfish/v1/Managers/1/SerialInterfaces

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SerialInterfaceCollection.SerialInterfaceCollection",

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces",

"@odata.type": "#SerialInterfaceCollection.SerialInterfaceCollection",

"Description": "Collection of Serial Interfaces for this System",

"Members": [

{

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL"

}

GET https://192.168.20.208/redfish/v1/Managers/1/LldpService

"Name": "Serial Interface Collection"

}

响应码：200

【输出说明】

表4-167 查询串口列表信息返回值

字段	类型	字段说明
@odata.context	字符串	串口集合资源模型
@odata.id	字符串	串口集合资源的访问路径
@odata.type	字符串	串口集合资源类型
Description	字符串	串口集合资源描述信息
Members	数组	串口信息查询路径
[email protected]	数值	串口个数
Name	字符串	名称

【修改记录】

(1) HDM-1.30.09 接口新增

4.4.42 查询指定串口信息

【功能描述】

查询指定串口信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/SerialInterfaces/serialinterface_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-168 查询指定串口信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
manager_id	管理资源的ID	当前所有机型取值为1
serialinterface_id	串口id	由串口列表中查询

【使用实例】

【请求样例】

GET http://192.168.25.83/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SerialInterface.SerialInterface",

"@odata.id": "/redfish/v1/Managers/1/SerialInterfaces/IPMI-SOL",

"@odata.type": "#SerialInterface.v1_1_2.SerialInterface",

"BitRate": "115200",

"DataBits": "8",

"Description": "IPMI Serial over LAN",

"FlowControl": "Hardware",

"Id": "IPMI-SOL",

"InterfaceEnabled": true,

"Name": "IPMI-SOL",

"Parity": "None",

"StopBits": "1"

}

响应码：200

【输出说明】

表4-169 查询串口信息返回值

字段	类型	字段说明
@odata.context	字符串	指定串口资源模型的OData描述信息
@odata.id	字符串	指定串口资源的访问路径
@odata.type	字符串	指定串口资源类型
BitRate	字符串	波特率： "1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200", "230400"
DataBits	字符串	数据位： "5", "6", "7", "8"
Description	字符串	串口描述信息
FlowControl	字符串	流控制方式： "None", "Software", "Hardware"
Id	字符串	串口id
InterfaceEnabled	布尔型	串口是否开启
Name	字符串	串口名称
Parity	字符串	校验方式： "None", "Even", "Odd", "Mark", "Space"
StopBits	字符串	停止位： "1", "2"

【修改记录】

(1) HDM-1.30.09 接口新增

4.4.43 查询LLDP 服务配置资源信息

【功能描述】

查询LLDP服务配置资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/LldpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/LldpService",

"@odata.type": "#HwLldpService.v1_0_0.HwLldpService",

"Description": "LLDP Service",

"Id": "LldpService",

"LLDP": [

{

"ChassisMac": "N/A",

"ChassisName": "N/A",

"EthIndex": "eth0",

"PortDesc": "N/A",

"PortIfName": "N/A",

"VlanId": 0

{

"ChassisMac": "38:ad:be:fc:8d:e6",

"ChassisName": "H3C",

"EthIndex": "eth1",

"PortDesc": "GigabitEthernet1/0/1 Interface",

"PortIfName": "GigabitEthernet1/0/1",

"VlanId": 1

}

"LldpEnabled": false,

"Name": "LldpService",

"WorkMode": "Tx"

}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	LLDP服务配置资源模型的OData 描述信息
@odata.id	字符串	LLDP服务配置资源的访问路径
@odata.type	字符串	LLDP服务配置资源的 OData 描述信息
Description	字符串	LLDP服务配置资源接口功能描述
Id	字符串	LldpService ID
ChassisMac	字符串	交换机MAC地址
ChassisName	字符串	交换机系统名字
EthIndex	字符串	服务器接收LLDP信息的网络接口
PortDesc	字符串	上联交换机端口的信息
PortIfName	字符串	上联交换机端口号
VlanId	数值	Vlan ID号
LldpEnabled	布尔型	LLDP发送消息使能
WorkMode	字符串	LLDP工作模式 Tx：发送模式 Rx：发送模式(不支持) TxRx：发送模式(不支持)
Name	字符串	LldpService名称

【修改记录】

(1) HDM-1.30.10接口新增

(2) HDM-1.30.13字段删除EthRate

(3) HDM-2.11.93，HDM-2.25 新增字段WorkMode

(4) HDM-2.42，新增字段@odata.type

4.4.44 修改LLDP 服务资源属性

【功能描述】

修改LLDP服务资源属性

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id /LldpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"LldpEnabled": enable

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
LldpEnabled	布尔型	LLDP发送消息使能： true false

【使用实例】

【请求样例】

PATCH http://172.16.13.176/redfish/v1/Managers/1/LldpService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"LldpEnabled": true

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/LldpService",

"@odata.type": "#HwLldpService.v1_0_0.HwLldpService",

"Description": "LLDP Service",

"Id": "LldpService",

"LLDP": [

{

"ChassisMac": "N/A",

"ChassisName": "N/A",

"EthIndex": "eth0",

"PortDesc": "N/A",

"PortIfName": "N/A",

"VlanId": 0

{

"ChassisMac": "38:ad:be:fc:8d:e6",

"ChassisName": "H3C",

"EthIndex": "eth1",

"PortDesc": "GigabitEthernet1/0/1 Interface",

"PortIfName": "GigabitEthernet1/0/1",

"VlanId": 1

}

"LldpEnabled": true,

"Name": "LldpService",

"WorkMode": "Tx"

}

响应码：200

【输出说明】

同“查询LLDP服务配置资源信息”接口

【修改记录】

(1) HDM-1.30.10接口新增

4.4.45 查询无线管理资源信息

【功能描述】

查询无线管理资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Wireless

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET https://192.168.33.120/redfish/v1/Managers/1/Oem/Public/Wireless

请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Wireless.Wireless",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless",

"@odata.type": "#Wireless.v1_0_0.Wireless",

"Clients": [

{

"ClientId":1,

"MacAddress":"26:70:77:d8:db:bd ",

"IPAddress":"192.168.199.3",

"HostName":" HUAWEI_P40_Pro+"

}

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.199",

"DHCPAddrStart": "192.168.155.56",

"IPAddress": "192.168.155.20",

"Id": 1

}

"Ssids": [

{

"ClientMaxNum": 2,

"EncryptionMode": "None",

"Id": 1,

"Name": "111111222222333",

"Password": "01234567890123456789"

}

"Status": {

"Health": "OK",

"State": "Disabled"

"WlanChannel": 11,

"WlanCurrentState": "Disabled",

"WlanEnabled": true,

"WlanTimeout": 150

}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	无线管理资源信息模型的OData 描述信息
@odata.id	字符串	无线管理资源信息的访问路径
@odata.type	字符串	无线管理资源信息资源类型
WlanChannel	数值	无线信道，默认为11
WlanCurrentState	字符串	无线的使能状态
WlanEnabled	布尔型	无线使能
WlanTimeout	数值	无线定时关闭时间,范围0~200,单位：小时,0表示不关闭
Clients.ClientId	数值	客户端的ID
Clients.MacAddress	字符串	客户端的MAC地址
Clients.IPAddress	字符串	客户端的IPV4地址
Clients.HostName	字符串	客户端的主机名
DHCPServers.Id	数值	无线DHCP地址池的ID
DHCPServers.IPAddress	字符串	无线的IP地址
DHCPServers.DHCPAddrStart	字符串	无线DHCP地址池
DHCPServers.DHCPAddrEnd	字符串	无线DHCP地址池
Ssids.ClientMaxNum	数字	客户端的最大连接数量
Ssids.EncryptionMode	字符串	无线加密方式 “None”, “WPA2-PSK”
Ssids.Id	数值	无线的ID
Ssids.Name	字符串	无线名称
Ssids.Password	字符串	无线密码

【修改记录】

(1) HDM-2.17.00接口新增

4.4.46 修改无线管理属性

【功能描述】

修改无线管理属性

【所属权限模块】

常规配置

【命令格式】

PATCH https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Wireless

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.189",

"DHCPAddrStart": "192.168.155.35",

"IPAddress": "192.168.155.30"

}

"Ssids": [

{

"EncryptionMode": "WPA2-PSK",

"Name": "111111222222",

"Password": "dfsgdgdsfgsdg"

}

"WlanEnabled": true,

"WlanTimeout": 0

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
WlanEnabled	布尔型	无线使能
WlanTimeout	数值	无线定时关闭时间,范围0~200,单位：小时,0表示不关闭
DHCPServers.IPAddress	字符串	无线的IP地址，仅支持IPv4
DHCPServers.DHCPAddrStart	字符串	无线DHCP地址池，仅支持IPv4
DHCPServers.DHCPAddrEnd	字符串	无线DHCP地址池，仅支持IPv4
Ssids.EncryptionMode	字符串	无线加密方式 “None”：不加密 “WPA2-PSK”
Ssids.Name	字符串	无线名称，1~31字符
Ssids.Password	字符串	无线密码，8~63个字符

【使用实例】

【请求样例】

PATCH https://192.168.30.85/redfish/v1/Managers/1/Oem/Public/Wireless

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"1043aaa69f0ade5f8a7a7e0d987a274b"

【请求消息体】

{

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.150",

"DHCPAddrStart": "192.168.155.35",

"IPAddress": "192.168.155.34"

}

"Ssids": [

{

"EncryptionMode": "WPA2-PSK",

"Name": "111111222222",

"Password": "dfsgdgdsfgsdg"

}

"WlanEnabled": true,

"WlanTimeout": 0

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Wireless.Wireless",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Wireless",

"@odata.type": "#Wireless.v1_0_0.Wireless",

"Clients": [],

"DHCPServers": [

{

"DHCPAddrEnd": "192.168.155.150",

"DHCPAddrStart": "192.168.155.35",

"IPAddress": "192.168.155.34",

"Id": 1

}

"Ssids": [

{

"ClientMaxNum": 2,

"EncryptionMode": "WPA2-PSK",

"Id": 1,

"Name": "111111222222",

"Password": "dfsgdgdsfgsdg"

}

"Status": {

"Health": "OK",

"State": "Disabled"

"WlanChannel": 11,

"WlanCurrentState": "Disabled",

"WlanEnabled": true,

"WlanTimeout": 0

}

响应码：200

【输出说明】

同“查询无线管理资源信息”接口

【修改记录】

(1) HDM-2.17.00接口新增

4.4.47 导入BIOS、BMC和RAID控制器配置

【功能描述】

导入BIOS、BMC和RAID控制器配置

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ImportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

cifs或sftp

{

"Type":type_value,

"Content":”cifs://username:password@ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

http、tftp、nfs或https

{

"Type":type_value,

"Content":” http://ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
Type	导入配置文件的方法	URI
Content	导入配置文件路径	· 文件传输协议：sftp、https、http、nfs、cifs、tftp · 操作路径：不支持中文 · 文件名字、账号、密码：长度最长为31，总长度不超过255，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文
Oem.Public.ConfigType	导入配置类别	“HDM”，”BIOS”，”RAID”

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ImportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "nfs://192.168.20.177/Share1/bios-config.json",

"Oem": {

"Public": {

"ConfigType":"BIOS"

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "1",

"Messages": [],

"Name": "Configuration Import Task",

"StartTime": "2020-10-25T13:59:17+01:00",

"TaskState": "Importing"

}

响应码：202

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData 描述信息
@odata.id	字符串	指定角色资源的访问路径
@odata.type	字符串	指定角色资源的类型
Id	字符串	任务ID
Name	字符串	任务的名称
Messages	字符串	任务的消息描述
StartTime	字符串	任务的起始时间
TaskState	字符串	任务执行状态

【修改记录】

(1) HDM-2.19：接口新增

4.4.48 导出BIOS、BMC和RAID控制器配置

【功能描述】

导出BIOS、BMC和RAID控制器配置。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.ExportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

cifs或sftp

{

"Type":type_value,

"Content":”cifs://username:password@ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

http、tftp、nfs或https

{

"Type":type_value,

"Content":” http://ip/filename”,

"Oem": {

"Public": {

"ConfigType":type

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
Type	导出配置文件的方法	URI
Content	导出配置文件路径	· 文件传输协议：sftp、https、http、nfs、cifs、tftp · 操作路径：不支持中文 · 文件名字、账号、密码：长度最长为31，总长度不超过255，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文
Oem.Public.ConfigType	导出配置类别	“HDM”，”BIOS”，”RAID”

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.ExportConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content": "nfs://192.168.20.177/Share1/bios-config.json",

"Oem": {

"Public": {

"ConfigType":"BIOS"

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/TaskService/Tasks/2",

"@odata.type": "#TaskCollection.TaskCollection",

"Id": "2",

"Messages": [],

"Name": "Configuration Export Task",

"StartTime": "2020-10-25T14:11:35+01:00",

"TaskState": "Exporting"

}

响应码：202

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData 描述信息
@odata.id	字符串	指定角色资源的访问路径
@odata.type	字符串	指定角色资源的类型
Id	字符串	任务ID
Name	字符串	任务的名称
Messages	字符串	任务的消息描述
StartTime	字符串	任务的起始时间
TaskState	字符串	任务执行状态

【修改记录】

(1) HDM-2.19：接口新增

4.4.49 获取串口日志服务器配置

【功能描述】

获取远程串口日志服务器配置信息

【所属权限模块】

查询模块

【命令格式】

GET

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteHostLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET

https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration",

"@odata.type": "#RemoteHostLogConfiguration.v1_0_0.RemoteHostLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData描述信息
@odata.id	字符串	指定角色资源的访问路径
@odata.type	字符串	指定角色资源的类型
SysLogEnabled	布尔型	syslog使能： false表示关闭 true表示开启
TransportProtocol	字符串	传输协议： UDP TCP
HostIP	字符串	服务器地址，支持IPV4/IPV6/域名
HostPort	数值	端口号

【修改记录】

(1) HDM-2.33：接口新增

4.4.50 设置串口日志服务器配置

【功能描述】

设置远程串口日志服务器配置信息。

【所属权限模块】

常规配置

【命令格式】

PATCH

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteHostLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
SysLogEnabled	布尔型	syslog使能： false表示关闭 true表示开启
TransportProtocol	字符串	传输协议： UDP TCP
HostIP	字符串	服务器地址，支持IPV4/IPV6/域名
HostPort	数值	端口号

【使用实例】

【请求样例】

PATCH

https://192.168.77.77/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteHostLogConfiguration",

"@odata.type": "#RemoteHostLogConfiguration.v1_0_0.RemoteHostLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514

}

响应码：200

【输出说明】

同【获取串口日志服务器配置】

【修改记录】

(1) HDM-2.33：接口新增

4.4.51 获取SDR日志服务器配置

【功能描述】

获取SDR日志服务器配置

【所属权限模块】

查询模块

【命令格式】

GET

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1

【使用实例】

【请求样例】

GET

https://192.168.77.77/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteSDRLogConfiguration",

"@odata.type": "#RemoteSDRLogConfiguration.v1_0_0.RemoteSDRLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514,

"TimeInterval"："10"

}

响应码：200

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData 描述信息
@odata.id	字符串	指定角色资源的访问路径
@odata.type	字符串	指定角色资源的类型
SysLogEnabled	布尔型	syslog使能： false表示关闭 true表示开启
TransportProtocol	字符串	传输协议： UDP TCP
HostIP	字符串	服务器地址，支持IPV4/IPV6/域名
HostPort	数值	端口号
TimeInterval	字符串	时间间隔：10-2592000s

【修改记录】

(1) HDM-2.33：接口新增

4.4.52 设置SDR日志服务器配置

【功能描述】

设置SDR日志服务器配置。

【所属权限模块】

常规配置

【命令格式】

PATCH

https://device_ip/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514,

"TimeInterval"："10"

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
SysLogEnabled	布尔型	syslog使能： false表示关闭 true表示开启
TransportProtocol	字符串	传输协议： UDP TCP
HostIP	字符串	服务器地址，支持IPV4/IPV6/域名
HostPort	数值	端口号
TimeInterval	字符串	时间间隔：10-2592000s

【使用实例】

【请求样例】

PATCH

https://192.168.77.77/redfish/v1/Managers/manager_id/Oem/Public/Manager.RemoteSDRLogConfiguration

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 51,

"TimeInterval"："10"

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/Managers/1/Oem/Public/Manager.RemoteSDRLogConfiguration",

"@odata.type": "#RemoteSDRLogConfiguration.v1_0_0.RemoteSDRLogConfiguration",

"SysLogEnabled": true,

"TransportProtocol": "UDP",

"HostIP": "192.168.34.217",

"HostPort": 514,

"TimeInterval"："10"

}

响应码：200

【输出说明】

同【获取SDR日志服务器配置】

【修改记录】

(1) HDM-2.33：接口新增AccountService 资源的操作

4.4.53 导出BIOS固件

【功能描述】

导出BIOS固件。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.dumpBios

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

cifs或sftp

{

"Content":”cifs://username:password@ip/filename”,

}

tftp、nfs

{

"Content":” nfs:filename”,

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
Content	导出配置文件路径	· 文件传输协议：sftp、nfs、cifs、tftp · 操作路径：不支持中文 · 文件名字、账号、密码：长度最长为31，总长度不超过255，特殊符号支持 @!$^&()_+.;[]{}-=~`，不支持中文

【使用实例】

【请求样例】

POST https://192.168.188.188/redfish/v1/Managers/1/Actions/Oem/Public/Manager.dumpBIOS

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Content": "nfs://192.168.20.177/Share1/BIOS.bin",

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

}

响应码：202

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData描述信息

【修改记录】

(1) HDM-2.93：接口新增

4.4.54 导出日志

【功能描述】

导出SDS或EVENT日志。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/Managers/manager_id/Actions/Oem/Public/Manager.Dump

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

cifs或sftp

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"EVENT"

"Content": "cifs://username:password@ip/sharefilename/filename"

}

sftp

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"SDS"

"Content": "sftp:// username:password@ip/filename "

}

tftp、nfs

tftp:

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"EVENT"

"Content": "tftp://ip/filename"

}

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"SDS"

"Content": "nfs://ip/share/filname"

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得。
manager_id	管理资源的ID	当前所有机型取值为1
Content	导出路径	· 文件传输协议：sftp、nfs、cifs、tftp · 操作路径：不支持中文 · Filename格式导出SDS.sds格式 · 导出EVENT.tar.gz格式 · 文件名字、账号、密码：长度最长为31，总长度不超过255，特殊符号支持@!$^&()_+.;[]{}-=~`，不支持中文
LogType	导出日志类型	SDS 或 EVENT 或不填LogType参数则默认下载SDS
StartTime		不需要填写
EndTime		不需要填写
Name		不需要填写
Telephone		不需要填写
EmailAddress		不需要填写

【使用实例】

【请求样例】

POST https://172.14.120.8/redfish/v1/Managers/1/Actions/Oem/Public/Manager.Dump

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"StartTime":"",

"EndTime":"",

"Name":"",

"Telephone":"",

"EmailAddress":"",

"Type":"URI",

"LogType":"EVENT"

"Content": "tftp://172.14.81.73/20230131.tar.gz "

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata",

}

响应码：202

【输出说明】

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData 描述信息

【修改记录】

(1) HDM-3.33：接口新增。支持LogType区分下载类型。

4.5 AccountService 资源的操作

4.5.1 查询用户服务信息

【功能描述】

查询服务器当前用户服务信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-170 查询用户服务信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",

"@odata.id": "/redfish/v1/AccountService",

"@odata.type": "#AccountService.v1_3_0.AccountService",

"AccountLockoutDuration": 5,

"AccountLockoutThreshold": 5,

"Accounts": {

"@odata.id": "/redfish/v1/AccountService/Accounts"

"Description": "BMC User Accounts",

"Id": "AccountService",

"MaxPasswordLength": 20,

"MinPasswordLength": 2,

"Name": "Account Service",

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": false

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles"

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【输出说明】

表4-171 查询用户列表信息返回值

字段	类型		字段说明
@odata.context	字符串		AccountService 资源模型的 OData 描述信息
@odata.id	字符串		AccountService 资源节点的访问路径
@odata.type	字符串		AccountService 资源类型
Description	字符串		用户服务资源描述信息
Id	字符串		AccountService 资源的 ID
Name	字符串		AccountService 资源的名称
MinPasswordLength	数值		密码最小长度
MaxPasswordLength	数值		密码最大长度
AccountLockoutThreshold	数值		允许错误密码次数，即输入错误密码次数超过此参数时，用户被锁定。
AccountLockoutDuration	数值		用户登录失败后被锁定的锁定时长。
Accounts	用户资源
@odata.id	字符串		Account资源节点的访问路径
Oem.Public	指定用户服务自定义信息
PassWordRule. PasswordComplexityCheckEnabled	布尔型		密码复杂度使能
TwoFactorAuthenticationInformation	对象，刀箱产品不支持
TwoFactorAuthenticationStateEnabled	布尔型	双因素认证使能
OTPServerAddress	字符串	OTP Server网络地址
OTPServerPort	数值	OTP Server的服务端口号
OTPServerSharedKey	字符串	OTP Server的共享密钥，长度为1-64
Roles	角色资源
@odata.id	字符串	Roles资源节点的访问路径
ServiceEnabled	布尔型	服务使能
Status.Health	字符串	用户服务信息健康状态
Status.State	字符串	用户服务信息使能状态

【修改记录】

(1) HDM-2.25：字段新增TwoFactorAuthenticationInformation

(2) HDM-2.26：删除未实现的URL字段Oem.Public.Configuration

4.5.2 修改用户服务信息

【功能描述】

修改服务器当前用户服务信息。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": true

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

【参数说明】

表4-172 修改当前用户服务信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
PassWordRule	对象
PasswordComplexityCheckEnabled	布尔型	密码复杂度使能
TwoFactorAuthenticationInformation	对象，刀箱产品不支持
TwoFactorAuthenticationStateEnabled	布尔型	双因素认证使能
OTPServerAddress	字符串	OTP Server网络地址
OTPServerPort	数值	OTP Server的服务端口号
OTPServerSharedKey	字符串	OTP Server的共享密钥，长度为1-64

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": true

}

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

响应码：200

【输出说明】

返回状态码200，响应体如下：

{

"@odata.context": "/redfish/v1/$metadata#AccountService.AccountService",

"@odata.id": "/redfish/v1/AccountService",

"@odata.type": "#AccountService.v1_3_0.AccountService",

"AccountLockoutDuration": 5,

"AccountLockoutThreshold": 5,

"Accounts": {

"@odata.id": "/redfish/v1/AccountService/Accounts"

"Description": "BMC User Accounts",

"Id": "AccountService",

"MaxPasswordLength": 20,

"MinPasswordLength": 8,

"Name": "Account Service",

"Oem": {

"Public": {

"PassWordRule": {

"PasswordComplexityCheckEnabled": true

"TwoFactorAuthenticationInformation": {

"TwoFactorAuthenticationStateEnabled": false,

"OTPServerAddress": "192.168.1.36",

"OTPServerPort": 1812,

"OTPServerSharedKey": "admin"

}

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles"

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

}

【修改记录】

(1) HDM-1.30.09修改响应码为200，增加响应体

(2) HDM-2.25：字段新增TwoFactorAuthenticationInformation

4.5.3 查询用户列表信息

【功能描述】

查询用户列表信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-173 查询用户列表信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】{

"@odata.context": "/redfish/v1/$metadata#ManagerAccountCollection.ManagerAccountCollection",

"@odata.id": "/redfish/v1/AccountService/Accounts",

"@odata.type": "#ManagerAccountCollection.ManagerAccountCollection",

"Members": [

{

"@odata.id": "/redfish/v1/AccountService/Accounts/1"

}

{

"@odata.id": "/redfish/v1/AccountService/Accounts/2"

}

GET https://device_ip/redfish/v1/SessionService/Sessions

"Name": "Accounts Collection"

}

【输出说明】

表4-174 查询用户列表信息返回值

字段	类型	字段说明
@odata.context	字符串	用户集合资源模型的 OData 描述信息
@odata.id	字符串	用户集合资源节点的访问路径
@odata.type	字符串	用户集合资源类型
Name	字符串	用户资源集合的名称
Members	数组	用户信息查询路径
[email protected]	数值	用户个数
[email protected]	字符串	指定用户资源节点的访问路径

4.5.4 查询指定用户信息

【功能描述】

查询指定的用户信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Accounts/user_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-175 查询指定的用户信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
user _id	用户ID	由用户集合中查询

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Accounts/2

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#ManagerAccount.ManagerAccount(Id,Links,Name,Oem,RoleId,Description,Enabled,Locked,UserName)",

"@odata.id": "/redfish/v1/AccountService/Accounts/2",

"@odata.type": "#ManagerAccount.v1_1_2.ManagerAccount",

"Description": "Default Account",

"Enabled": true,

"Id": "2",

"Links": {

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

}

"Locked": false,

"Name": "Default Account",

"Oem": {

"Public": {

"IPMIEnable": "true",

"WebEnable": "true",

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des",

"SnmpEncryptPwdInit": true,

"SnmpV3Password": null

}

"RoleId": "Administrator",

"UserName": "admin",

"Password": null

}

响应码：200

【输出说明】

表4-176 查询指定的用户信息返回值

字段	类型	字段说明
@odata.context	字符串	指定用户信息资源模型的 OData 描述信息
@odata.id	字符串	指定用户信息资源节点的访问路径
@odata.type	字符串	指定用户信息资源类型
Description	字符串	指定用户信息描述
Enabled	布尔型	是否启用
Id	数值	用户ID
Links.Roles	字符串	所在权限的查询路径
Locked	布尔型	账户是否被锁定
Name	字符串	指定用户资源名称
Oem.Public.IPMIEnable	布尔型	IPMI扩展权限使能
Oem.Public.WebEnable	布尔型	Web扩展权限使能
RoleId	字符串	角色资源ID： Administrator、Operator、User、None 自定义1，默认CustomRole1 自定义2，默认CustomRole2 自定义3，默认CustomRole3 自定义4，默认CustomRole4 自定义5，默认CustomRole5
UserName	字符串	用户名
Password	null	GET是返回null
Oem.Public.SnmpV3Enable	布尔型	SnmpV3扩展权限使能
Oem.Public.SnmpV3AccessPermission	字符串	SnmpV3读写权限： read_only read_write
Oem.Public.SnmpV3AuthProtocol	字符串	SnmpV3鉴权算法： sha md5
Oem.Public.SnmpV3PrivProtocol	字符串	SnmpV3加密算法： des aes
Oem.Public.SnmpV3Password	字符串	输出密码默认为空
Oem.Public.SnmpEncryptPwdInit	布尔型	新增的用户SNMPv3是否添加独立密码 true 设置独立密码 false 未设置独立密码

【修改记录】

(1) HDM-1.30.06：返回值Oem.Public新增字段SnmpV3Enable、SnmpV3AccessPermission、SnmpV3AuthProtocol、SnmpV3PrivProtocol

(2) HDM-2.0.04：字段删除Oem.Public.KvmEnable、Oem.Public.VmediaEnable

(3) HDM-2.06.00：RoleId中取值Custom1-5修改成CustomRole1-5

(4) HDM-2.11.92：新增字段Password(返回null)

(5) HDM-6.13：返回值中新增SnmpV3Password和SnmpEncryptPwdInit字段

4.5.5 添加用户信息

【功能描述】

添加用户信息。

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Enabled": true,

"Password": password,

"UserName": name,

"RoleId": role,

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des",

"SnmpV3Password": "Password@_"

}

【参数说明】

表4-177 添加用户信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
Enabled	布尔型	用户账户是否启用
UserName	字符串	用户名
Password	字符串	用户密码注：密码最长20位
RoleId	字符串	角色资源ID： Administrator、Operator、User、None 自定义1，默认CustomRole1 自定义2，默认CustomRole2 自定义3，默认CustomRole3 自定义4，默认CustomRole4 自定义5，默认CustomRole5
Locked	布尔型	账户是否被锁定。目前仅支持false
Oem.Public.IPMIEnable	布尔型	IPMI扩展权限使能
Oem.Public.WebEnable	布尔型	Web扩展权限使能
Oem.Public.SnmpV3Enable	布尔型	SnmpV3扩展权限使能
Oem.Public.SnmpV3AccessPermission	字符串	SnmpV3读写权限： read_only read_write
Oem.Public.SnmpV3AuthProtocol	字符串	SnmpV3鉴权算法： sha md5
Oem.Public.SnmpV3PrivProtocol	字符串	SnmpV3加密算法： des aes
Oem.Public.SnmpV3Password	字符串	被用于SNMP v3鉴权的用户的加密密码，如果不下发，默认使用用户登录密码，页面显示黑点，WEB下发采用RSA加密，redfish接口层面设置密码时使用明文，获取密码时密码为空

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/AccountService/Accounts

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Enabled": true,

"Password": "test@test123",

"UserName": "User123",

"RoleId": "User",

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des",

"SnmpV3Password": "Password@_"

}

【返回消息体】

响应码：201

返回状态码201，表示创建成功。

{

"@odata.type": "#ManagerAccount.v1_1_2.ManagerAccount",

"Description": "User Account",

"Enabled": true,

"Id": "3",

"Links": {

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles/User"

}

"Locked": false,

"Name": "User Account",

"Oem": {

"Public": {

"IPMIEnable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3Enable": true,

"SnmpV3PrivProtocol": "des",

"WebEnable": true

"SnmpV3Password": null,

"SnmpEncryptPwdInit": true

}

"RoleId": "User",

"UserName": "User123",

"Password": null

}

【输出说明】

参数	参数说明	取值
Enabled	布尔型	是否启用
Locked	布尔型	账户是否被锁定。目前仅支持false
Role	字符串	权限
RoleId	字符串	权限ID
UserName	字符串	用户名

【修改记录】

(1) HDM-1.30.06：请求体Oem.Public新增字段IPMIEnable、WebEnable、SnmpV3Enable 、SnmpV3AccessPermission、SnmpV3AuthProtocol、SnmpV3PrivProtocol

(2) 仅HDM-1.30.18SP5X：角色资源ID:User修改成Commonuser,None修改成Noaccess

(3) HDM-2.0.04：字段删除Oem.Public.KvmEnable、Oem.Public.VmediaEnable

(4) HDM-2.06.00：RoleId中取值Custom1-5修改成CustomRole1-5

(5) HDM-6.13：请求体中新增SnmpV3Password、返回值中新增SnmpV3Password和SnmpEncryptPwdInit字段

4.5.6 修改用户信息

【功能描述】

修改指定用户信息。非admin用户只能修改自身。

【所属权限模块】

用户配置|配置自身

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Accounts/userid

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"Enabled": true,

"Password": password,

"UserName": name,

"RoleId": role,

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des",

"SnmpV3Password": "Password@_"

}

【参数说明】

表4-178 修改用户信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或Ipv6
userid	修改用户的userid	用户的userid数值
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
Enabled	布尔型	用户账户是否启用
UserName	字符串	用户名
Password	字符串	用户密码注：密码最长20位
RoleId	字符串	角色资源ID： Administrator、Operator、User、None 自定义1，默认CustomRole1 自定义2，默认CustomRole2 自定义3，默认CustomRole3 自定义4，默认CustomRole4 自定义5，默认CustomRole5
Locked	布尔型	账户是否被锁定。目前仅支持false
Oem.Public.IPMIEnable	布尔型	IPMI扩展权限使能
Oem.Public.WebEnable	布尔型	Web扩展权限使能
Oem.Public.SnmpV3Enable	布尔型	SnmpV3扩展权限使能
Oem.Public.SnmpV3AccessPermission	字符串	SnmpV3读写权限： read_only read_write
Oem.Public.SnmpV3AuthProtocol	字符串	SnmpV3鉴权算法： sha md5
Oem.Public.SnmpV3PrivProtocol	字符串	SnmpV3加密算法： des aes
Oem.Public.SnmpV3Password	字符串	被用于SNMPv3鉴权的用户的加密密码，页面显示黑点，redfish接口层面使用明文

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Accounts/3

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"Enabled": true,

"Password": "test@test123",

"RoleId": "User",

"UserName": "User123",

"Locked": false,

"Oem": {

"Public": {

"IPMIEnable": true,

"WebEnable": true,

"SnmpV3Enable": true,

"SnmpV3AccessPermission": "read_only",

"SnmpV3AuthProtocol": "sha",

"SnmpV3PrivProtocol": "des",

"SnmpV3Password": "Password@_"

}

响应码：200

【输出说明】

返回状态码200，响应体：

{

"@odata.type": "#ManagerAccount.v1_1_2.ManagerAccount",

"Description": "User Account",

"Enabled": true,

"Id": "3",

"Links": {

"Roles": {

"@odata.id": "/redfish/v1/AccountService/Roles/User"

}

"Locked": false,

"Name": "User Account",

"Oem": {

"Public": {

"IPMIEnable": true,

"SnmpV3AccessPermission": "read_write",

"SnmpV3AuthProtocol": "sha",

"SnmpV3Enable": true,

"SnmpV3PrivProtocol": "des",

"WebEnable": true,

"SnmpV3Password": null,

"SnmpEncryptPwdInit": true

}

"RoleId": "User",

"UserName": "User123",

"Password": null

}

【修改记录】

(1) HDM-1.30.06：请求体Oem.Public新增字段IPMIEnable、WebEnable、SnmpV3Enable 、SnmpV3AccessPermission、SnmpV3AuthProtocol、SnmpV3PrivProtocol

(2) HDM-1.30.09修改响应码为200，增加响应体

(3)仅HDM-1.30.18P5X,B05：角色资源ID:User修改成Commonuser,None修改成Noaccess

(4) HDM-2.0.04：字段删除Oem.Public.KvmEnable、Oem.Public.VmediaEnable

(5) HDM-2.06.00：RoleId中取值Custom1-5修改成CustomRole1-5

(6) HDM-6.13：请求体中新增SnmpV3Password、返回值中新增SnmpV3Password和SnmpEncryptPwdInit字段

4.5.7 删除用户信息

【功能描述】

删除用户信息。

【所属权限模块】

用户配置

【命令格式】

DELETE https://device_ip/redfish/v1/AccountService/Accounts/id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-179 删除用户信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/AccountService/Accounts/3

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

响应码：200

【输出说明】

返回状态码200，响应体：

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "The account was successfully removed.",

"MessageArgs": [],

"MessageId": "Base.1.0.AccountRemoved",

"RelatedProperties": [],

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

【修改记录】

(1) HDM-1.30.09 修改响应码为200，增加响应体

4.5.8 查询角色集合资源信息

【功能描述】

查询角色集合资源信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Roles

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-180 查询角色集合资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Roles

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

"@odata.id": "/redfish/v1/AccountService/Roles",

"@odata.type": "#RoleCollection.RoleCollection",

"Members": [

{

"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"

{

"@odata.id": "/redfish/v1/AccountService/Roles/Operator"

{

"@odata.id": "/redfish/v1/AccountService/Roles/User"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole2"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole3"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole4"

{

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole5"

{

"@odata.id": "/redfish/v1/AccountService/Roles/None"

}

"[email protected]": 9,

"Name": "Roles Collection"

}

响应码：200

【输出说明】

表4-181 查询角色列表信息返回值

字段	类型	字段说明
@odata.context	字符串	角色列表资源模型的 OData 描述信息
@odata.id	字符串	角色列表资源节点的访问路径
@odata.type	字符串	角色列表资源类型
Members	数组	角色资源列表：Operator, Administrator, User, None, CustomRole1~5或自定义名称
[email protected]	数值	服务器当前存在的角色类型的个数

4.5.9 查询指定角色信息

【功能描述】

查询指定角色信息。非admin用户只能查询自身。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Roles/role_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-182 查询指定角色资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
role_id	角色ID	由查询角色列表信息获取

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Roles/Administrator

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Role.Role(*)",

"@odata.id": "/redfish/v1/AccountService/Roles/Administrator",

"@odata.type": "#Role.v1_2_1.Role",

"AssignedPrivileges": [

"ConfigureUsers",

"ConfigureComponents",

"Login",

"ConfigureSelf"

"Description": "Administrator User Role",

"Id": "Administrator",

"IsPredefined": true,

"Name": "User Role",

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

响应码：200

【输出说明】

表4-183 查询指定角色信息返回值

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData 描述信息
@odata.id	字符串	指定角色资源的访问路径
@odata.type	字符串	指定角色资源的类型
AssignedPrivileges	数组	指定权限 "ConfigureUsers"：用户配置 "ConfigureComponents"：常规配置 "Login"：查询权限 "ConfigureSelf"：配置自身
Description	字符串	指定角色资源描述信息
Id	字符串	角色组ID名
IsPredefined	布尔型	是否预设启用
Name	字符串	指定角色资源名称
OemPrivileges	数组	服务器自定义的权限，类 "OemKvm"：远程控制 "OemVmm"：远程媒体 "OemSecurityMgmt"：安全配置 "OemPowerControl"：电源控制 "OemDiagnosis"：维护诊断

【修改记录】

(1) HDM-1.30.06：增加字段OemPrivileges

(2) HDM-2.0.04：统一权限修改，修改字段AssignedPrivileges,OemPrivileges中取值

4.5.10 修改指定角色信息

【功能描述】

修改指定角色信息。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Roles/role_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"AssignedPrivileges": [

"ConfigureComponents",

"ConfigureSelf"

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

【参数说明】

表4-184 修改用户信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或Ipv6
role_id	角色ID	由查询角色列表信息获取说明：只能修改role_id为自定义角色组权限
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
OemKvm	布尔型	远程控制
OemVmm	布尔型	远程媒体
OemSecurityMgmt	布尔型	安全配置
ConfigureComponents	布尔型	常规配置
OemPowerControl	布尔型	电源控制
OemDiagnosis	布尔型	维护诊断
ConfigureSelf	布尔型	配置自身

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/AccountService/Roles/CustomRole1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"AssignedPrivileges": [

"ConfigureComponents",

"ConfigureSelf"

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

响应码：200

【输出说明】

返回状态码200，响应体：

{

"@odata.context": "/redfish/v1/$metadata#Role.Role(*)",

"@odata.id": "/redfish/v1/AccountService/Roles/CustomRole1",

"@odata.type": "#Role.v1_2_1.Role",

"AssignedPrivileges": [

"ConfigureUsers",

"ConfigureComponents",

"Login",

"ConfigureSelf"

"Description": "CustomRoel1 User Role",

"Id": "CustomRole1",

"IsPredefined": true,

"Name": "User Role",

"OemPrivileges": [

"OemKvm",

"OemVmm",

"OemSecurityMgmt",

"OemPowerControl",

"OemDiagnosis"

]

}

【修改记录】

(1) HDM-2.0.04：接口新增

(2) HDM-2.06.00：字段位置修改：将各模块字段放置到AssignedPrivileges或OemPrivileges

(3) HDM-2.08.00：权限模块由安全配置修改成用户配置

4.5.11 查询角色名称

【功能描述】

查询角色名称。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-185 查询角色组名称资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",

"@odata.type": "#RoleCollection.RoleCollection",

"Administrator": "Administrator",

"CustomNameRole1": "CustomRole1",

"CustomNameRole2": "CustomRole2",

"CustomNameRole3": "CustomRole3",

"CustomNameRole4": "CustomRole4",

"CustomNameRole5": "CustomRole5",

"Operator": "Operator",

"User": "User"

}

响应码：200

【输出说明】

表4-186 查询角色组名称资源返回值

字段	类型	字段说明
@odata.context	字符串	指定角色资源模型的OData 描述信息
@odata.id	字符串	指定角色资源的访问路径
@odata.type	字符串	指定角色资源的类型
CustomNameRole1	字符串	自定义角色1（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole2	字符串	自定义角色2（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole3	字符串	自定义角色3（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole4	字符串	自定义角色4（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole5	字符串	自定义角色5（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
Administrator	字符串	Administrator
Operator	字符串	Operator
User	字符串	User

【修改记录】

(1) HDM-2.33：接口新增

(2) HDM-6.16：修正勘误，HDM软件使用CustomNameRole1~CustomNameRole5作为自定义角色1~自定义角色5

4.5.12 修改角色名称

【功能描述】

修改指定角色名称。

【所属权限模块】

用户配置

【命令格式】

PATCH https://device_ip/redfish/v1/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"CustomNameRole1": "CustomNameRole1",

"CustomNameRole2": "CustomNameRole2",

"CustomNameRole3": "CustomNameRole3",

"CustomNameRole4": "CustomNameRole4",

"CustomNameRole5": "CustomNameRole5"

}

【参数说明】

表4-187 修改角色组名称参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或Ipv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
CustomNameRole1	字符串	自定义角色1（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole2	字符串	自定义角色2（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole3	字符串	自定义角色3（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole4	字符串	自定义角色4（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）
CustomNameRole5	字符串	自定义角色5（长度为1～16个字符，仅支持字母、数字、句点（.）、连接符（-）和下划线（_）和特殊字符（@），区分大小写）

【使用实例】

【请求样例】

PATCH https://192.168.18.18/AccountService/Roles/Oem/Public/RoleNames

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"CustomNameRole1": "abc",

"CustomNameRole2": "123",

"CustomNameRole3": "zxc",

"CustomNameRole4": "h3c",

"CustomNameRole5": "vbn",

}

响应码：200

【输出说明】

返回状态码200，响应体：

{

"@odata.context": "/redfish/v1/$metadata#RoleCollection.RoleCollection",

"@odata.id": "/redfish/v1/AccountService/Roles/Oem/Public/RoleNames",

"@odata.type": "#RoleCollection.RoleCollection",

"Administrator": "Administrator",

"CustomNameRole1": "abc",

"CustomNameRole2": "123",

"CustomNameRole3": "zxc",

"CustomNameRole4": "h3c",

"CustomNameRole5": "vbn",

"Operator": "Operator",

"User": "User"

}

【修改记录】

(1) HDM-2.33：接口新增

(2) HDM-6.16：修正勘误，HDM软件使用CustomNameRole1~CustomNameRole5作为自定义角色1~自定义角色5

4.5.13 导入弱口令字典

【功能描述】

导入弱口令字典

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content":"sftp:// username:password@ip/filename"

}

【参数说明】

表4-188 导入弱口令密码参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
Type	字符串	URI
Content	文件路径	文件传输协议：sftp 2、操作路径：不支持中文 3、文件名字、账号、密码：长度最长为31，总长度不超过255，特殊符号支持 @!$^&()_+.[]{}-=~ 4、仅支持.txt文件类型，当前仅支持Unxi格式的字典文件 5、导入文件大小不超过100K，单行弱口令不超过40个字符，文件内容支持换行符、大小写字母、数字、空格和特殊字符`~!@#$%^&*()_+-=[]\{}\|;':",./<>?（不符合规则的字符或超长的部分将会被格式化裁剪），格式化后文件内容不能为空

【使用实例】

【请求样例】

POST http://172.14.105.149/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ImportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content":"sftp://sys45167:[email protected]/weakpwdict.txt"

}

【应答示例】

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.ImportOKNone",

"RelatedProperties": "[]",

"Message": "",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

响应码：200

【输出说明】

表4-189 导入弱口令密码返回值

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性 Redfish支持的严重级别包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改记录】

(1) HDM-6.06：接口新增

4.5.14 导出弱口令字典

【功能描述】

导出弱口令字典

【所属权限模块】

用户配置

【命令格式】

POST https://device_ip/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content":"sftp:// username:password@ip/filename "

}

【参数说明】

表4-190 导出弱口令密码参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
Type	字符串	URI
Content	文件路径	1．文件传输协议：sftp 2、操作路径：不支持中文 3、文件名字、账号、密码：长度最长为31，总长度不超过255，特殊符号支持 @!$^&()_+.[]{}-=~

【使用实例】

【请求样例】

POST http://172.14.105.149/redfish/v1/AccountService/Actions/Oem/Public/AccountService.ExportWeakPasswordDictionary

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Type":"URI",

"Content":"sftp://sys45167:[email protected]/weakpwdict.txt"

}

【应答示例】

{

"error": {

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information.",

"@Message.ExtendedInfo": [

{

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"MessageId": "Base.1.0.ExportOKNone",

"RelatedProperties": "[]",

"Message": "",

"MessageArgs": "[]",

"Severity": "OK",

"Resolution": "None"

}

]

}

响应码：200

【输出说明】

表4-191 导出弱口令密码返回值

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息
@odata.type	字符串	消息资源的OData描述信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性 Redfish支持的严重级别包括： OK、 Warning、Critical
Resolution	字符串	解决建议

【修改记录】

(1) HDM-6.06：接口新增

4.6 SessionService 资源的操作

4.6.1 创建会话

【功能描述】

创建新会话。

【所属权限模块】

安全配置

【功能说明】

当前Redfish最大能够创建10个会话。

【命令格式】

POST https://device_ip/redfish/v1/SessionService/Sessions

【请求头】

Content-Type: application/json

【请求消息体】

{

"UserName":name,

"Password":password

}

【参数说明】

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
name	新建会话对应的用户	HDM系统的用户
password	新建会话对应的用户的密码	HDM系统的用户对应的密码注：密码最长20位

【使用指南】

在对服务器的Redfish操作过程中，该POST操作是首先要执行的。因为后续大部分操作，都需要在“ Headers”中携带“ X-Auth-Token”值用于鉴权，而“ X-Auth-Token”可通过本操作获得。

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/SessionService/Sessions

【请求头】

Content-Type: application/json

【请求消息体】

{

"UserName":"admin",

"Password":"Password@_"

}

【应答示例】Body部分

{

"@odata.context": "/redfish/v1/$metadataSessionService/Sessions",

"@odata.etag": "W/\"1611832123\"",

"@odata.id": "/redfish/v1/SessionService/Sessions/db3311a9e26e8214551100534853c327",

"@odata.type": "#Session.v1_1_0.Session",

"Description": "Session for user admin",

"Id": "db3311a9e26e8214551100534853c327",

"Name": "admin Session",

"UserName": "admin"

}

【应答示例】Header部分

Strict-Transport-Security→max-age=31536000; includeSubdomains

Server→AMI MegaRAC Redfish Service

Location→/redfish/v1/SessionService/Sessions/db3311a9e26e8214551100534853c327

X-Auth-Token→LivOsTWPrllXaVck4Wgy64tkMt5KvGYAhYTcAyTU/38=

ETag→W/"cc1b4233d7e5f28d830d03aeabcea0ce"

Access-Control-Allow-Origin→*

Access-Control-Expose-Headers→X-Auth-Token

Access-Control-Allow-Headers→X-Auth-Token

Access-Control-Allow-Credentials→true

Cache-Control→no-cache, must-revalidate

Link→<http://redfish.dmtf.org/schemas/v1/Session.v1_1_0.json>; rel=describedby

Link→</redfish/v1/SessionService/Sessions/db3311a9e26e8214551100534853c327>; path=

Content-Type→application/json; charset=UTF-8

OData-Version→4.0

Content-Length→342

Date→Thu, 28 Jan 2021 11:08:44 GMT

响应码：201

表4-192 创建会话返回值

字段	类型	字段说明
@odata.context	字符串	会话信息资源模型的OData描述信息
@odata.etag	字符串	ETAG参数
@odata.id	字符串	会话信息资源节点的访问路径
@odata.type	字符串	会话信息资源类型
Description	字符串	会话描述信息
Id	字符串	会话ID
Name	字符串	会话名称
UserName	字符串	用户名称

【输出说明】

响应码：201，表示创建成功。

4.6.2 查询会话集合资源信息

【功能描述】

查询服务器当前所有会话信息。

【所属权限模块】

查询模块

【命令格式】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-193 查询会话参数说明

参数	参数说明	取值
IP	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/SessionService/Sessions

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SessionCollection.SessionCollection",

"@odata.id": "/redfish/v1/SessionService/Sessions",

"@odata.type": "#SessionCollection.SessionCollection",

"Members": [

{

"@odata.id": "/redfish/v1/SessionService/Sessions/735fe1ce672b88382a79fb0ff7e20a2e"

}

"Name": "Session Collection"

}

响应码：200

【输出说明】

表4-194 查询会话集合资源信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	会话集合资源信息模型的OData描述信息
@odata.id	字符串	会话集合资源信息节点的访问路径
@odata.type	字符串	会话集合资源信息的类型
Members	数组	会话列表
[email protected]	数值	会话数量
Name	字符串	会话资源的名称

4.6.3 查询指定会话资源信息

【功能描述】

查询服务器当前指定会话资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/SessionService/Sessions/session_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-195 查询会话参数说明

参数	参数说明	取值
IP	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
session_id	会话ID	由“查询会话集合资源信息”中获取

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/SessionService/Sessions/107

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Session.Session",

"@odata.id": "/redfish/v1/SessionService/Sessions/107",

"@odata.type": "#Session.v1_1_0.Session",

"Description": "Session for user admin",

"Id": "107",

"Name": "admin Session",

"Oem": {

"UserIP": "10.99.160.48",

"UserRole": "Administrator",

"UserTag": "Web HTTPS"

"UserName": "admin"

}

响应码：200

【输出说明】

表4-196 查询指定会话信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	指定会话资源模型的访问路径
@odata.id	字符串	指定会话信息资源节点的访问路径
@odata.type	字符串	指定会话信息资源类型
Id	字符串	指定会话资源的唯一标识
Name	字符串	指定会话的名称
UserName	字符串	指定会话的用户名称
Oem.UserIP	字符串	该会话对应的用户的地址
Oem.UserTag	字符串	该会话对应的登录接口：Redfish
Oem.UserRole	字符串	用户角色

【修改记录】

(1) HDM-1.30.09：接口新增

(2) HDM-1.30.10：字段UserId删除

4.6.4 删除指定会话

【功能描述】

删除指定会话。

【所属权限模块】

安全配置

【命令格式】

DELETE https://device_ip/redfish/v1/SessionService/Sessions/session_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【使用指南】

本接口只可删除redish侧会话，不可删除非redfish侧会话。

【参数说明】

表4-197 修改会话服务信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
session_id	会话ID	由“查询会话集合资源信息”中获取

【使用实例】

【请求样例】

DELETE https://device_ip/redfish/v1/SessionService/Sessions/session_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

响应码：200

【响应样例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": "[]",

"MessageId": "Base.1.0.Success",

"RelatedProperties": "[]",

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

【输出说明】

表4-198 删除指定会话服务信息返回值

字段	类型	字段说明
code	字符串	指示消息注册表中特定消息ID的字符串
message	字符串	与消息注册表中的消息对应的易读的错误消息。
@Message.ExtendedInfo	对象	错误消息扩展信息
@odata.type	字符串	消息资源的OData描述信息
Message	字符串	详细信息
MessageArgs	数组	信息参数
MessageId	字符串	信息ID
RelatedProperties	数组	消息相关属性
Resolution	字符串	解决建议
Severity	字符串	严重性，Redfish支持的严重级别包括： OK、 Warning、Critical

【修改记录】

(1) HDM-1.30.12: 接口新增

4.6.5 查询会话服务信息

【功能描述】

查询服务器当前会话服务的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-199 查询会话服务信息参数说明

参数	参数说明	取值
IP	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用指南】

无。

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SessionService.SessionService",

"@odata.id": "/redfish/v1/SessionService",

"@odata.type": "#SessionService.v1_1_3.SessionService"

"Description": "Session Service",

"Id": "SessionService",

"Name": "Session Service",

"ServiceEnabled": true,

"SessionTimeout": 1800,

"Sessions": {

"@odata.id": "/redfish/v1/SessionService/Sessions"

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

【输出说明】

表4-200 查询会话服务信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	SessionService资源模型的OData描述信息
@odata.id	字符串	SessionService资源节点的访问路径
@odata.type	字符串	SessionService 资源类型
Id	字符串	SessionService 的资源ID
Name	字符串	SessionService 资源的名称
ServiceEnabled	布尔型	SessionService使能
SessionTimeout	数值	Redfish会话超时时长，默认时长1800s
Sessions	对象	会话列表
@odata.id	字符串	会话列表的访问路径
Status	对象	会话管理的状态，包括： Health：会话管理健康状态 State：会话管理使能状态

4.6.6 修改会话服务信息

【功能描述】

修改会话服务信息。

【所属权限模块】

安全配置

【命令格式】

PATCH https://device_ip/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: ifmatch_value

【请求消息体】

{

"ServiceEnabled": true，

"SessionTimeout": 1800

}

【参数说明】

表4-201 修改会话服务信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
ifmatch_value	请求消息的匹配参数	可通过对相应资源发起GET 操作，从响应头中获取（对应于“ETag”参数）
ServiceEnabled	布尔型	是否使能
SessionTimeout	数值	会话超时时长；范围：30～86400；单位s

【使用实例】

【请求样例】

PATCH https://192.168.18.18/redfish/v1/SessionService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

If-Match: W/"6e8c96325a9b7c6a6e5e9f23616fbce0"

【请求消息体】

{

"ServiceEnabled": true，

"SessionTimeout": 1800

}

响应码：200

【响应样例】

{

"@odata.context": "/redfish/v1/$metadata",

"@odata.id": "/redfish/v1/SessionService",

"@odata.type": "#SessionService.v1_1_3.SessionService"

"Description": "Session Service",

"Id": "SessionService",

"Name": "Session Service",

"ServiceEnabled": true,

"SessionTimeout": 1800,

"Sessions": {

"@odata.id": "/redfish/v1/SessionService/Sessions"

"Status": {

"Health": "OK",

"State": "Enabled"

}

【输出说明】

表4-202 修改会话服务信息返回值

字段	类型	字段说明
@odata.context	字符串	SessionService资源模型的OData描述信息
@odata.id	字符串	SessionService资源节点的访问路径
@odata.type	字符串	SessionService资源类型
Id	字符串	SessionService资源的ID
Name	字符串	SessionService资源的名称
SessionTimeout	数字	Redfish会话超时时长
Sessions	会话列表
@odata.id	字符串	会话列表的访问路径
Status.Health	字符串	健康状态
Status.State	字符串	使能状态

【修改记录】

(1) HDM-1.30.09：修改响应码为200，增加响应体

4.7 UpdateService 资源的操作

4.7.1 查询服务器当前升级服务资源的信息

【功能描述】

查询服务器当前升级服务资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-203 查询服务器当前升级服务资源的信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#UpdateService.UpdateService",

"@odata.id": "/redfish/v1/UpdateService",

"@odata.type": "#UpdateService.v1_2_1.UpdateService",

"Actions": {

"#UpdateService.SimpleUpdate": {

"@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo",

"target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate"

}

"Description": "Redfish Update Service",

"FirmwareInventory": {

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"

"Id": "UpdateService",

"Name": "Update Service",

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

}

响应码：200

注意：Oem字段升级过程与升级状态仅在升级进行时显示，没有升级进行时为null

表4-204 查询服务器当前升级服务资源的信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	服务器升级资源模型的OData描述信息
@odata.id	字符串	服务器升级资源节点的访问路径
@odata.type	字符串	服务器升级资源类型
Actions	Actions指定管理资源可执行的操作
UpdateService.SimpleUpdate	对象	固件升级操作资源路径
Id	字符串	指定升级服务资源的 ID
Name	字符串	指定升级服务资源的名称
ServiceEnabled	布尔型	升级服务使能状态
Status.Health	字符串	指定升级服务资源的健康状态
Status.State	字符串	指定升级服务资源的使能状态
FirmwareInventory	对象	可升级固件列表的链接

【修改记录】

(1) HDM-1.30.09 删除Oem字段，此部分在TaskService接口中呈现

4.7.2 查询可升级固件集合资源信息

【功能描述】

查询服务器当前可升级的固件集合资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/FirmwareInventory

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-205 查询服务器当前可升级的固件集合资源的信息参数说明

参数	参数说明	取值
IP	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/FirmwareInventory

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection",

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory",

"@odata.type": "#SoftwareInventoryCollection.SoftwareInventoryCollection",

"Description": "Collection of Firmware Inventory resources available to the UpdateService",

"Members": [

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HDM"

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/CPLD"

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BIOS"

{

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/PSU"

}

"[email protected]": 4,

"Name": "Firmware Inventory Collection"

}

响应码：200

【参数说明】

表4-206 查询服务器当前可升级的固件集合资源的信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	服务器可升级固件集合资源模型的OData描述信息
@odata.id	字符串	服务器可升级固件集合资源节点的访问路径
@odata.type	字符串	服务器可升级固件集合资源类型
Description	字符串	服务器可升级固件集合资源的信息描述
Members	数组	可升级固件资源的名称
[email protected]	数值	可升级固件的个数
Name	字符串	可升级固件集合资源的名称

4.7.3 查询指定的可升级固件资源的信息

【功能描述】

查询服务器指定的可升级固件资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/UpdateService/FirmwareInventory/softid

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-207 查询服务器指定的可升级固件资源的信息参数说明

参数	参数说明	取值
IP	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
softid	固件类型	固件类型，由“查询可升级固件集合资源信息”获取

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/UpdateService/FirmwareInventory/HDM

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#UpdateService/FirmwareInventory/Members/$entity",

"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/HDM",

"@odata.type": "#SoftwareInventory.v1_2_0.SoftwareInventory",

"Id": "HDM",

"Name": "HDM",

"RelatedItem": [

{

"@odata.id": "/redfish/v1/Managers/1"

}

"SoftwareId": "HDM",

"Status": {

"Health": "OK",

"State": "Enabled"

"Updateable": true,

"Version": "2.10.00 HDM V100R001B05D012"

}

响应码：200

【输出说明】

表4-208 查询服务器指定的可升级固件资源的信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	服务器指定可升级固件资源模型的OData描述信息
@odata.id	字符串	服务器指定可升级固件资源节点的访问路径
@odata.type	字符串	服务器指定可升级固件资源类型
Id	字符串	可升级固件资源的 ID
Name	字符串	可升级固件资源的名称
RelatedItem	数组	导航资源：关联的部件资源
Status. Health	字符串	可升级固件资源的健康状态
Status. State	字符串	可升级固件资源的使能状态
SoftwareId	字符串	固件类型（HDM/BIOS/各类CPLD/PSU） CPLD包含CPLD，AUXCPLD，STBCPLD，DBCPLD，PDBCPLD，NDCPLD， PDBSCPLD， GPUFPGA(仅R5300G5 Redstone)，FANMCU(仅R5500G5 AMD/INTEL)，REPO类型；当前设备具体支持类型由“查询可升级固件集合资源信息”获取
Updateable	布尔型	固件有效性
Version	字符串	固件版本

【修改记录】

(1) HDM-2.26：新增对GPUFPGA固件(仅R5300G5 Redstone)升级支持

(2) HDM-2.33：新增对FANMCU固件(仅R5500G5 AMD/INTEL)升级支持

(3) HDM-2.42：新增对REPO固件升级支持

4.7.4 升级固件

【功能描述】

升级服务器固件。

【所属权限模块】

维护诊断

【命令格式】

POST https://device_ip/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

HTTP及TFTP：

{

"ImageURI":"http://IP/image.bin",(tftp://IP/image.bin)

"TransferProtocol": protocol,

"Oem": {

"Public": {

"ImageType":type,

"PreserveConfig":true,

"Reboot":false,

"BiosUpdateFlag":"all",

"ForceUpgrade":true //仅REPO固件类型下使用

"ImageMd5URI":"http://IP/md5.txt",(tftp://IP/md5.txt), //仅REPO固件类型下使用

}

SFTP:

{

"ImageURI":"sftp://username:passwd@IP/HDM-1.11.29P21_signed.bin",

"TransferProtocol":"SFTP",

"Oem": {

"Public": {

"ImageType":type,

"PreserveConfig":true,

"Reboot":false,

"BiosUpdateFlag":"all",

"ForceUpgrade":true //仅REPO固件类型下使用

"ImageMd5URI":"sftp://username:passwd@IP/md5.txt", //仅REPO固件类型下使用

}

【参数说明】

表4-209 升级固件参数说明

参数	参数说明	取值
IP	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
ImageURI	字符串	升级包所在路径

TransferProtocol	字符串	传输协议：HTTP/TFTP/SFTP
Oem.Public.ImageType	字符串	固件类型（HDM/BIOS/各类CPLD/PSU/ REPO） CPLD包含CPLD，AUXCPLD，STBCPLD，DBCPLD，PDBCPLD，NDCPLD， PDBSCPLD， GPUFPGA(仅R5300G5 Redstone) ，FANMCU(仅R5500G5 AMD/INTEL)类型；当前设备具体支持类型由“查询可升级固件集合资源信息”获取
Oem.Public.PreserveConfig	布尔型	配置保留标志： true：保留 false：覆盖
Oem.Public.Reboot	布尔型	重启标志： true：重启 false: 不重启
Oem.Public.BiosUpdateFlag	字符串	bios升级固件类型，无此字段默认为all "all"：升级bios+ME "bios"：仅升级bios "me"：仅升级ME
Oem.Public.ForceUpgrade	布尔型	仅REPO固件升级，强制升级选项： false：仅高版本升级 true：强制升级
Oem.Public.ImageMd5URI	字符串	升级包镜像的md5值文件所在路径，仅REPO固件升级使用

【使用实例】

【请求样例】

POST https://192.168.18.18/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"ImageURI":"http://192.168.190.51/HDM-1.11.20_signed.dbg.bin",

"TransferProtocol": "HTTP",

"Oem": {

"Public": {

"ImageType":"HDM",

"PreserveConfig":true,

"Reboot":false,

"BiosUpdateFlag":"all"

}

响应码：202

【输出说明】

响应码：202，表示操作成功，响应体为：

{

"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

"@odata.type": "#TaskCollection.TaskCollection",

"Description": "Task Collection",

"Members": [

{

"@odata.id": "/redfish/v1/TaskService/Tasks/1"

}

GET https://device_ip/redfish/v1/TaskService

"Name": "Task Collection"

}

【修改记录】

(1) HDM-1.30.07：支持SFTP升级

(2) HDM-1.30.09：修改响应码，且升级后增加响应体

(3) HDM-1.30.17：新增字段BiosUpdateFlag，同时合入HDM-1.30.15P02

(4) HDM-2.11.93：TFTP支持IPv6

(5) HDM-2.27：新增对GPUFPGA固件(仅R5300G5 Redstone)升级支持

(6) HDM-2.33：新增对FANMCU固件(仅R5500G5 AMD/INTEL)升级支持

(7) HDM-2.42：新增对REPO固件升级支持，包括新增字段Oem.Public.ImageMd5URI、Oem.Public.ForceUpgrade

4.8 TaskService 资源的操作

4.8.1 查询服务器当前任务服务资源的信息

【功能描述】

查询服务器当前任务服务资源的信息。

【所属权限模块】

查询模块

【命令格式】

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-210 查询任务服务资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#TaskService.TaskService",

"@odata.id": "/redfish/v1/TaskService",

"@odata.type": "#TaskService.v1_1_1.TaskService",

"CompletedTaskOverWritePolicy": "Oldest",

"DateTime": "2019-08-21T17:08:34+08:00",

"Description": "Task Service",

"Id": "TaskService",

"LifeCycleEventOnTaskStateChange": false,

"Name": "Task Service",

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

"Tasks": {

"@odata.id": "/redfish/v1/TaskService/Tasks"

}

响应码：200

【输出说明】

表4-211 任务服务资源信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	任务服务资源模型的OData描述信息
@odata.id	字符串	指定任务资源的访问路径
@odata.type	字符串	任务服务资源的类型
Id	字符串	任务服务资源的ID
Name	字符串	指任务服务资源的名称
DateTime	字符串	系统时间
CompletedTaskOverWritePolicy	字符串	对已完成的任务的处理方法 Oldest：新任务覆盖最早的任务
LifeCycleEventOnTaskStateChange	布尔型	任务状态变化时是否上报事件 false：不上报事件
Status	对象	任务服务资源的状态，包括： Status：使能状态 Health：健康状态
ServiceEnabled	布尔型	任务服务使能状态。
Tasks	任务列表
@odata.id	字符串	指定任务的访问路径

【修改记录】

(1) HDM-1.30.06：接口新增

4.8.2 查询服务器当前任务集合资源的信息

【功能描述】

查询服务器当前任务集合资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/TaskService/Tasks

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-212 查询任务集合资源信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService/Tasks

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#TaskCollection.TaskCollection",

"@odata.id": "/redfish/v1/TaskService/Tasks",

"@odata.type": "#TaskCollection.TaskCollection",

"Name": "Task Collection",

"[email protected]": 3,

"Members": [

{

"@odata.id": "/redfish/v1/TaskService/Tasks/1"

{

"@odata.id": "/redfish/v1/TaskService/Tasks/2"

{

"@odata.id": "/redfish/v1/TaskService/Tasks/3"

}

]

}

响应码：200

【输出说明】

表4-213 任务集合资源信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	任务服务资源模型的OData描述信息
@odata.id	字符串	指定任务资源的访问路径
@odata.type	字符串	任务服务资源的类型
Name	字符串	任务集合资源的名称
[email protected]	数值	当前运行的任务数量
Members	任务列表
@odata.id	字符串	指定任务的访问路径

【修改记录】

(1) HDM-1.30.06：接口新增

4.8.3 查询服务器指定任务资源的信息

【功能描述】

查询服务器指定任务资源的信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/TaskService/Tasks/task_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-214 查询服务器指定任务资源的信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
task_id	待查询任务的ID	可从任务集合资源中获取

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/TaskService/Tasks/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#Task.Task",

"@odata.id": "/redfish/v1/TaskService/Tasks/1",

"@odata.type": "#Task.v1_2_0.Task",

"Description": "BMC Update Task",

"EndTime": "2020-12-10T00:30:56+-8:00",

"Id": "1",

"Messages": {

"Message": "Update The BMC Firmware",

"MessageArgs": [

"BMC Firmware"

"MessageId": "HDM.1.0.FirmwareUpdateComponent",

"RelatedProperties": [

"BMC"

"Severity": "OK",

"Trigger Condition": "BMC Reset."

"Name": "Update Task",

"Oem": {

"Public": {

"Task Description": "BMC Update Task",

"Task Percentage": "33%"

}

"StartTime": "2020-12-10T00:30:50+-8:00",

"TaskState": "Verifying",

"TaskStatus": "OK"

}

响应码：200

【输出说明】

表4-215 服务器指定任务资源的信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	任务服务资源模型的OData描述信息
@odata.id	字符串	指定任务资源的访问路径
@odata.type	字符串	任务服务资源的类型
Id	字符串	指定任务资源的ID
Description	字符串	指定任务资源的描述信息
Name	字符串	指定任务资源的名称
TaskState	字符串	指定任务资源的状态 · Running · Uploading · Verifying · Updating · Waiting For Effect · Going To Effect · Completed · Failed · Cancelled · Mounted · Downloading
StartTime	字符串	任务当前状态起始时间
EndTime	字符串	任务当前状态的预计结束时间
TaskStatus	字符串	任务的运行状态 · OK · FAILED 注：针对多电源升级的任务，当所有电源升级失败或无需升级时显示FAILED，具体电源升级是否成功需参考操作日志
Messages	对象	任务的相关信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性级别 · OK · Warning · Critical
Trigger Condition	字符串	触发条件（功能的生效方式，任务注册时输入），如有： · BMC Reset · OS Reset · OS Power Off · Automatic · Power Cycle · PSU Reset
Task Description	字符串	任务描述
Task Percentage	字符串	任务完成进度

【修改记录】

(1) HDM-1.30.06：接口新增

(2) HDM-1.30.08：新增支持SDS一键收集，MCA收集，KVM镜像挂载，配置导入导出任务

4.8.4 删除服务器指定任务资源

【功能描述】

删除服务器指定任务资源

【所属权限模块】

维护诊断

【命令格式】

DELETE https://device_ip/redfish/v1/TaskService/Tasks/task_id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-216 查询服务器指定任务资源的信息参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
task_id	待查询任务的ID	可从任务集合资源中获取

【使用实例】

【请求样例】

DELETE https://192.168.18.18/redfish/v1/TaskService/Tasks/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"error": {

"@Message.ExtendedInfo": [

{

"@Message.ExtendedInfo": {

"@odata.type": "/redfish/v1/$metadata#MessageRegistry.1.0.0.MessageRegistry",

"Message": "Successfully Completed Request",

"MessageArgs": [],

"MessageId": "Base.1.0.Success",

"RelatedProperties": [],

"Resolution": "None",

"Severity": "OK"

}

"code": "Base.1.0.GeneralError",

"message": "A general error has occurred. See ExtendedInfo for more information."

}

响应码：200

【输出说明】

表4-217 服务器指定任务资源的信息返回参数说明

字段	类型	字段说明
@odata.context	字符串	任务服务资源模型的OData描述信息
@odata.type	字符串	任务服务资源的类型
Messages	对象	任务的相关信息
MessageId	字符串	消息ID
RelatedProperties	数组	消息相关属性
Message	字符串	详细信息
MessageArgs	数组	信息参数
Severity	字符串	严重性级别 · OK · Warning · Critical

【修改记录】

(1)HDM-2.93: 接口新增

4.9 EventService 资源操作

4.9.1 查询事件服务资源

【功能描述】

查询服务器事件服务资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/EventService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-218 查询事件服务资源参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.18.18/redfish/v1/EventService

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#EventService.EventService",

"@odata.id": "/redfish/v1/EventService",

"@odata.type": "#EventService.v1_1_0.EventService",

"Actions": {

"#EventService.SubmitTestEvent": {

"@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo",

"target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent"

}

"DeliveryRetryAttempts": 3,

"DeliveryRetryIntervalSeconds": 60,

"Description": "Event Service",

"EventTypesForSubscription": [

"StatusChange",

"ResourceUpdated",

"ResourceAdded",

"ResourceRemoved",

"Alert"

"Id": "EventService",

"Name": "Event Service",

"ServiceEnabled": true,

"Status": {

"Health": "OK",

"State": "Enabled"

"Subscriptions": {

"@odata.id": "/redfish/v1/EventService/Subscriptions"

}

响应码：200

【输出说明】

表4-219 EventService资源信息说明

字段	类型	字段说明
@odata.context	字符串	EventService资源模型的OData描述信息
@odata.id	字符串	EventService资源节点的访问路径
@odata.type	字符串	EventService资源类型
Actions	EventService可执行的操作【暂不支持】
#EventService.SubmitTestE vent	对象	发送测试事件
@Redfish.ActionInfo	字符串	发送测试事件操作信息的查询路径
DeliveryRetryAttempts	数字	指事件订阅发送失败最大尝试次数
DeliveryRetryIntervalSeconds	数字	指发送任何给定事件的重试尝试之间的秒数
EventTypesForSubscription	枚举	指可以订阅的事件的类型，取值为以下合法值的组合： StatusChange：资源状态改变事件 ResourceUpdated：资源更新事件 ResourceAdded：资源添加事件 ResourceRemoved：资源移除事件 Alert：告警事件
ServiceEnabled	布尔	事件上报开关状态
Id	字符串	EventService资源的ID
Name	字符串	事件订阅资源名称
Status	对象	事件订阅资源的状态，包括： Status：使能状态 Health：健康状态
Subscriptions	对象	指事件目标资源的集合的导航资源

【修改记录】

(1) HDM-1.30.09：接口新增

4.9.2 创建事件订阅资源

【功能描述】

创建事件订阅资源。

【所属权限模块】

常规配置

【命令格式】

POST https://device_ip/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Destination": "https://172.16.11.95",

"EventTypes": [

"StatusChange",

"ResourceUpdated",

"ResourceAdded",

"ResourceRemoved",

"Alert"

"HttpHeaders": {

"Content-Type": "application/json",

"OData-Version": "4.0",

"X-Auth-Token":"2e751b825163447d30d3021c98116221"

"Context": "event subscription context string",

"Protocol":"Redfish",

"MessageIds":[ ],

"OriginResources":[ ]

}

【参数说明】

表4-220 创建事件订阅资源的请求参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
Destination	字符串	事件订阅接收地址
EventTypes	数组	数组事件订阅监听的事件类型注：不支持订阅指定的事件，仅支持全部上报
HttpHeaders	数组	事件订阅 HTTP 头参数，事件上报时携带。 X-Auth-Token由/redfish/v1/SessionService/Sessions创建会话时获得
Context	字符串	事件订阅上下文信息
Protocol	字符串	事件订阅使用的协议, 当前取值只能为Redfish
MessageIds	数组	事件订阅消息 Id 匹配列表
OriginResources	数组	事件订阅事件源匹配列表, 当前仅支持全部订阅，填写空，有其他填写都默认全部订阅

【使用实例】

【请求样例】

post https://192.168.30.151/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

{

"Destination": "https://172.16.11.95",

"EventTypes": [

"StatusChange",

"ResourceUpdated",

"ResourceAdded",

"ResourceRemoved",

"Alert"

"HttpHeaders": {

"Content-Type": "application/json",

"OData-Version": "4.0",

"X-Auth-Token":"2e751b825163447d30d3021c98116221"

"Context": "event subscription context string",

"Protocol":"Redfish",

"MessageIds":[

"OriginResources":[ ]

}

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

"@odata.id": "/redfish/v1/EventService/Subscriptions/1",

"@odata.type": "#EventDestination.v1_3_0.EventDestination",

"Context": "event subscription context string",

"Description": "Event Subscription",

"Destination": "https://192.168.1.44",

"EventTypes": [

"ResourceRemoved",

"ResourceAdded",

"StatusChange",

"ResourceUpdated",

"Alert"

"HttpHeaders": null,

"Id": "2",

"MessageIds": [],

"Name": "Subscription 2",

"OriginResources": [],

"[email protected]": 0,

"Protocol": "Redfish"

}

响应码：201

【输出说明】

201表示创建成功。

【修改记录】

(1) HDM-1.30.09：接口新增

(2) 仅HDM-1.30.18P5X,B05：返回体中字段@odata.id修改成指定事件订阅资源1的路径

(3) HDM-2.06.00字段Id类型从数值修改成字符串

(4) HDM-2.11.97：返回体新增字段HttpHeaders，值为null

4.9.3 查询事件订阅资源集合

【功能描述】

查询事件订阅集合资源。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-221 查询事件订阅集合资源的参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得

【使用实例】

【请求样例】

GET https://192.168.30.151/redfish/v1/EventService/Subscriptions

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#EventDestinationCollection.EventDestinationCollection",

"@odata.id": "/redfish/v1/EventService/Subscriptions",

"@odata.type": "#EventDestinationCollection.EventDestinationCollection",

"Description": "Collection for Event Subscriptions",

"Members": [

{

"@odata.id": "/redfish/v1/EventService/Subscriptions/1"

{

"@odata.id": "/redfish/v1/EventService/Subscriptions/2"

}

"Name": "Event Subscriptions Collection"

}

响应码：200

【输出说明】

表4-222 查询事件订阅集合资源的返回参数说明

字段	类型	字段说明
@odata.context	字符串	事件订阅集合资源模型的OData描述信息
@odata.id	字符串	事件订阅集合资源的访问路径
@odata.type	字符串	事件订阅集合资源的类型
Name	字符串	事件订阅集合资源的名称
Description	字符串	事件订阅集合描述
[email protected]	数值	事件订阅集合资源数量
Members	事件订阅资源列表
@odata.id	字符串	单个事件订阅资源节点的访问路径

【修改记录】

(1) HDM-1.30.09：接口新增

4.9.4 查询事件订阅资源信息

【功能描述】

查询事件订阅资源信息。

【所属权限模块】

查询模块

【命令格式】

GET https://device_ip/redfish/v1/EventService/Subscriptions/id

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【参数说明】

表4-223 查询事件订阅信息的参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6
TOKEN	请求消息的认证令牌	由/redfish/v1/SessionService/Sessions创建会话时获得
Id	事件订阅资源的ID	可从“查询事件订阅资源集合”中获取

【使用实例】

【请求样例】

GET https://192.168.30.151/redfish/v1/EventService/Subscriptions/1

【请求头】

X-Auth-Token:TOKEN

Content-Type: application/json

【请求消息体】

无

【应答示例】

{

"@odata.context": "/redfish/v1/$metadata#EventDestination.EventDestination",

"@odata.id": "/redfish/v1/EventService/Subscriptions/1",

"@odata.type": "#EventDestination.v1_3_0.EventDestination",

"Context": "event subscription context string",

"Description": "Event Subscription",

"Destination": "https://172.16.11.95",

"EventTypes": [

"ResourceRemoved",

"ResourceUpdated",

"StatusChange",

"ResourceAdded",

"Alert"

"HttpHeaders": null,

"Id": "1",

"MessageIds": [

"Events.2.5.PSInputLostInfo"

"Name": "Subscription 1",

"OriginResources": [

"/redfish/v1/Chassis/1/Power#/PowerSupplies/1"