Skip to main content

GET – Server network interfaces

Use the GET method to retrieve properties in Network interface for Redfish service.

Request URL​

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

Request body​

None

Response body​

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

FieldTypeDescription
IdString

Index

DescriptionString

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

NameString

Network Interface X (X=1-N)

StatusObject

expand

 StateString

Enabled

 HealthString

OK

LinksObject

expand

 NetworkAdapterLink

Link to related NetworkAdapter.

NetworkPortsLink

Link to related NetworkPortCollection.

NetworkDeviceFunctionsLink

Link to 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",
   "Id" : "1",
   "Status" : {
      "Health" : "OK",
      "State" : "Enabled"
   },
   "NetworkPorts" : {
      "@odata.id" : "/redfish/v1/Chassis/1/NetworkAdapters/ob-1/NetworkPorts"
   },
   "Links" : {
      "NetworkAdapter" : {
         "@odata.id" : "/redfish/v1/Chassis/1/NetworkAdapters/ob-1"
      }
   },
   "NetworkDeviceFunctions" : {
      "@odata.id" : "/redfish/v1/Chassis/1/NetworkAdapters/ob-1/NetworkDeviceFunctions"
   },
   "@odata.etag" : "\"dc20bec25dc27d97279c8bada95185d6\"",
   "@odata.id" : "/redfish/v1/Systems/1/NetworkInterfaces/1",
   "@odata.type" : "#NetworkInterface.v1_1_1.NetworkInterface",
   "Description" : "A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and 
                    NetworkDeviceFunction resources and represents the functionality available to the 
                    containing system.",
   "Name" : "Network Interface 1"
}