Querying Ethernet Interface Collection Information

Function

This interface is used to query the information about Ethernet collection resources.

Syntax

Operation type: GET

URL: https://device_ip/redfish/v1/Systems/EthernetInterfaces

Request header:

X-Auth-Token: auth_value

Request message body: None

Usage Guidelines

None

Example

Request:

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

Request header:

X-Auth-Token: auth_value

Request message body: None

Response:

{
    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "@odata.context": "/redfish/v1/$metadata#Systems/Members/EthernetInterfaces/$entity",
    "@odata.id": "/redfish/v1/Systems/EthernetInterfaces",
    "Name": "Ethernet Interface Collection",
    "Description": "System NICs on Servers",
    "Members@odata.count": 2,
    "Members": [
        {
            "@odata.id": "/redfish/v1/Systems/EthernetInterfaces/GMAC1"
        },
        {
            "@odata.id": "/redfish/v1/Systems/EthernetInterfaces/GMAC0"
        }
    ]
}

Response code: 200

Output Description

**Table 1** Operation output description
Field	Type	Description
@odata.context	Character string	OData description of a network port collection resource model.
@odata.id	Character string	Path to access a network port collection resource.
@odata.type	Character string	Type of a network port collection resource.
Name	Character string	Name of a network port collection resource.
Description	Character string	Description of a network port.
Members@odata.count	Number	Number of current network port collection resources.
Members	Array	Network port list.
Members.@odata.id	Character string	Path to access a network port resource node.

Parent topic: Network Management