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/Id/Ports/Id

Request body

None

Response body

Field			Type	Description
Id			String	Port id is provided by hardware.
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.
	FlowControlConfiguration		String	The locally configured 802.3x flow control setting for this port.
	FlowControlStatus		String	The 802.3x flow control behavior negotiated with the link partner for this port.
	LLDPEnabled		Boolean	Enable/disable LLDP for this port.
	LLDPReceive		Object	Expanded.
		ChassisId	String	Link Layer Data Protocol (LLDP) chassis ID.
		ManagementAddressIPv4	String	The IPv4 management address received from the remote partner across this link.
		ManagementAddressMAC	String	The management MAC address received from the remote partner across this link.
		SystemName	String	The system name to be transmitted from this endpoint.
		SystemDescription	String	The system description to be transmitted from this endpoint.
	LLDPTransmit		Object	Expanded.
		ChassisId	String	Link Layer Data Protocol (LLDP) chassis ID.
		ChassisIdSubtype	String	The type of identifier used for the chassis ID.
		ManagementAddressIPv4	String	The IPv4 management address to be transmitted from this endpoint.
		ManagementAddressIPv6	String	The IPv6 management address to be transmitted from this endpoint.
		ManagementAddressMAC	String	The management MAC address to be transmitted from this endpoint.
		ManagementAddressVlanId	Number	The management VLAN ID to be transmitted from this endpoint.
		PortId	String	A colon-delimited string of hexadecimal octets identifying a port to be transmitted from this endpoint.
		PortIdSubtype	String	The port ID subtype to be transmitted from this endpoint.
	WakeOnLANEnabled		Boolean	Indicates whether Wake on LAN (WoL) is enabled on this port.
Description			String	A Network Port represents a discrete physical port capable of connecting to a network.
Name			String	Physical Port X (X = the Id value).
CurrentSpeedGbps			Number	The current speed of this port.
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.
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.
InfiniBand			Object	Expanded. (If this is InfiniBand, the below items will be displayed).
	AssociatedNodeGUIDs		Array	Items: string The array of configured node GUIDs that are associated with this network port.
	AssociatedPortGUIDs		Array	Items: string The array of configured port GUIDs that are associated with this network port.
	AssociatedSystemGUIDs		Array	Items: string The array of configured system GUIDs that are associated with this network port.
LinkState			String	The state of the link between this port and its link partner.
LinkStatus			String	The status of the link between this port and its link partner.
LinkConfiguration			Array	The configuration of the link between this port and its link partner.
	LinkConfiguration[]		Object	Link to related link configuration.
		AutoSpeedNegotiationCapable	Boolean	An indication of whether the port is capable of autonegotiating speed.
		AutoSpeedNegotiationEnabled	Boolean	Controls whether this port is configured to enable autonegotiating speed.
		CapableLinkSpeedGbps	Array	The set of link speed capabilities of this port.
MaxSpeedGbps			Number	The maximum speed of this port as currently configured.
MaxFrameSize			Number	The maximum frame size of this port as currently configured.
MaximumMTU			Number	The maximum MTU of this port as currently configured.
PortProtocol			Number	The protocol being sent over this port.
Status			Object	Expanded.
	State		String	Enabled
	Health		String	OK
	HealthRollup		String	This represents the health state of this resource and its dependent resources.
SignalDetected			Boolean	An indication of whether a signal is detected on this interface.
SFP			Object	The small form-factor pluggable (SFP) device associated with this port.
	Status		Object	Expanded.
		State	String	Enabled
		Health	String	This represents the health state of this resource in the absence of its dependent resources
		HealthRollup	String	This represents the health state of this resource and its dependent resources.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#Port.Port",
    "@odata.etag": "\"E67D9D87\"",
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/Ports/1",
    "@odata.type": "#Port.v1_7_0.Port",
    "CurrentSpeedGbps": 0.0,
    "Description": "A Network Port represents a discrete physical port                     capable of connecting to a network.",
    "FibreChannel": {
        "AssociatedWorldWideNames": [
            "210034800D725642"
        ]
    },
    "Id": "1",
    "LinkNetworkTechnology": "FibreChannel",
    "LinkState": "Enabled",
    "LinkStatus": "LinkDown",
    "MaxFrameSize": 16384,
    "MaxSpeedGbps": 32,
    "MaximumMTU": 16384,
    "Name": "Physical Port 1",
    "Oem": {
        ...
        }
    },
    "PortProtocol": "FC",
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    }
}

Give documentation feedback

GET – Port properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example