GET – Network port properties
Use the GET method to retrieve properties in network port resource for Redfish service.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/NetworkAdapters/{Location}/NetworkPorts/{1-N}
{Location}: Location of the corresponding NetworkAdapter device. {Location}=ob-X or slot-Y. ob stands for onboard device and slot stands for add-on card. X is the sequence number for onboard device starting from 1. Y is the slot number of add-on card.
{1-N}: Index of network physical port.
Request body
None
Response body
The response is a JSON object that contains the following parameters:
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
Id | String | Index. | ||||
ActiveLinkTechnology | String | Network Port Active Link Technology | ||||
AssociatedNetworkAddresses | Array | The array of configured network addresses (MAC or WWN) that are associated with this Network Port | ||||
CurrentLinkSpeedMbps | Number | Network port current link speed. | ||||
Description | String | A Network Port represents a discrete physical port capable of connecting to a network. | ||||
LinkStatus | String | The status of the link between this port and its link partner | ||||
Name | String | "Physical Port X" (X = the Id value) | ||||
NetDevFuncMaxBWAlloc | Array | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port | ||||
NetDevFuncMaxBWAlloc[] | Object | Expanded | ||||
MaxBWAllocPercent | Number | The maximum bandwidth allocation percentage allocated to the corresponding network device function instance | ||||
NetworkDeviceFunction | Link | Link to a NetworkDeviceFunction | ||||
PhysicalPortNumber | String | The physical port number label for this port | ||||
PortMaximumMTU | Number | The maximum transmission unit (MTU) that can be configured for this network port | ||||
Status | Object | Expand | ||||
State | String | Enabled | ||||
Health | String | OK | ||||
HealthRollup | String | This represents the health state of this resource and its dependent resources | ||||
SupprtedLinkCapabilities | Object | Expanded | ||||
CapableLinkSpeedMbps[0] | Array | The set of link speed capabilities of this port. | ||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Response example
The following example JSON response is returned:
{
"AssociatedNetworkAddresses": [
"B02628C5541C"
],
"NetDevFuncMaxBWAlloc": [
{
"NetworkDeviceFunction": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions/1.1"
},
"MaxBWAllocPercent": null
}
],
"SupportedLinkCapabilities": {
"CapableLinkSpeedMbps": [
10737418240
]
},
"Id": "1",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "OK"
},
"Name": "Physical Port 1",
"CurrentLinkSpeedMbps": null,
"ActiveLinkTechnology": "Ethernet",
"@odata.type": "#NetworkPort.v1_2_3.NetworkPort",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkPorts/1",
"PortMaximumMTU": 72000,
"@odata.etag": "\"53ae26592e452ae923e\"",
"PhysicalPortNumber": "1",
"Description": "A Network Port represents a discrete physical port capable of connecting to a network."
}