PCIeDevices
更新时间： 2026/11/04
在AtomGit上查看源码ResourceDefinition
uris
/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id
properties
| 名称 | 类型 | 是否只读 | 取值范围/枚举值 | 说明 |
|---|---|---|---|---|
| @odata.context | string | true | - | 指定PCIe设备资源模型的OData描述信息 |
| @odata.id | string | true | - | 指定PCIe设备资源的访问路径 |
| @odata.type | string | true | - | 指定PCIe设备资源的类型 |
| Id | string | true | - | 指定PCIe设备资源ID |
| Name | string | true | - | 指定PCIe设备资源名称 |
| Description | string | true | - | 指定PCIe设备的描述 |
| Manufacturer | string | true | - | 指定PCIe设备的生成厂商 |
| Model | string | true | - | 指定PCIe设备的型号 |
| SerialNumber | string | true | - | 指定PCIe设备的序列号 |
| UUID | string | true | - | 指定PCIe设备的uuid |
| FirmwareVersion | string | true | - | 指定PCIe设备的固件版本 |
| PartNumber | string | true | - | 指定PCIe设备的部件号 说明 openUBMC 25.12 LTS及以上版本支持 |
| DeviceType | string | true | - | 指定PCIe设备的设备类型 说明 openUBMC 25.12 LTS及以上版本支持 |
| Status { | object | true | - | 指定PCIe设备的状态 |
| Status.State | string | true | - | 指定PCIe设备的内存的在位状态 |
| Status.Health | string | true | - | 指定PCIe设备服务健康状态 |
| Status.Oem { | object | true | - | 自定义属性 |
| Status.Oem.Public { | object | true | - | 自定义属性 |
| Status.Oem.Public.Severity | string | false | - | 指定PCIe设备的自定义健康状态 |
| } | ||||
| } | ||||
| } | ||||
| Oem { | object | true | - | 指定PCIe设备的自定义信息 |
| Oem.Public { | object | true | - | 指定PCIe设备的自定义信息 |
| Oem.Public.BoardId | string | true | - | 指定网络适配器的单板ID |
| Oem.Public.PCBVersion | string | true | - | 指定网络适配器的PCB版本 |
| Oem.Public.ProductName | string | true | - | 产品名称，如2288H V5 |
| Oem.Public.DeviceLocator | string | true | - | 指定PCIe设备的丝印 |
| Oem.Public.Position | string | true | - | 指定PCIe设备的容器 |
| Oem.Public.Power | number | true | - | 指定PCIe设备的功耗 说明：已屏蔽该属性值频繁变化导致的事件上报 |
| Oem.Public.McuFirmwareVersion | string | true | - | 指定PCIe设备相关的MCU固件版本 |
| Oem.Public.VrdFirmwareVersion | string | true | - | 指定PCIe设备相关的VRD固件版本 |
| Oem.Public.PowerState | string | false | - | 指定PCIe设备的上下电状态On：上电Off：下电 说明：仅支持独立供电的板卡支持该属性openUBMC 25.12 LTS版本支持 |
| Oem.Public.ChipsECC[ ] | array | true | - | 指定PCIe设备的各芯片ECC个数，仅在MCU固件版本为1.0.9及以上支持 |
| Oem.Public.ChipTemperatureCelsius[ ] | array | true | - | 指定PCIe设备的各芯片温度，仅在MCU固件版本为1.0.9及以上支持 |
| Oem.Public.FunctionType | string | true | - | 指定PCIe设备的类型 |
| Oem.Public.PCIeCardType | string | true | - | 指定PCIe设备的种类 |
| Oem.Public.Memory [ { | array | true | - | 内存信息列表 |
| Oem.Public.Memory[].Manufacturer | string | true | - | 指定PCIe设备的生成厂商 |
| Oem.Public.Memory[].SerialNumber | string | true | - | 指定PCIe设备的序列号 |
| Oem.Public.Memory[].State | string | true | - | 指定PCIe设备的内存的在位状态 |
| Oem.Public.Memory[].DimmName | string | true | - | 指定PCIe设备的内存的丝印名称 |
| Oem.Public.Memory[].CapacityMB | number | true | - | 指定PCIe设备的内存的容量 |
| Oem.Public.Memory[].PartNum | string | true | - | 指定PCIe设备的内存的部件编码 |
| } ] | ||||
| Oem.Public.CPLDVersion | string | true | - | 指定PCIe设备的CPLD版本 |
| Oem.Public.M2Device1Presence | boolean | true | - | SDI卡的M.2卡槽位1在位情况 |
| Oem.Public.M2Device2Presence | boolean | true | - | SDI卡的M.2卡槽位2在位情况 |
| Oem.Public.SODIMM00Presence | boolean | true | - | SDI卡的SODIMM内存槽位1在位情况 |
| Oem.Public.SODIMM10Presence | boolean | true | - | SDI卡的SODIMM内存槽位2在位情况 |
| Oem.Public.StorageManagementIP | string | true | - | SDI卡的存储管理网口IP地址 |
| Oem.Public.StorageManagementVlanId | number | true | - | SDI卡的存储管理网口Vlan ID |
| Oem.Public.BootOption | string | false | - | SDI卡的系统启动方式 |
| Oem.Public.PxeOption | string | false | - | SDI卡的Pxe启动方式 |
| Oem.Public.BootEffective | string | false | - | SDI卡系统启动方式的有效期 说明 openUBMC 25.12 LTS及以上版本支持 |
| Oem.Public.SecureBoot | string | false | - | 安全启动开关 说明：仅DPU卡存在该属性 |
| Oem.Public.ExtendCardInfo [ { | array | true | - | 扩展卡信息 |
| Oem.Public.ExtendCardInfo[].BoardName | string | true | - | 扩展卡的单板名称 |
| Oem.Public.ExtendCardInfo[].DeviceId | string | true | - | 扩展卡的设备ID |
| Oem.Public.ExtendCardInfo[].VendorId | string | true | - | 扩展卡的厂商ID |
| Oem.Public.ExtendCardInfo[].SubsystemId | string | true | - | 扩展卡的子设备ID |
| Oem.Public.ExtendCardInfo[].SubsystemVendorId | string | true | - | 扩展卡的子厂商ID |
| Manufacturer | string | true | - | 扩展卡的生成厂商 |
| Oem.Public.ExtendCardInfo[].ChipManufacturer | string | true | - | 扩展卡的芯片厂商 |
| Description | string | true | - | 扩展卡的描述 |
| Model | string | true | - | 扩展卡的型号 |
| Oem.Public.ExtendCardInfo[].PfMacInfo[ ] | array | true | - | 扩展卡的Physical Function Mac信息 |
| Oem.Public.ExtendCardInfo[].PfMacInfo[].Port | number | true | - | 扩展卡的Physical Function Port信息 |
| Oem.Public.ExtendCardInfo[].PfMacInfo[].PfId | number | true | - | 扩展卡的Physical Function Id信息 |
| Oem.Public.ExtendCardInfo[].PfMacInfo[].PermanentMac | string | true | - | 扩展卡的永久物理地址信息 |
| Oem.Public.ExtendCardInfo[].RemainingWearRatePercent | number | true | - | SSD卡的剩余磨损率 |
| Oem.Public.ExtendCardInfo[].BomId | string | true | - | Accelerate卡的Bom ID |
| Oem.Public.ExtendCardInfo[].SSD1Presence | boolean | true | - | M.2转接卡的SSD槽位1在位情况 |
| Oem.Public.ExtendCardInfo[].SSD2Presence | boolean | true | - | M.2转接卡的SSD槽位2在位情况 |
| Oem.Public.ExtendCardInfo[].CSRVersion | string | true | - | 扩展卡的CSR文件版本 |
| Oem.Public.ExtendCardInfo[].BoardId | string | true | - | 指定网络适配器的单板ID |
| Oem.Public.ExtendCardInfo[].Description | string | true | - | 指定PCIe设备的描述 |
| Oem.Public.ExtendCardInfo[].Manufacturer | string | true | - | 指定PCIe设备的生成厂商 |
| Oem.Public.ExtendCardInfo[].Model | string | true | - | 指定PCIe设备的型号 |
| Oem.Public.ExtendCardInfo[].PCBVersion | string | true | - | 扩展板卡的PCB版本 |
| Oem.Public.ExtendCardInfo[].ProductName | string | true | - | 扩展板卡的产品名称 |
| Oem.Public.ExtendCardInfo[].Slot | number | true | - | 扩展卡的槽位 |
| } ] | ||||
| Oem.Public.MemoryCapacityMiB | number | true | - | 板卡NPU芯片的内存容量 说明：此处为向下取整后的总的可分配内存，单位为MB |
| Oem.Public.AttentionHotPlugState | string | true | - | 热插拔注意状态 |
| Oem.Public.ParentCardSlotId | string | true | - | 父卡槽位号 |
| Oem.Public.IndependentPowerControlEnabled | boolean | true | - | PCIe卡是否独立控制电源状态， true：独立控制 false：非独立控制 说明：仅自研DPU卡存在该属性 |
| } | ||||
| } | ||||
| ReadyToRemove | boolean | false | - | 系统是否准备好要移除PCIe设备 说明：仅PCIe设备插槽支持热插拔的网卡PCIe设备存在该属性openUBMC 25.12 LTS及以上版本支持 |
| Manufacturer | string | true | - | 指定PCIe设备的内存的厂商 |
| SerialNumber | string | true | - | 指定PCIe设备的内存的序列号 |
| Slot { | object | true | - | 扩展卡的槽位 |
| Slot.PCIeType | string | true | - | 设备使用的PCIe规范版本。 说明 openUBMC 25.12 LTS及以上版本支持 |
| Slot.HotPluggable | boolean | true | - | PCIe设备槽位是否支持热插拔 说明 openUBMC 25.12 LTS及以上版本支持 |
| Slot.SlotType | string | true | - | 指定PCIe设备的槽位类型 说明 openUBMC 25.12 LTS及以上版本支持 |
| } | ||||
| @odata.id | string | true | - | 各属性的访问路径 |
| Links { | object | true | - | 指定PCIe设备关联的资源 |
Links.Chassis[].@odata.id | string | true | - | 成员资源节点的访问路径 |
| Links.PCIeFunctions [ { | array | true | - | 指定PCIe功能的导航 |
Links.PCIeFunctions[].@odata.id | string | true | - | 成员资源节点的访问路径 |
| } ] | ||||
| Links.Chassis[ ] | array | true | - | 指定机箱的导航 |
| Links.Processors [ { | array | true | - | 指定PCIe设备的直接连接或直接桥接的处理器的链接 |
Links.Processors[].@odata.id | string | true | - | PCIe功能集合资源的访问路径 说明 openUBMC 25.12 LTS及以上版本支持 |
| } ] | ||||
| } | ||||
| PCIeFunctions { | object | true | - | 指定PCIe功能的导航 |
PCIeFunctions.@odata.id | string | true | - | PCIeFunctions资源的访问路径 |
| } | ||||
| PCIeInterface { | object | true | - | PCIe接口信息 |
| PCIeInterface.MaxLanes | number | true | - | 指定PCIe设备支持的PCIe通道数 |
| PCIeInterface.LanesInUse | number | true | - | 指定PCIe设备使用的PCIe通道数 |
| PCIeInterface.MaxPCIeType | string | true | - | 设备支持的最高版本的PCIe规范 说明 openUBMC 25.12 LTS及以上版本支持 |
| PCIeInterface.PCIeType | string | true | - | 指定PCIe设备的槽位支持的PCIe规范 说明 openUBMC 25.12 LTS及以上版本支持 |
| } | ||||
| CurrentSpeed | string | true | - | 指定PCIe设备的当前速率 说明 openUBMC 25.12 LTS及以上版本支持 |
| Lanes | number | true | - | PCIe设备所在插槽支持的PCIe通道数 说明 openUBMC 25.12 LTS及以上版本支持 |
| MaxSpeed | string | true | - | 指定PCIe设备的最高速率 说明 openUBMC 25.12 LTS及以上版本支持 |
| SKU | string | true | - | PCIe设备的库存单位编号 |
supported_methods
- GET
- PATCH
- POST
HTTP methods
GET
命令功能
查询指定 PCIe 设备资源信息
命令格式
URL: https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id
请求头:
text
X-Auth-Token: 123456789***********************请求消息体: 无
参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| device_ip | 登录设备的IP地址 | IPv4或IPv6地址 |
| chassis_id | 机箱资源的ID | ● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1” ● 针对刀片服务器，取值可以为BladeN（N 表示计算节点槽位号） ● 针对X6800 V5，X6000 V5，G5500，XA320 V2服务器，取值还可以为Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U位号)，例如"U1" ● 针对机柜资源，取值为Rack |
| pciedevices_id | PCIe设备资源的ID | 可通过查询指定资源获取 |
| auth_value | 执行该GET请求时，必须在“Headers”中携带“X-Auth-Token”值用于鉴权 | 可通过/redfish/v1/SessionService/Sessions创建会话时获得 |
使用指南
无
使用实例
请求样例：
http
GET <https://device_ip/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4>请求头：
text
X-Auth-Token: 123456789***********************请求消息体：无
响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4",
"@odata.type": "#PCIeDevice.v1_0_1.PCIeDevice",
"Id": "mainboardPCIeCard4",
"Name": "PCIeCard4",
"Description": "82599ES 10-Gigabit SFI/SFP+ Network Connection",
"Manufacturer": "Intel Corporation",
"Model": null,
"SerialNumber": null,
"UUID": null,
"FirmwareVersion": null,
"PartNumber": null,
"DeviceType": null,
"ReadyToRemove": false,
"Status": {
"State": "Enabled",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"Health": "OK"
},
"Oem": {
"Public": {
"AttentionHotPlugState": "Idle",
"ParentCardSlotId": "1",
"DeviceLocator": "PCIe Card4",
"Position": "mainboard",
"Power": 20.7,
"McuFirmwareVersion": null,
"VrdFirmwareVersion": null,
"PowerState": "On",
"MemoryCapacityMiB": 21534,
"ChipsECC": [
0,
0,
0
],
"ChipTemperatureCelsius": [
null,
null,
null,
null
],
"FunctionType": "Net Card",
"PCIeCardType": "NIC",
"Memory": [
{
"DimmName": "DIMM000",
"State": "Present",
"Manufacturer": "SK Hynix",
"CapacityMB": 8192,
"PartNum": "HWA82GR7AFRBN-UH",
"SerialNumber": "325532d8"
}
],
"ProductName": "NIC",
"BoardId": "0x005e",
"PCBVersion": ".A",
"CPLDVersion": "(U4)0.02",
"M2Device1Presence": true,
"M2Device2Presence": false,
"SODIMM00Presence": false,
"SODIMM10Presence": true,
"StorageManagementIP": "device_ip",
"StorageManagementVlanId": 92,
"BootOption": "HDD Boot",
"PxeOption": "UefiIpv4",
"BootEffective": "One-time",
"SecureBoot": "Disable",
"ExtendCardInfo": [
{
"ProductName": "SP570",
"BoardId": "0x007b",
"BoardName": "BC51ETHB",
"PCBVersion": ".A",
"DeviceId": "0x1822",
"VendorId": "0x19e5",
"SubsystemId": "0xd129",
"Slot": 5,
"SubsystemVendorId": "0x19e5",
"Manufacturer": "",
"ChipManufacturer": "",
"Description": "4*25GE",
"Model": "",
"CSRVersion": "1.01",
"PfMacInfo": [
{
"Port": 1,
"PfId": 0,
"PermanentMac": null
},
{
"Port": 2,
"PfId": 1,
"PermanentMac": null
},
{
"Port": 3,
"PfId": 2,
"PermanentMac": null
},
{
"Port": 4,
"PfId": 3,
"PermanentMac": null
}
],
"RemainingWearRatePercent": 30,
"BomId": "0x005f",
"SSD1Presence": true,
"SSD2Presence": false
}
]
}
},
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4/Functions/1"
}
],
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/1/Processors/2"
}
]
},
"PCIeInterface": {
"MaxLanes": 4,
"LanesInUse": 4,
"MaxPCIeType": "Gen5",
"PCIeType": "Gen4"
},
"Slot": {
"HotPluggable": true,
"PCIeType": "Gen4",
"SlotType": "FullLength"
},
"PCIeFunctions": {
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4/PCIeFunctions"
}
}响应码：200
PATCH
命令功能
修改指定 PCIe 设备资源信息
命令格式
URL: https://device_ip/redfish/v1/Chassis/chassis_id/PCIeDevices/pciedevices_id
请求头:
text
X-Auth-Token: 123456789***********************请求消息体:
json
{
"ReadyToRemove": ReadyToRemove_state,
"Oem": {
"Public": {
"MRCLogLevel": level,
"UEFILogLevel": level,
"PxeOption": pxe_option_value,
"BootOption": BootOption_value,
"BootEffective": BootEffective_value,
"SecureBoot": SecureBoot_value
}
}
}URL参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| chassis_id | 机箱资源的ID | ● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1” ● 针对刀片服务器，取值可以为BladeN（N 表示计算节点槽位号） ● 针对X6800 V5，X6000 V5，G5500，XA320 V2服务器，取值还可以为Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U位号)，例如"U1" ● 针对机柜资源，取值为Rack |
| pciedevices_id | PCIe设备资源的ID | 可通过查询指定资源获取 |
请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| ReadyToRemove | 系统移除PCIe设备准备状态 | ● true ● false 说明：仅PCIe设备插槽支持热插拔的网卡PCIe设备支持设置该属性 ● 当前ReadyToRemove值为false时，仅热插拔状态为可拔出并且在Bios Post阶段完成时，支持设置为true ● 当前ReadyToRemove值为true时，不支持设置为false， openUBMC 25.12 LTS及以上版本支持 |
| MRCLogLevel | BIOS日志等级 | ● 1：精简打印 ● 2：全打印 |
| UEFILogLevel | BIOS日志等级 | ● 1：精简打印 ● 2：全打印 |
| PxeOption | pxe启动项 | 可选值： ● UefiIpv4 ● UefiIpv6 ● UefiIpv4AndIpv6 |
| BootOption | 系统启动方式 | 可选值： ● HDD Boot ● Base Board PXE Boot ● None 该字段需要和 BootEffective字段同时传入。 |
| BootEffective | 系统启动方式的有效期 | 可选值： ● One-time ● Permanent 该字段需要和 BootOption字段同时传入。 |
| SecureBoot | 安全启动项 | 可选值： ● Enable ● Disable |
使用指南
无
使用实例
请求样例：
http
PATCH <https://device_ip/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4>请求头：
text
X-Auth-Token: 123456789***********************请求消息体：
json
{
"ReadyToRemove": true,
"Oem": {
"Public": {
"MRCLogLevel": 1,
"UEFILogLevel": 1,
"PxeOption": "UefiIpv4",
"SecureBoot": "Disable"
}
}
}响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#PCIeDevice.PCIeDevice",
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4",
"@odata.type": "#PCIeDevice.v1_0_1.PCIeDevice",
"Id": "mainboardPCIeCard4",
"Name": "PCIeCard4",
"Description": "82599ES 10-Gigabit SFI/SFP+ Network Connection",
"Manufacturer": "Intel Corporation",
"Model": null,
"SerialNumber": null,
"UUID": null,
"FirmwareVersion": null,
"PartNumber": null,
"ReadyToRemove": false,
"Status": {
"State": "Enabled",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"Health": "OK"
},
"Oem": {
"Public": {
"AttentionHotPlugState": "Idle",
"ParentCardSlotId": "1",
"DeviceLocator": "PCIe Card4",
"MRCLogLevel": 1,
"UEFILogLevel": 1,
"Position": "mainboard",
"Power": 20.7,
"McuFirmwareVersion": null,
"MemoryCapacityMiB": 21534,
"ChipsECC": [
0,
0,
0
],
"ChipTemperatureCelsius": [
null,
null,
null,
null
],
"FunctionType": "Net Card",
"Memory": [
{
"DimmName": "DIMM000",
"State": "Present",
"Manufacturer": "SK Hynix",
"CapacityMB": 8192,
"PartNum": "HWA82GR7AFRBN-UH",
"SerialNumber": "325532d8"
}
],
"ProductName": "NIC",
"BoardId": "0x005e",
"PCBVersion": ".A",
"CPLDVersion": "(U4)0.02",
"M2Device1Presence": true,
"M2Device2Presence": false,
"SODIMM00Presence": false,
"SODIMM10Presence": true,
"StorageManagementIP": "device_ip",
"StorageManagementVlanId": 92,
"BootOption": "HDD Boot",
"PxeOption": "UefiIpv4",
"BootEffective": "One-time",
"SecureBoot": "Disable",
"ExtendCardInfo": [
{
"ProductName": "SP570",
"BoardId": "0x007b",
"BoardName": "BC51ETHB",
"PCBVersion": ".A",
"DeviceId": "0x1822",
"VendorId": "0x19e5",
"SubsystemId": "0xd129",
"Slot": 5,
"SubsystemVendorId": "0x19e5",
"Manufacturer": "",
"ChipManufacturer": "",
"Description": "4*25GE",
"Model": "",
"CSRVersion": "1.01",
"PfMacInfo": [
{
"Port": 1,
"PfId": 0,
"PermanentMac": null
},
{
"Port": 2,
"PfId": 1,
"PermanentMac": null
},
{
"Port": 3,
"PfId": 2,
"PermanentMac": null
},
{
"Port": 4,
"PfId": 3,
"PermanentMac": null
}
],
"RemainingWearRatePercent": 30,
"BomId": "0x005f",
"SSD1Presence": true,
"SSD2Presence": false
}
]
}
},
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
],
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/PCIeCard4/Functions/1"
}
]
},
"PCIeInterface": {
"MaxLanes": 4,
"LanesInUse": 4
}
}响应码：200
POST (ACTION)
SDIReset
命令功能
复位指定 SDI 卡
命令格式
请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
json
{}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| chassis_id | 机箱资源的ID | ● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1” ● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号） ● 针对X6800 V5，X6000 V5，G5500，XA320 V2 服务器，取值还可以为 Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U 位号)，例如"U1" ● 针对机柜资源，取值为 Rack |
| pciedevices_id | PCIe设备资源的ID | 可通过查询指定资源获取 |
使用指南
无
使用实例
请求样例：
http
POST <https://device_ip/redfish/v1/Chassis/1/PCIeDevices/PCIeCard5/Actions/Oem/Public/PCIeDevices.Reset>请求头：
text
X-Auth-Token: 123456789***********************
Content-Type: application/json请求消息体：
json
{}响应样例：
json
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码：200
POST (ACTION)
SDIPowerState
命令功能
设置指定 SDI 卡电源状态
命令格式
请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
json
{
"PowerState": value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| chassis_id | 机箱资源的ID | ● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1” ● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号） ● 针对X6800 V5，X6000 V5，G5500，XA320 V2 服务器，取值还可以为 Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U 位号)，例如"U1" ● 针对机柜资源，取值为 Rack |
| pciedevices_id | PCIe设备资源的ID | 可通过查询指定资源获取 |
| PowerState | 电源状态 | 支持的取值包括： ● 0：下电 ● 1：上电 |
使用指南
无
使用实例
请求样例：
http
POST <https://device_ip/redfish/v1/Chassis/1/PCIeDevices/PCIeCard5/Actions/Oem/Public/PCIeDevices.SetPowerState>请求头：
text
X-Auth-Token: 123456789***********************
Content-Type: application/json请求消息体：
json
{
"PowerState": 1
}响应样例：
json
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码：200
POST (ACTION)
ImportCertificate
命令功能
指定 PCIe 设备资源导入 https 证书
命令格式
请求头:
text
X-Auth-Token: 123456789***********************
Content-Type: header_type请求消息体:
json
{
"Type": type_value,
"Content": content_value
}请求头参数说明
参见 请求头参数说明
请求体参数说明
| 参数 | 参数说明 | 取值 |
|---|---|---|
| account_id | 用户的ID | 2~17 |
| type_value | https证书导入的方法 | URI text |
| content_value | https证书导入的路径 | 导入格式：1、文本形式导入：填写 https证书内容 2、本地导入：“/tmp/目录/文件名”远程导入：“文件传输协议：//用户名：密码@ip地址/目录/文件名”（文件传输协议包括五种：sftp、https、nfs、cifs、scp）仅支持.crt格式文件。 |
使用指南
无
使用实例
请求头：
text
X-Auth-Token: 123456789***********************
Content-Type: application/json请求消息体： 文本形式：
json
{
"Type": "text",
"Content": ""
}文本形式的响应样例：
json
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "iBMC.1.0.ImportHttpsCerttOK",
"RelatedProperties": [
"#/PCIeDevices.ImportHttpsCert"
],
"Message": "Successfully imported the https cert.",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码：200 文件形式： 远程文件
json
{
"Type": "URI",
"Content": "sftp://username:password@device_ip/usr/ca.crt"
}本地文件
json
{
"Type":"URI",
"Content": "/tmp/ca.crt"
}远程文件形式的响应样例：
json
{
"@odata.context": "/redfish/v1/$metadata#TaskService/Tasks/Members/$entity",
"@odata.type": "#Task.v1_0_2.Task",
"@odata.id": "/redfish/v1/TaskService/Tasks/2",
"Id": "2",
"Name": "Import File Task",
"Description": "",
"TaskState": "Running",
"TaskStatus": "OK",
"StartTime": "2017-05-17T18:35:01+00:00",
"Messages": [],
"PercentComplete": null,
"Oem": {
"Public": {
"TaskPercentage": null
}
}
}响应码：202 本地文件形式的响应样例：
json
{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "iBMC.1.0.ImportHttpsCertOK",
"RelatedProperties": [
"#/PCIeDevices.ImportHttpsCert"
],
"Message": "Successfully imported the https cert.",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}响应码：200