GET – Port properties
Use the GET method to retrieve properties in 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. | ||||
LinkNetworkTechnology | String | The link network technology capabilities of this port. The value can be "Ethernet", "InfiniBand", "FibreChannel" | ||||
Ethernet | Object | Expanded. (If this is Ethernet, the below items will be displayed) | ||||
AssociatedMACAddresses | Array | Items: string The array of configured MAC addresses that are associated with this network port. | ||||
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. | ||||
CurrentSpeedGbps | Number | The current speed of this port. | ||||
Name | String | "Physical Port X" (X = the Id value) | ||||
FunctionMaxBandwidth | Array | Items: Object The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | ||||
FunctionMaxBandwidth[N] | Object | Expanded. | ||||
AllocationPercent | Number | The maximum bandwidth allocation percentage allocated to the corresponding network device function instance. | ||||
NetworkDeviceFunction | Link | Link to a NetworkDeviceFunction. | ||||
MaxSpeedGbps | Number | The maximum speed of this port as currently configured. | ||||
Status | Object | Expand. | ||||
State | String | Enabled | ||||
Health | String | OK | ||||
HealthRollup | String | This represents the health state of this resource and its dependent resources. | ||||
FibreChannel | Object | Expanded. (If this is FibreChannel, the below items will be displayed). | ||||
AssociatedWorldWideNames | Array | Items: string The array of configured World Wide Names (WWN) that are associated with this network port. | ||||
InfiniBand | Object | Expanded. (If this is InfiniBand, the below items will be displayed). | ||||
AssociatedPortGUIDs | Array | Items: string The array of configured port GUIDs that are associated with this network port. | ||||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Example
The following example JSON response is returned:
{
"Ethernet": {
"AssociatedMACAddresses": [
"90:2e:16:05:4d:7c"
]
},
"Oem": {
…
},
"Description": "A Network Port represents a discrete physical port capable of connecting to a network.",
"LinkNetworkTechnology": "Ethernet",
"Status": {
"HealthRollup": "OK",
"Health": "OK",
"State": "Enabled"
},
"Id": "2",
"Name": "Physical Port 2",
"@odata.context": "/redfish/v1/$metadata#Port.Port",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2",
"MaxSpeedGbps": 10,
"CurrentSpeedGbps": null,
"@odata.type": "#Port.v1_6_0.Port",
"@odata.etag": "\"596e35b4a3e8296ddc6\"",
"LinkStatus": "LinkDown",
"FunctionMaxBandwidth": [
{
"AllocationPercent": null,
"NetworkDeviceFunction": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/NetworkDeviceFunctions/2.1"
}
}
]
}