Querying Ethernet Interface Resource Information

Function

This interface is used to query the information about the Ethernet interface resources of a specified host.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/EthernetInterfaces/<eth_Id>

Request header:

X-Auth-Token: auth_value

Request message body: None

URL Parameters

**Table 1** URL parameters
Parameter	Mandatory/Optional	Description	Value
<eth_Id>	Mandatory	ID of a network port resource.	Network port name displayed on the OS. The value can be GMAC0 or GMAC1.

Usage Guidelines

To ensure the normal running of the edge management system and avoid frame freezing or slow upload and download, the network bandwidth must meet the following requirements:

The bandwidth between the edge device where the edge management system is located and the web client must be greater than or equal to 20 Mbit/s.
Other network requirements: latency < 30 ms, packet loss rate < 3%

Example

Request:

GET https://10.10.10.10/redfish/v1/Systems/EthernetInterfaces/GMAC0

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/EthernetInterfaces/Members/$entity",
    "@odata.id": "/redfish/v1/Systems/EthernetInterfaces/GMAC0",
    "@odata.type": "#EthernetInterface.v1_8_0.EthernetInterface",
    "Id": "GMAC0",
    "Name": "eth0",
    "Description": "Ethernet Interface over Wired Network Adapter",
    "PermanentMACAddress": "00:18:C0:xx:xx:03",
    "MACAddress": "00:18:C0:xx:xx:04",
    "InterfaceEnabled": true,
    "LinkStatus": "LinkUp",
    "IPv4Addresses": [{
        "Address": "xx.xx.xx.xx",
        "SubnetMask": "255.255.0.0",
        "Gateway": "xx.xx.xx.xx",
        "VlanId": "null",
        "AddressOrigin": "Static",
        "Tag": "Mgmt"
    }],
    "IPv6Addresses": [{
       "Address": "fe80::xxxx:xxxx:xxxx:6403",
       "PrefixLength": 64,
       "AddressOrigin": "LinkLocal",
       "AddressState": "Preferred"",
        "Gateway": null
    }],
    "IPv6DefaultGateway": "xxxx::xxxx",
    "NameServers": [
        "xxx.xxx.xxx"
    ],
    "Oem": {
        "WorkMode": "1000Mbs"
        "AdapterType": "GMAC,
        "LteDataSwitchOn": true,
        "Connections": [],
        "Statistic": {
            "SendPackages": "123456",
            "RecvPackages": "123456",
            "ErrorPackages": "123456",
            "DropPackages": "123456"
        }
    }
}

Response code: 200

Output Description

**Table 2** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of a network port resource.
@odata.id	Character string	Path to access a network port resource node.
@odata.type	Character string	Type of a network port resource.
Id	Character string	ID of a network port resource. GMAC + number: wired network port
Name	Character string	Name of a network port resource.
Description	Character string	Description of a network port.
PermanentMACAddress	Character string	Permanent MAC address of a network port.
MACAddress	Character string	Current MAC address of a network port.
InterfaceEnabled	Boolean	Specifies whether a network port is enabled.
LinkStatus	Character string	Link status: LinkUp NoLink LinkDown
IPv4Addresses[]	Array	IPv4 address table.
IPv4Addresses[].Address	Character string	IPv4 address.
IPv4Addresses[].SubnetMask	Character string	Subnet mask.
IPv4Addresses[].Gateway	Character string	Gateway.
IPv4Addresses[].VlanId	Character string	VLAN ID.
IPv4Addresses[].AddressOrigin	Character string	Address source: Static DHCP
IPv4Addresses[].Tag	Character string	IP address usage label.
IPv6Addresses[]	Array	IPv6 address table.
IPv6Addresses[].Address	Character string	IPv6 address.
IPv6Addresses[].PrefixLength	Character string	Length of the IPv6 prefix.
IPv6Addresses[].AddressOrigin	Character string	Address source: Static DHCPv6 LinkLocal SLAAC
IPv6Addresses[].AddressState	Character string	Address status: Preferred Deprecated Tentative Failed
IPv6Addresses[].Gateway	Character string	Default IPv6 gateway.
IPv6Addresses[].Tag	Character string	IP address usage label.
NameServers	Array	DNS string.
Oem	Object	Customized field.
Oem.WorkMode	Character string	Work mode of a network port: 1000 Mbit/s 100 Mbit/s 10 Mbit/s
Oem.AdapterType	Character string	Type of a network port: The value is GMAC.
Oem.LteDataSwitchOn	Boolean	Whether to enable mobile data.
Oem.Connections[]	Array	List of available connections.
Oem.Statistic[].SendPackages	Character string	Sent packets.
Oem.Statistic[].RecvPackages	Character string	Received packets.
Oem.Statistic[].ErrorPackages	Character string	Error packets.
Oem.Statistic[].DropPackages	Character string	Dropped packets.

Parent topic: Network Management