GET – Network Port Instance
Dependence
A Network Port represents a discrete physical port capable of connecting to a network.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.
Request
GET https://{{ip}}/redfish/v1/Chassis/Self/NetworkAdapters/{{NetwrokAdapter_instance}}/NetworkPorts/{{NetworkPort_instance}}
Content-Type: application/json
Response
The response of the request will be in JSON format. The properties are mentioned in the following table.
Name | Type | Read only | Description | ||||||
| (OData Attributes) | Refer to OData Support | ||||||||
| Oem | Object | OEM Extension (Optional), Refer to Resource Complex Types | |||||||
Id(M) | String | True | Refer to Resource Type Definitions | ||||||
Name(M) | String | True | |||||||
Description | String | True | |||||||
Status | Object | True | Refer to Resource Complex Types | ||||||
PhysicalPortNumber | String | True | The physical port number label for this port. | ||||||
LinkStatus | Object | True | The status of the link between this port and its link partner. | ||||||
Enum | Description | ||||||||
Down | The port is enabled but link is down. | ||||||||
Up | The port is enabled and link is good (up). | ||||||||
SupportedLinkCapabilities | Array of Objects | True | This object shall describe the static capabilities of the port, irrespective of transient conditions such as cabling, interface module presence, or remote link parter status or configuration. | ||||||
Name | Type | Read Only | Description | ||||||
LinkNetworkTechnology | String | True | The self-described link network technology capabilities of this port. | ||||||
Enum | Description | ||||||||
Ethernet | The port is capable of connecting to an Ethernet network. | ||||||||
InfiniBand | The port is capable of connecting to an InfiniBand network. | ||||||||
FibreChannel | The port is capable of connecting to a Fibre Channel network. | ||||||||
CapableLinkSpeedMbps | Number | True | The set of link speed capabilities of this port. | ||||||
AutoSpeedNegotiation | Boolean | True | An indication of whether the port is capable of aut-o negotiating speed. | ||||||
ActiveLinkTechnology | String | True | Network Port Active Link Technology. | ||||||
Enum | Description | ||||||||
Ethernet | The port is capable of connecting to an Ethernet network. | ||||||||
InfiniBand | The port is capable of connecting to an InfiniBand network. | ||||||||
FibreChannel | The port is capable of connecting to a Fibre Channel network. | ||||||||
SupportedEthernetCapabilities | String | True | The value of this property shall be an array of zero or more Ethernet capabilities supported by this port. | ||||||
Enum | Description | ||||||||
WakeOnLAN | Wake on LAN (WoL) is supported on this port. | ||||||||
EEE | IEEE 802.3az Energy Efficient Ethernet (EEE) is supported on this port. | ||||||||
NetDevFuncMinBWAlloc | Array of Objects | True | The array of minimum bandwidth allocation percentages for the Network Device Functions associated with this port. | ||||||
Name | Type | Read Only | Description | ||||||
MinBWAllocPercent | Number | True | The minimum bandwidth allocation percentage allocated to the corresponding network device function instance. | ||||||
NetworkDeviceFunction | Object | True | Contains the members of this collection. | ||||||
NetDevFuncMaxBWAlloc | Object | True | The array of maximum bandwidth allocation percentages for the Network Device Functions associated with this port. | ||||||
Name | Type | Read Only | Description | ||||||
MaxBWAllocPercent | Number | True | The maximum bandwidth allocation percentage allocated to the corresponding network device function instance. | ||||||
NetworkDeviceFunction | Object | True | Contains the members of this collection. | ||||||
AssociatedNetworkAddresses | Array | True | The array of configured network addresses (MAC or WWN) that are associated with this Network Port, including the programmed address of the lowest numbered Network Device Function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses. | ||||||
EEEEnabled | Boolean | True | Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is enabled for this network port. | ||||||
WakeOnLANEnabled | Boolean | True | Whether Wake on LAN (WoL) is enabled for this network port. | ||||||
PortMaximumMTU | Number | True | The value of this property shall be the largest maximum transmission unit (MTU) that can be configured for this network port. | ||||||
FlowControlStatus | String | True | The value of this property shall be the 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only). Enums are same as FlowControlConfiguration given below. | ||||||
FlowControlConfiguration | String | True | The value of this property shall be the locally configured 802.3x flow control setting for this network port. | ||||||
Enum | Description | ||||||||
None | No IEEE 802.3x flow control is enabled on this port | ||||||||
TX | IEEE 802.3x flow control may be initiated by this station. | ||||||||
RX | IEEE 802.3x flow control may be initiated by the link partner. | ||||||||
TX_RX | IEEE 802.3x flow control may be initiated by this station or the link partner. | ||||||||
SignalDetected | Boolean | True | The value of this property shall be a boolean indicating whether the port has detected enough signal on enough lanes to establish link. | ||||||
CurrentLinkSpeedMbps | Number | True | The value of this property shall be the current configured link speed of this port. | ||||||
FCFabricName | String | True | The FC Fabric Name provided by the switch. | ||||||
FCPortConnectionType | String | True | This is the connection type of this port. | ||||||
Enum | Description | ||||||||
ExtenderFabric | This port connection type is an extender fabric port. | ||||||||
Generic | This port connection type is a generic fabric port. | ||||||||
NPort | This port connects via an N-Port to a switch. | ||||||||
NotConnected | This port is not connected. | ||||||||
PointToPoint | This port connects in a Point-to-point configuration. | ||||||||
PrivateLoop | This port connects in a private loop configuration. | ||||||||
PublicLoop | This port connects in a public configuration. | ||||||||
MaxFrameSize | Number | True | The maximum frame size supported by the port. | ||||||
NumberDiscoveredRemotePorts | Number | True | The number of ports not on this adapter that this port has discovered. | ||||||
VendorId | String | True | The Vendor Identification for this port. | ||||||
Actions | Object | True | This object will contain the actions for this resource under Oem property if any. | ||||||
Response example
{
"@odata.context": "/redfish/v1/$metadata#NetworkPort.NetworkPort",
"@odata.etag": "\"1618913716\"",
"@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkPorts/DevType7_SlotA_Instance0_PORT0",
"@odata.type": "#NetworkPort.v1_2_2.NetworkPort",
"ActiveLinkTechnology": "Ethernet",
"ActiveLinkTechnology@Redfish.AllowableValues": [
"Ethernet",
"InfiniBand",
"FibreChannel"
],
"AssociatedNetworkAddresses": [
"B0:26:28:E5:24:88"
],
"FlowControlConfiguration@Redfish.AllowableValues": [
"None",
"TX",
"RX",
"TX_RX"
],
"Id": "DevType7_SlotA_Instance0_PORT0",
"LinkStatus": "Down",
"Name": "DevType7_SlotA_Instance0_PORT0",
"PhysicalPortNumber": "PortNumber_1",
"PortMaximumMTU": 1500,
"Status": {
"Health": "OK",
"State": "Disabled"
}
}