10. Network Management

EthernetInterfaces resources are used to manage System and BMC network configuration.

10.1 Viewing System Network Settings

10.1.1 System EthernetInterfaces

This API will get a list of all network interfaces associated with the system.

URI: /redfish/v1/Systems/1/EthernetInterfaces

Method: GET

Response Example:

{
    "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces",
    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "Description": "System NICs on Jetson Servers",
    "Members": [
        {
            "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/eth0"
        },
        {
            "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/eth1"
        }
    ],
    "Members@odata.count": 2,
    "Name": "Ethernet Interface Collection"
}

Each @odata.id points to an individual NIC that can be queried for more details.

10.1.2 System EthernetInterface Info

Retrieve detailed configuration and status for the specified network interface.

URI: /redfish/v1/Systems/1/EthernetInterfaces/<NIC>

Method: GET

Response Example:

{
    "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/eth0",
    "@odata.type": "#EthernetInterface.v1_12_0.EthernetInterface",
    "Description": "System NIC 1",
    "DHCPv4": {
        "DHCPEnabled": false,
        "UseDNSServers": true,
        "UseGateway": true
    },
    "EthernetInterfaceType": "Physical",
    "FQDN": "d135_001.avermedia.com",
    "FullDuplex": true,
    "HostName": "d135_001",
    "IPv4Addresses": [
        {
            "Address": "192.168.0.10",
            "AddressOrigin": "Static",
            "Gateway": "192.168.0.1",
            "SubnetMask": "255.255.252.0"
        }
    ],
    "Id": "eth0",
    "MACAddress": "12:44:6A:3B:04:11",
    "Name": "Ethernet Interface",
    "NameServers": [
        "names.avermedia.com"
    ],
    "PermanentMACAddress": "12:44:6A:3B:04:11",
    "SpeedMbps": 1000,
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    },
    "TeamMode": "None"
}

HTTP Status Code: 403 Forbidden

Possible Causes

• The OOB (Out-of-Band) controller retrieves network information from the main system. If the main system is rebooting and the daemon service responsible for providing this information has not yet started, calling this API may result in a 403 error.
• This issue may also occur if the communication interface between the main system and the OOB controller is currently in use by another application or if there is a hardware-related problem.

Resolution

• Wait until the main system has fully booted and the daemon service is up and running. Once the service is initialized, the API will respond normally.
• Ensure that the communication interface between the main system and the OOB controller is available and functioning correctly.
• Check system logs for hardware errors or interface conflicts.
• If the issue persists, perform a power cycle or contact system support for further diagnosis.

10.1.3 Retrieve System Network Information Workflow

1. GET /redfish/v1/Systems
       ↓
2. GET /redfish/v1/Systems/{SystemId}/EthernetInterfaces
       ↓
3. For each NIC:
       GET /redfish/v1/Systems/{SystemId}/EthernetInterfaces/{NICId}

Note:
To retrieve Ethernet interface information from the host system, a background daemon service must be installed and running on the host.
Please refer to Appendix B – Daemon Installation for installation instructions.

10.2 Viewing BMC Network Settings

10.2.1 BMC EthernetInterfaces

URI: /redfish/v1/Managers/BMC/EthernetInterfaces

Method: GET

Response:

{
    "@odata.id": "/redfish/v1/Managers/BMC/EthernetInterfaces",
    "@odata.type": "#EthernetInterfaceCollection.EthernetInterfaceCollection",
    "Description": "Collection of EthernetInterfaces for this Manager",
    "Members": [
        {
            "@odata.id": "/redfish/v1/Managers/BMC/EthernetInterfaces/eth0"
        }
    ],
    "Members@odata.count": 2,
    "Name": "Ethernet Network Interface Collection"
}

10.2.2 BMC EthernetInterface Info

URI: /redfish/v1/Managers/1/EthernetInterfaces/eth0

Method: GET

Response:

{
    "@odata.id": "/redfish/v1/Managers/BMC/EthernetInterfaces/eth0",
    "@odata.type": "#EthernetInterface.v1_12_0.EthernetInterface",
    "AutoNeg": true,
    "Description": "Management network interface on a dedicated port",
    "DHCPv4": {
        "DHCPEnabled": true,
        "UseDNSServers": true,
        "UseGateway": true
    },
    "FQDN": "avtoob_000001.local",
    "FullDuplex": true,
    "HostName": "avtoob_000001",
    "IPv4Addresses": [
        {
            "Address": "192.168.0.10",
            "AddressOrigin": "DHCP",
            "Gateway": "192.168.0.1",
            "SubnetMask": "255.255.255.0"
        }
    ],
    "Id": "eth0",
    "InterfaceEnabled": true,
    "LinkStatus": "LinkUp",
    "MACAddress": "23:11:8A:33:CF:EA",
    "MTUSize": 1500,
    "Name": "Manager Ethernet Interface",
    "NameServers": [
        "8.8.8.8",
        "8.8.4.4"
    ],
    "SpeedMbps": 100,
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    }
}

10.3 BMC IPv4 Configuration

URI: /redfish/v1/Managers/BMC/EthernetInterfaces/eth0

Method: PATCH

Payload:

{
    "DHCPv4": {
        "DHCPEnabled": false,
        "UseDNSServers": true,
        "UseGateway": true
    },
    "IPv4Addresses": [
        {
            "Address": "192.168.0.10",
            "AddressOrigin": "STATIC",
            "Gateway": "192.168.0.1",
            "SubnetMask": "255.255.255.0"
        }
    ],
    "NameServers": [
        "8.8.8.8",
        "8.8.4.4"
    ]
}

Next section