NetworkPorts
更新时间: 2026/06/26
在Gitcode上查看源码

ResourceDefinition

uris

  • /redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/NetworkPorts/networkports_id

properties

名称类型是否只读取值范围/枚举值说明
@odata.contextstringtrue-网络端口资源模型的OData描述信息
@odata.idstringtrue-网络端口资源的访问路径
@odata.typestringtrue-网络端口资源的类型
Idstringtrue-网络端口资源ID
Namestringtrue-网络端口资源名称
Statusobjecttrue-指定网络端口的状态,包括:
● State:网络端口使能状态
PhysicalPortNumberstringtrue-指定网络端口的物理丝印
LinkStatusstringtrue-指定网络端口的物理连接状态包括:
● LinkUp
● NoLink
● LinkDown
● Connected
● Disconnected
● N/A
AssociatedNetworkAddressesarraytrue-指定网络端口的网络地址, 其中FC卡分为WWPN和WWNN,顺序为第一个为WWPN,第二个为WWNN
ActiveLinkTechnologystringtrue-指定网络端口的网络协议
● Ethernet
● FibreChannel
● InifiBand
PortTypestringtrue-指定网络端口的网口类型, 包括:
● OpticalPort
● ElectricalPort
PortMaxSpeedstringtrue-指定网络端口的最大速率
PortNamestringtrue-指定网络端口的名称
InterfaceTypestringtrue-指定网络端口的接口类型
BDFstringtrue-指定网络端口的BDF
LldpServiceobjectfalse-指定网络端口的网卡的Lldp服务 说明 仅在部分PCIe网卡下返回网卡lldp使能状态和工作模式。其他网卡则返回null。
FirmwarePackageVersionstringtrue-指定网络端口的固件版本 说明 和网络适配器下的固件版本属性含义相同,但网卡有多芯片的情况下,同一张卡下的不同端口可能有不同固件版本,建议使用端口的固件版本。
DriverVersionstringtrue-指定网络端口的驱动版本 说明 和网络适配器下的驱动版本属性含义相同,但网卡有多芯片的情况下,同一张卡下的不同端口可能有不同驱动版本,建议使用端口的驱动版本。
DriverNamestringtrue-指定网络端口的驱动名称 说明 和网络适配器下的驱动名称属性含义相同,但网卡有多芯片的情况下,同一张卡下的不同端口可能有不同驱动名称,建议使用端口的驱动名称。
OpticalModuleobjecttrue-指向该网口上接的光模块资源 说明 如果网口不是OpticalPort或者没有接光模块,不显示该属性
PortTechnologystringtrue-指定网络端口的网络协议
● Ethernet
● FibreChannel
● iSCSI
● FCoE
● OPA
● IB
FCIdstringtrue-FC卡的ID
PortStatestringtrue-FC卡的端口状态
● Online
● LinkDown
● Offline
● User Offline
● Bypassed
● In diagnosticsmode
● Port Error
● Loopback
● Degraded
LinkSpeedGbpsnumbertrue-指定网络端口的速率 说明 此属性仅支持FC卡。
RelatedPortobjecttrue-指定网络端口关联的以太网口资源链接
StatisticInfoobjecttrue-指定HBA卡网络端口的统计信息 说明 如果板卡不是HBA卡,不显示该属性
TXRateGbpsnumbertrue-HBA卡端口的发送速率 说明 已屏蔽该属性值频繁变化导致的事件上报
RXRateGbpsnumbertrue-HBA卡端口的接收速率 说明 已屏蔽该属性值频繁变化导致的事件上报
RateNegotiationStagestringtrue-HBA卡端口的速率协商阶段,包括:
● Negotiating
● WaitSignal
● NegotiationCompleted
OpticalModuleEnabledbooleantrue-HBA卡端口上连接的光模块的开启状态
WorkingRatenumbertrue-HBA卡端口的工作速率。 说明 已屏蔽该属性值频繁变化导致的事件上报
WorkModestringtrue-HBA卡端口的工作模式,包括:
● Loop
● NonLoop
LocalDeviceCreditnumbertrue-HBA卡端口的本段设备信用值
PeerDeviceCreditnumbertrue-HBA卡端口的对端设备信用值
PortStatusstringtrue-HBA卡端口的端口连接状态,包括:
● LinkUp
● Disabled
● WaitSignal

supported_methods

  • GET
  • PATCH

HTTP methods

GET

命令功能

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

命令格式

URL: https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/NetworkPorts/networkports_id

请求头:


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

请求头:


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

请求消息体:无

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",
  "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/NetworkPorts/1",
  "@odata.type": "#NetworkPort.v1_0_0.NetworkPort",
  "Name": "1",
  "Id": "1",
  "Status": {
    "State": "Disabled"
  },
  "PhysicalPortNumber": "1",
  "LinkStatus": "Down",
  "AssociatedNetworkAddresses": [
    "74:9D:8F:27:2E:61"
  ],
  "ActiveLinkTechnology": "Ethernet",
  "Oem": {
    "Public": {
      "PortType": "OpticalPort",
      "PortName": "host8",
      "PortMaxSpeed": "10GE",
      "InterfaceType": "NPort",
      "BDF": "0000:a3:00.0",
      "LldpService": null,
      "FirmwarePackageVersion": "5719-v1.31,DASH",
      "DriverVersion": "3.137",
      "DriverName": "tg3",
      "OpticalModule": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/NetworkPorts/1/OpticalModule"
      },
      "PortTechnology": "Ethernet",
      "FCId": null,
      "PortState": "Offline",
      "LinkSpeedGbps": null,
      "RelatedPort": {
        "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/mainboardPCIeCard4Port1"
      },
      "StatisticInfo": {
        "TXRateGbps": 0,
        "RXRateGbps": 0,
        "RateNegotiationStage": "Negotiating",
        "OpticalModuleEnabled": true,
        "WorkingRate": null,
        "WorkMode": "Loop",
        "PeerDeviceCredit": 0,
        "LocalDeviceCredit": 0,
        "PortStatus": "WaitSignal"
      }
    }
  }
}

响应码:200

PATCH

命令功能

修改网络端口单个资源信息

命令格式

URL: https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/NetworkPorts/networkports_id

请求头:


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

请求消息体:

json
{
  "Oem": {
    "Public": {
      "LldpService": {
        "LldpEnabled": enabled
      }
    }
  }
}

请求头参数说明

参见 请求头参数说明

请求体参数说明

参数参数说明取值
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
networkadapters_id网络适配器资源的ID属性DeviceLocator和属性 Position合并而成
networkports_id网络端口资源的ID属性PhysicalPortNumber 值,一般从一开始
enabled网卡LLDP使能开关true为打开,false为关闭

使用指南

使用实例

请求样例:

http
PATCH https://device_ip/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/NetworkPorts/1

请求头:


X-Auth-Token: 123456789***********************
Content-Type: application/json
If-Match: W/"bc428df5"

请求消息体:

json
{
  "Oem": {
    "Public": {
      "LldpService": {
        "LldpEnabled": true
      }
    }
  }
}

响应样例:

json
{
  "@odata.context": "/redfish/v1/$metadata#Chassis/Members/1/NetworkAdapters/Members/PCIeRiser1PCIeCard3(SP380)/NetworkPorts/Members/$entity",
  "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/PCIeRiser1PCIeCard3(SP380)/NetworkPorts/1",
  "@odata.type": "#NetworkPort.v1_0_0.NetworkPort",
  "Name": "1",
  "Id": "1",
  "Status": {
    "State": "Enabled"
  },
  "PhysicalPortNumber": "1",
  "LinkStatus": "Down",
  "AssociatedNetworkAddresses": [
    "08:26:AE:58:61:2A"
  ],
  "ActiveLinkTechnology": "Ethernet",
  "Oem": {
    "Public": {
      "PortType": "OpticalPort",
      "PortMaxSpeed": "25GE",
      "PortName": null,
      "InterfaceType": null,
      "BDF": "0000:03:00.0",
      "LldpService": {
        "LldpEnabled": true,
        "WorkMode": "Tx"
      },
      "FirmwarePackageVersion": "14.31.1014",
      "DriverVersion": null,
      "DriverName": null,
      "PortTechnology": "Ethernet",
      "FCId": null,
      "LinkSpeedGbps": null,
      "RelatedPort": {
        "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/PCIeRiser1PCIeCard3(SP380)Port1"
      },
      "StatisticInfo": null
    }
  }
}

响应码:200