Skip to main content

GET – Server network interface properties

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

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/NetworkInterfaces/{id}

Request body​

None

Response body​

FieldTypeDescription

Id

String

Index of network interface.

Description

String

A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.

Name

String

Network Interface X (X=1-N)

Status

Object

Expanded.

 

State

String

Enabled

 

Health

String

OK

Links

Object

Expanded.

 

NetworkAdapter

Link

Link to the related NetworkAdapter

 

Ports

Link

Link to the related PortCollection

 

NetworkDeviceFunctionCollection

Link

Link to the related NetworkDeviceFunctionCollection

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

The following example JSON response is returned:

{
    "@odata.context": "/redfish/v1/$metadata#NetworkInterface.NetworkInterface",
    "@odata.etag": "\"98C4EEB6\"",
    "@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/1",
    "@odata.type": "#NetworkInterface.v1_2_1.NetworkInterface",
    "Description": "A NetworkInterface contains references linking NetworkAdapter,                     NetworkPort, and NetworkDeviceFunction resources and represents                     the functionality available to the containing system.",
    "Id": "1",
    "Links": {
        "NetworkAdapter": {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000"
        }
    },
    "Name": "Network Interfaces 1",
    "NetworkDeviceFunctions": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/NetworkDeviceFunctions"
    },
    "Ports": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/Ports"
    },
    "Status": {
        "Health": "OK",
        "State": "Enabled"
    }
}