Skip to main content

GET – Server Ethernet interface properties

Use the GET method to retrieve properties in Ethernet interface resource for a server.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/EthernetInterfaces/NIC{1…N}

Request body​

None

Response body​

The response is a JSON object that contains the following parameters:

FieldTypeDescription

Id

String

NIC{1..N}

SpeedMbps

String

The current speed in Mbps of this XCC2 interface(units: Mbit/s)

InterfaceEnabled

Boolean

A boolean indicating whether this interface is enabled.

MACAddress

String

The currently configured MAC address of the (logical port) interface.

PermanentMACAddress

String

The permanent MAC address assigned to this interface (port).

Name

String

"External Ethernet Interface"

LinkStatus

String

The link status of this interface (port).

LinkUp: The link is available for communication on this interface.

NoLink: There is no link or connection detected on this interface.

LinkDown: There is no link on this interface, but the interface is connected.

Status

Object

Expand

 

State

String

The state of this ethernet interface.

 

Health

String

The health of this ethernet interface.

Links

Object

Expand

 

Chassis

Link

The value is a reference to the resource “Chassis” that represent the physical container.

Description

String

External Network Interface

FQDN

String

“” (empty string)

HostName

String

“” (empty string)

NameServers

String

Array

Empty array

IPv4Addresses

Array

Empty array

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "FQDN": "",
    "Id": "NIC1",
    "NameServers": [],
    "SpeedMbps": null,
    "HostName": "",
    "IPv4Addresses": [],
    "Description": "Enternal Network Interface",
    "Status": {
        "State": "Enabled",
        "Health": “OK”
    },
    "MACAddress": "7e:d3:0a:ed:bb:1b",
    "Name": "Enternal Ethernet Interface",
    "InterfaceEnabled": true,
    "@odata.type": "#EthernetInterface.v1_5_1.EthernetInterface",
    "Links": {
        "Chassis": {
            "@odata.id": "/redfish/v1/Chassis/1"
        }
    },
    "LinkStatus": "LinkDown",
    "@odata.etag": "\"4524b3cedd2525a9e6c\"",
    "PermanentMACAddress": "7e:d3:0a:ed:bb:1b",
    "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/NIC1"
}