ResourceDefinition

uris

/redfish/v1/Chassis/chassis_id/Transceivers/transceivers_id

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	光模块资源模型的OData描述信息
@odata.id	string	true	-	光模块资源的访问路径
@odata.type	string	true	-	光模块资源的类型
Id	string	true	-	光模块资源ID
Name	string	true	-	光模块资源名称
Status {	object	true	-	光模块的状态，包括： ● State：光模块使能状态 ● Health：光模块健康状态 ● Severity：光模块的自定义健康状态
Status.Health	string	true	-	光模块服务健康状态
Status.Oem {	object	true	-	自定义属性
Status.Oem.Public {	object	true	-	自定义属性
Status.Oem.Public.Severity	string	false	-	光模块的自定义健康状态
}
}
Status.State	string	true	-	光模块的内存的在位状态
}
Location {	object	true	-	光模块丝印说明 openUBMC 26.03及以上版本支持。
Location.PartLocation {	object	true	-	资源在封闭装置内的部件位置说明 openUBMC 26.03及以上版本支持。
Location.PartLocation.ServiceLabel	string	true	-	部件位置的标签说明 openUBMC 26.03及以上版本支持。
Location.PartLocation.LocationType	string	true	-	部件位置的类型说明 openUBMC 26.03及以上版本支持。
Location.PartLocation.LocationOrdinalValue	number	true	-	部件位置的序号说明 openUBMC 26.03及以上版本支持。
}
Location.PartLocationContext	string	true	-	部件位置上下文，用于区分同一外壳内不同零件的PartLocation值，其中可能包含该零件所包含的PartLocation值的层级信息说明 openUBMC 26.03及以上版本支持。
}
RXFCSErrors	number	true	-	接收到的Frame Check Sequence错误数量
Manufacturer	string	true	-	光模块的厂商名称
PartNumber	string	true	-	光模块的部件号
BomId	string	true	默认为null	光模块的BOM编码
RXPower [ {	array	true	-	接收光功率信息列表
RXPower[].LowerThresholdCritical	number	true	-	紧急告警下门限值
RXPower[].ReadingMilliWatts	number	true	-	接收光功率读数（毫瓦）
RXPower[].UpperThresholdCritical	number	true	-	紧急告警上门限值
} ]
SerialNumber	string	true	-	光模块的序列号
ProductionDate	string	true	-	光模块的生产日期
TransceiverType[ ]	array	true	-	光模块的收发器类型
PackagingType	string	true	-	光模块的封装类型，包括： ● GBIC：千兆接口转换器封装 ● modulesolderedto motherboard：母板焊接式模块 ● SFP：小型可插拔封装 ● 300 pin XBI：300针 XBI 封装 ● XENPAK：XENPAK封装 ● XFP：10千兆小型可插拔封装 ● XFF：XFF封装 ● XFP-E：增强型XFP封装 ● XPAK：XPAK封装 ● X2：X2封装 ● DWDM-SFP：密集波分复用 SFP封装 ● QSFP：四通道四倍速率可插拔封装 ● QSFP+：QSFP+封装 ● CXP：CXP封装 ● Shielded Mini Multilane HD 4X：屏蔽型高密度Mini Multilane 4X连接器 ● Shielded Mini Multilane HD 8X：屏蔽型高密度Mini Multilane 8X连接器 ● QSFP28：QSFP28封装 ● CXP2/CXP28：CXP2/CXP28封装 ● CDFP Style 1/Style 2：CDFP样式1/样式2封装 ● Shielded Mini Multilane HD 4X Fanout Cable：屏蔽型高密度Mini Multilane 4X分支线缆/一分四线缆 ● Shielded Mini Multilane HD 8X Fanout Cable：屏蔽型高密度Mini Multilane 8X分支线缆/一分八线缆 ● CDFP Style 3：CDFP样式3封装 ● microQSFP：微型QSFP封装
MediumMode	string	true	-	光模块的介质类型，包括： ● Monomode：单模 ● Multimode：多模
TXPower [ {	array	true	-	发送光功率信息列表
TXPower[].LowerThresholdCritical	number	true	-	紧急告警下门限值
TXPower[].ReadingMilliWatts	number	true	-	发送光功率读数（毫瓦）
TXPower[].UpperThresholdCritical	number	true	-	紧急告警上门限值
} ]
WaveLengthNanometer	number	true	-	光模块的波长
SupportedDiagnosticService[ ]	array	true	-	支持的诊断服务列表
SupportedSpeedsMbps[ ]	array	true	-	光模块支持的速率
Voltage {	object	true	-	电压信息
Voltage.LowerThresholdCritical	number	true	-	紧急告警下门限值
Voltage.UpperThresholdCritical	number	true	-	紧急告警上门限值
Voltage.ReadingVolts	number	true	-	光模块电压的当前读数说明：已屏蔽该属性值频繁变化导致的事件上报
}
Identifier	string	true	-	光模块的识别码，包括 ● UNDEF：未定义模块 ● GBIC：GBIC协议模块 ● SFP_SFP_PLUS_SFP28：千兆/万兆/25G SFP模块 ● QSFP：四通道可插拔光模块 ● QSFP_PLUS：40G QSFP+模块 ● QSFP28：100G QSFP28模块
DeviceType	string	true	-	光模块的设备类型，包括 ● Optical：光口 ● Electric：电口 ● Copper：铜缆 ● Aoc：有源光缆 ● Interface（背板类型） ● Baset（电卡口） ● Unknown：未知
ConnectorType	string	true	-	光模块的连接器类型，包括 ● UNDEF（未定义） ● LC ● MPO ● OPTICAL_PIGTAIL（有源光缆） ● COPPER_PIGTAIL（铜缆） ● NO_SEPARABLE_CONNE CTOR（未分配）
RxLosState	boolean	true	-	光模块Rx端是否收不到信号
TxFaultState	boolean	true	-	光模块Tx端是否有故障
TransferDistance	number	true	-	传输距离
Temperature {	object	true	-	光模块资源的温度（仅CPU资源具有）说明已屏蔽该属性值频繁变化导致的事件上报
Temperature.LowerThresholdCritical	number	true	-	紧急告警下门限值
Temperature.UpperThresholdCritical	number	true	-	紧急告警上门限值
Temperature.ReadingCelsius	number	true	-	光模块温度的当前读数说明：已屏蔽该属性值频繁变化导致的事件上报
}
TXBiasCurrent [ {	array	true	-	发送偏置电流列表
TXBiasCurrent[].LowerThresholdCritical	number	true	-	紧急告警下门限值
TXBiasCurrent[].UpperThresholdCritical	number	true	-	紧急告警上门限值
TXBiasCurrent[].ReadingMilliAmperes	number	true	-	光模块偏置电流的当前读数说明：已屏蔽该属性值频繁变化导致的事件上报
} ]
@odata.id	string	true	-	光模块通道映射关系资源节点的访问路径说明仅openUBMC 25.12 LTS及以上版本支持
ContaminationDetection	string	true	-	光模块支持光链路脏污检测
FirmwareVersion	string	true	-	指定扩展板卡的固件版本说明：目前只有TaiShan200 IOB卡支持
PRBSTest	string	true	-	光模块支持PRBSTest
LaneMappings	object	true	-	光模块通道的映射关系

supported_methods

GET
POST

HTTP methods

GET

命令功能

查询网络端口上接的光模块资源信息

命令格式

URL: https://device_ip/redfish/v1/Chassis/chassis_id/Transceivers/transceivers_id

请求头:

text


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

请求消息体: 无

参数说明

参数	参数说明	取值
device_ip	登录设备的IP地址	IPv4或IPv6地址
chassis_id	机箱资源的ID	● 针对机架服务器，取值为1 ● 针对高密服务器，取值为 BladeN（N表示节点槽位号），例如“Blade1” ● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或SwiN（N 表示交换模块槽位号），例如“Swi1” ● 针对X6800 V5，X6000 V5，G5500，XA320 V2服务器，取值还可以为Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U位号)，例如"U1" ● 针对机柜资源，取值为 Rack
auth_value	执行该GET请求时，必须在“Headers”中携带“X-Auth-Token”值用于鉴权	可通过/redfish/v1/SessionService/Sessions创建会话时获得
networkadapters_id	网络适配器资源的ID	属性DeviceLocator和属性 Position合并而成
networkports_id	网络端口资源的ID	属性PhysicalPortNumber 值，一般从一开始

使用指南

无

使用实例

请求样例：

http

GET <https://device_ip/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/NetworkPorts/1/OpticalModule>

请求头：

text


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

请求消息体：无

响应样例：

json

{
"@odata.context": "/redfish/v1/$metadata#hwOpticalModule.hwOpticalModule",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard5/NetworkPorts/1/OpticalModule",
"@odata.type": "#hwOpticalModul.v1_0_0.hwOpticalModule",
"Name": "OpticalModule",
"Id": "OpticalModule",
"Status": {
"Health": "Warning",
"Oem": {
"Public": {
"Severity": "Informational"
}
},
"State": "Enabled"
},
"Location": {
"PartLocation": {
"ServiceLabel": "PIC-8 ETH1",
"LocationType": "Connector",
"LocationOrdinalValue": 1
},
"PartLocationContext": "NPU BOX 2"
},
"RXFCSErrors": 123,
"Manufacturer": "",
"PartNumber": "LTF8502-BC+",
"BomId": "34xxxxxx",
"SerialNumber": "N3367109619",
"ProductionDate": "2016-07-26",
"TransceiverType": [
"10G Base-SR"
],
"PackagingType": "SFP/SFP+",
"MediumMode": "Multimode",
"WaveLengthNanometer": 850,
"SupportedSpeedsMbps": [
10000
],
"Voltage": {
"ReadingVolts": 2,
"LowerThresholdCritical": 2.97,
"UpperThresholdCritical": 3.63
},
"RXPower": [
{
"ReadingMilliWatts": 0,
"LowerThresholdCritical": 0.06,
"UpperThresholdCritical": 1.26
}
],
"TXPower": [
{
"ReadingMilliWatts": 0.57,
"LowerThresholdCritical": 0.12,
"UpperThresholdCritical": 1.26
}
],
"Identifier": "SFP_SFP_PLUS_SFP28",
"DeviceType": "Optical",
"ConnectorType": "LC",
"RxLosState": true,
"TxFaultState": false,
"TransferDistance": 40,
"Temperature": {
"ReadingCelsius": 45,
"LowerThresholdCritical": null,
"UpperThresholdCritical": null
},
"TXBiasCurrent": [
{
"ReadingMilliAmperes": 7504,
"LowerThresholdCritical": null,
"UpperThresholdCritical": null
}
],
"SupportedDiagnosticService": [
"PRBSTest",
"ContaminationDetection"
]
}

响应码：200

POST (ACTION)

ControlActiveIndicatorLED

命令功能

控制光模块 Active 指示灯状态

命令格式

URL: https://device_ip/redfish/v1/Chassis/Chassis_id/Transceivers/transceivers_id/Actions/Transceiver.ControlIndicatorLED

请求头:

text


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

请求消息体:

json

{
"IndicatorLED": controltype
}

请求头参数说明

参见请求头参数说明

请求体参数说明

参数	参数说明	取值
Chassis_id	系统资源的ID	● 针对机架服务器，取值为1 ● 针对高密服务器，取值为BladeN（N表示节点槽位号），例如“Blade1” ● 针对刀片服务器，取值可以为BladeN（N表示计算节点槽位号）或 SwiN（N表示交换模块槽位号），例如“Swi1” ● 针对X6800 V5，X6000 V5，G5500，XA320 V2 服务器，取值还可以为 Enc，表示计算节点所在的机框资源 ● 针对设备U位信息，取值可以为UN(N表示设备U 位号)，例如"U1" ● 针对机柜资源，取值为 Rack
transceivers_id	光模块资源的ID	可通过查询光模块集合资源信息获取
controltype	控制类型	● ForceOff：强制灭灯 ● Resume：恢复原状态

使用指南

无

使用实例

请求样例：

http

POST <https://device_ip/redfish/v1/Chassis/1/Transceivers/OpticalModule_EthernetAdapterBoardPort1/Actions/Transceiver.ControlIndicatorLED>

请求头：

text


X-Auth-Token: 123456789***********************
Content-Type: application/json

请求消息体： ● 设置强制灭灯：

json

{
"IndicatorLED": "ForceOff"
}

● 设置恢复原状态：

json

{
"IndicatorLED":"Resume"
}

响应样例：

json

{
"error": {
"code": "Base.1.0.GeneralError",
"message": "A general error has occurred. See ExtendedInfo for more information.",
"@Message.ExtendedInfo": [
{
"@odata.type": "#Message.v1_0_0.Message",
"MessageId": "Base.1.0.Success",
"RelatedProperties": [],
"Message": "Successfully Completed Request",
"MessageArgs": [],
"Severity": "OK",
"Resolution": "None"
}
]
}
}

响应码：200

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

POST (ACTION) ​

ControlActiveIndicatorLED ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

POST (ACTION)

ControlActiveIndicatorLED