ResourceDefinition

uris

/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/Ports/ports_id

properties

名称	类型	是否只读	取值范围/枚举值	说明
@odata.context	string	true	-	网络端口资源模型的OData描述信息
@odata.id	string	true	-	网络端口资源的访问路径
@odata.type	string	true	-	网络端口资源的类型
Id	string	true	-	网络端口资源ID
Name	string	true	-	网络端口资源名称
LinkStatus	string	true	-	指定网络端口的物理连接状态包括： ● LinkUp ● NoLink ● LinkDown ● Connected ● Disconnected ● N/A
LinkNetworkTechnology	string	true	-	指定网络端口的网络协议 ● Ethernet ● FibreChannel ● InifiBand
CurrentSpeedGbps	number	true	-	当前速率（Gbit/s）
PortMedium	string	true	-	网口介质
SFP	object	true	-	光模块信息
PartNumber	string	true	-	部件编码
SerialNumber	string	true	-	序列号
Manufacturer	string	true	-	制造商
Type	string	true	-	类型
MediumType	string	true	-	介质类型
DateCode	string	true	-	日期编码
Status	object	true	-	状态
Ethernet	object	true	-	以太网
Ethernet.AssociatedMACAddresses	array	true	-	指定网络端口的网络地址，其中FC卡分为WWPN和WWNN，顺序为第一个为WWPN，第二个为WWNN
Ethernet.LLDPEnabled	boolean	true	-	LLDP使能
Ethernet.LLDPReceive	object	true	-	LLDP接收
LinkConfiguration	array	true	-	链接配置
LinkState	string	true	-	链路状态
PortId	string	true	-	网口ID
PortProtocol	string	true	-	网口协议
Metrics	object	true	-	指向端口指标资源的链接
Links.Oem.Public	object	true	-	厂商自定义信息
Links.Oem.Public.Processors	array	true	处理器
Links.Oem.Public.PortType	string	true	-	指定网络端口的网口类型，包括： ● OpticalPort ● ElectricalPort
Links.Oem.Public.PortMaxSpeed	string	true	-	指定网络端口的最大速率
Links.Oem.Public.PortName	string	true	-	指定网络端口的名称
Links.Oem.Public.InterfaceType	string	true	-	指定网络端口的接口类型
Links.Oem.Public.BDF	string	true	-	指定网络端口的BDF
Links.Oem.Public.LldpService	object	true	-	指定网络端口的网卡的Lldp服务说明仅在部分PCIe网卡下返回网卡lldp使能状态和工作模式。其他网卡则返回null。
Links.Oem.Public.FirmwarePackageVersion	string	true	-	指定网络端口的固件版本说明和网络适配器下的固件版本属性含义相同，但网卡有多芯片的情况下，同一张卡下的不同端口可能有不同固件版本，建议使用端口的固件版本。
Links.Oem.Public.DriverVersion	string	true	-	指定网络端口的驱动版本说明和网络适配器下的驱动版本属性含义相同，但网卡有多芯片的情况下，同一张卡下的不同端口可能有不同驱动版本，建议使用端口的驱动版本。
Links.Oem.Public.DriverName	string	true	-	指定网络端口的驱动名称说明和网络适配器下的驱动名称属性含义相同，但网卡有多芯片的情况下，同一张卡下的不同端口可能有不同驱动名称，建议使用端口的驱动名称。
Links.Oem.Public.OpticalModule	object	true	-	指向该网口上接的光模块资源说明如果网口不是OpticalPort或者没有接光模块，不显示该属性
Links.Oem.Public.PortTechnology	string	true	-	指定网络端口的网络协议 ● Ethernet ● FibreChannel ● iSCSI ● FCoE ● OPA ● IB
Links.Oem.Public.FCId	string	true	-	FC卡的ID
Links.Oem.Public.PortState	string	true	-	FC卡的端口状态 ● Online ● LinkDown ● Offline ● User Offline ● Bypassed ● In diagnosticsmode ● Port Error ● Loopback ● Degraded
Links.Oem.Public.LinkSpeedGbps	number	true	-	指定网络端口的速率说明此属性仅支持FC卡。
Links.Oem.Public.RelatedPort	object	true	-	指定网络端口关联的以太网口资源链接
Links.Oem.Public.StatisticInfo	object	true	-	指定HBA卡网络端口的统计信息说明如果板卡不是HBA卡，不显示该属性
Links.Oem.Public.StatisticInfo.TXRateGbps	number	true	-	HBA卡端口的发送速率说明已屏蔽该属性值频繁变化导致的事件上报
Links.Oem.Public.StatisticInfo.RXRateGbps	number	true	-	HBA卡端口的接收速率说明已屏蔽该属性值频繁变化导致的事件上报
Links.Oem.Public.StatisticInfo.RateNegotiationStage	string	true	-	HBA卡端口的速率协商阶段，包括： ● Negotiating ● WaitSignal ● NegotiationCompleted
Links.Oem.Public.StatisticInfo.OpticalModuleEnabled	boolean	true	-	HBA卡端口上连接的光模块的开启状态
Links.Oem.Public.StatisticInfo.WorkingRate	number	true	-	HBA卡端口的工作速率。说明已屏蔽该属性值频繁变化导致的事件上报
Links.Oem.Public.StatisticInfo.WorkMode	string	true	-	HBA卡端口的工作模式，包括： ● Loop ● NonLoop
Links.Oem.Public.StatisticInfo.LocalDeviceCredit	number	true	-	HBA卡端口的本段设备信用值
Links.Oem.Public.StatisticInfo.PeerDeviceCredit	number	true	-	HBA卡端口的对端设备信用值
Links.Oem.Public.StatisticInfo.PortStatus	string	true	-	HBA卡端口的端口连接状态，包括： ● LinkUp ● Disabled ● WaitSignal

supported_methods

GET
PATCH

HTTP methods

GET

命令功能

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

命令格式

URL: https://device_ip/redfish/v1/Chassis/chassis_id/NetworkAdapters/networkadapters_id/Ports/ports_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合并而成
ports_id	网络端口资源的ID	属性PhysicalPortNumber 值，一般从一开始

使用指南

无

使用实例

请求样例：

http

GET https://device_ip/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/Ports/1

请求头：


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

请求消息体：无

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Port.Port",
  "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/Ports/1",
  "@odata.type": "#Port.v1_17_0.Port",
  "Name": "1",
  "Id": "1",
  "LinkStatus": "LinkUp",
  "LinkNetworkTechnology": "Ethernet",
  "CurrentSpeedGbps": 100,
  "PortMedium": "Optical",
  "SFP": {
    "PartNumber": "LTAXXX",
    "SerialNumber": "UPABCXXX",
    "Manufacturer": "Hisense",
    "Type": "QSFP28",
    "MediumType": "Optical",
    "DateCode": "2021-XX-XX"
  },
  "Status": {
    "Health": "OK",
    "State": "Enabled"
  },
  "Ethernet": {
    "AssociatedMACAddresses": [
        "74:9D:8F:27:2E:61"
    ],
    "LLDPEnabled": false,
    "LLDPReceive": {
        "ChassisId": null,
        "ChassisIdSubtype": null,
        "ManagementVlanId": 0,
        "PortId": null,
        "PortIdSubtype": null,
        "SystemName": null
    }
  },
  "LinkConfiguration": [
    {
        "AutoSpeedNegotiationCapable": null,
        "AutoSpeedNegotiationEnabled": false,
        "LinkNetworkTechnology": "Ethernet"
    }
  ],
  "PortId": "1",
  "PortProtocol": "Ethernet",
  "Metrics": {
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/Ports/1/Metrics"
  },
  "Links":{
    "Oem": {
        "Public": {
            "Processors": null,
            "PortType": "OpticalPort",
            "PortMaxSpeed": "10GE",
            "PortName": "host8",
            "InterfaceType": "NPort",
            "BDF": "0000:a3:00.0",
            "LldpService": {
                "WorkMode": "Tx"
            },
            "FirmwarePackageVersion": "5719-v1.31,DASH",
            "DriverVersion": "3.137",
            "DriverName": "tg3",
            "OpticalModule": {
                "@odata.id": "/redfish/v1/Chassis/1/Transceivers/OpticalModule_mainboardPCIeCard4Port1"
            },
            "PortTechnology": "Ethernet",
            "FCId": null,
            "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/Ports/ports_id

请求头:


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

请求消息体:

json

{
    "Ethernet": {
        "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合并而成
ports_id	网络端口资源的ID	属性PhysicalPortNumber 值，一般从一开始
enabled	网卡LLDP使能开关	true为打开，false为关闭

使用指南

无

使用实例

请求样例：

http

PATCH https://device_ip/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/Ports/1

请求头：


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

请求消息体：

json

{
    "Ethernet": {
        "LLDPEnabled": true
    }
}

响应样例：

json

{
  "@odata.context": "/redfish/v1/$metadata#Port.Port",
  "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/Ports/1",
  "@odata.type": "#Port.v1_17_0.Port",
  "Name": "1",
  "Id": "1",
  "LinkStatus": "LinkUp",
  "LinkNetworkTechnology": "Ethernet",
  "CurrentSpeedGbps": 100,
  "PortMedium": "Optical",
  "SFP": {
    "PartNumber": "LTAXXX",
    "SerialNumber": "UPABCXXX",
    "Manufecturer": "Hisense",
    "Type": "QSFP28",
    "MediumType": "Optical",
    "DateCode": "2021-XX-XX"
  },
  "Status": {
    "Health": "OK",
    "State": "Enabled"
  },
  "Ethernet": {
    "AssociatedMACAddresses": [
        "74:9D:8F:27:2E:61"
    ],
    "LLDPEnabled": true,
    "LLDPReceive": {
        "ChassisId": null,
        "ChassisIdSubtype": null,
        "ManagementVlanId": 0,
        "PortId": null,
        "PortIdSubtype": null,
        "SystemName": null
    }
  },
  "LinkConfiguration": [
    {
        "AutoSpeedNegotiationCapable": null,
        "AutoSpeedNegotiationEnabled": false,
        "LinkNetworkTechnology": "Ethernet"
    }
  ],
  "PortId": "1",
  "PortProtocol": "Ethernet",
  "Metrics": {
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/mainboardPCIeCard4/Ports/1/Metrics"
  },
  "Links":{
    "Oem": {
        "Public": {
            "Processors": null,
            "PortType": "OpticalPort",
            "PortMaxSpeed": "10GE",
            "PortName": "host8",
            "InterfaceType": "NPort",
            "BDF": "0000:a3:00.0",
            "LldpService": {
                "WorkMode": "Tx"
            },
            "FirmwarePackageVersion": "5719-v1.31,DASH",
            "DriverVersion": "3.137",
            "DriverName": "tg3",
            "OpticalModule": {
                "@odata.id": "/redfish/v1/Chassis/1/Transceivers/OpticalModule_mainboardPCIeCard4Port1"
            },
            "PortTechnology": "Ethernet",
            "FCId": null,
            "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

ResourceDefinition ​

uris ​

properties ​

supported_methods ​

HTTP methods ​

GET ​

PATCH ​

ResourceDefinition

uris

properties

supported_methods

HTTP methods

GET

PATCH