Skip to main content

GET – Network adapter properties

Use the GET method to retrieve properties in NetworkAdapter resource for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/NetworkAdapters/{Location}

{Location}: Location of the corresponding NetworkAdapter device. {Location}=ob-X or slot-Y. ob stands for onboard device and slot stands for add-on card. X is the sequence number for onboard device starting from 1. Y is the slot number of add-on card.

Request body

None

Response body

Field

Type

Description

Id

String

Only Ethernet,Fibre Channel, InfiniBand devices support to have the NetworkAdapter resource now:

For add-on devices, the value is “slot-{slot number}”

For on-board devices, the value is “ob-{index}”

Controllers

Array

The set of network controllers ASICs that make up this NetworkAdapter

 

Controllers[]

Object

Expanded

  

FirmwarePackageVersion

String

The version of the user-facing firmware package

  

PCIeInterface

Object

Expanded

   

LanesInUse

Number

The number of PCIe lanes in use by this device.

   

MaxLanes

Number

The number of PCIe lanes supported by this device.

   

MaxPCIeType

String

The highest version of the PCIe specification supported by this device.

   

PCIeType

String

The version of the PCIe specification in use by this device.

  

Location

Object

The location of network adapter.

   

PartLocation

Object

The part location within the placement.

    

ServiceLabel

String

The label of the part location, such as a silk-screened name or a printed label. PCIe X (X is the slot number).

    

LocationType

String

The type of location of network adapter. Fixed value : Slot

    

LocationOrdinalValue

Integer

The number that represents the location of the part. If LocationType is `slot` and this unit is in slot 2, the LocationOrdinalValue is 2.

   

Info

String

The location of the Resource: Slot {N} (N is the slot number) or “OnBoard”.

   

Infoformat

String

The format of the Info property. “Slot X” or “OnBoard”.

   

Info@Redfish.Deprecated

String

The property is deprecated. Please use PartLocation instead.

   

InfoFormat@Redfish.Deprecated

String

The property is deprecated. Please use PartLocation instead.

  

Links

Object

Links for this controller

   

PCIeDevices

Array

Items: link

    

PCIeDevices[]

Link

Link to related PCIeDevice.

   

NetworkPorts

Array

Items: link

    

NetworkPorts[]

Link

Link to related NetworkPorts.

   

NetworkDeviceFunctions

Array

Items: link

    

NetworkDeviceFunctions[]

Link

Link to related NetworkDeviceFunctions.

  

ControllerCapabilities

Object

The capabilities of a controller.

   

NetworkPortCount

Number

The count of physical ports of this adapter.

   

NetworkDeviceFunctionCount

Number

The count of logical ports of this adapter.

Description

String

A NetworkAdapter represents the physical network adapter capable of connecting to a computer network.

Manufacturer

String

The manufacturer or OEM of this network adapter.

Model

String

The model string for this network adapter.

SKU

String

The manufacturer SKU for this network adapter.

Name

String

The card name for this network adapter.

PartNumber

String

The part number for this network adapter.

SerialNumber

String

The serial number for this network adapter.

Status

Object

Expand

 

State

String

Enabled

 

Health

String

This represents the health state of this resource.

NetworkPorts

Link

Link to related NetworkPortsCollection.

NetworkDeviceFunctions

Link

Link to related NetworkDeviceFunctionsCollection.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"SerialNumber": "L2NV97J018G",
"NetworkDeviceFunctions": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions"
},
"Id": "slot-13",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13",
"NetworkPorts": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkPorts"
},
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Name": "Broadcom NetXtreme PCIe 1Gb 2-Port RJ45 Ethernet Adapter",
"Controllers": [
{
"ControllerCapabilities": {
"NetworkDeviceFunctionCount": 2,
"NetworkPortCount": 2
},
"FirmwarePackageVersion": "212.0.5.4",
"Location": {
"PartLocation": {
"LocationType": "Slot",
"ServiceLabel": "PCIe 13",
"LocationOrdinalValue": 13
},
"InfoFormat": "Slot X",
"Info": "Slot 13",
"Info@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead.",
"InfoFormat@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead."
},
"Links": {
"NetworkPorts": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkPorts/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkPorts/2"
}
],
"NetworkDeviceFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions/1.1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions/2.1"
}
],
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_13"
}
]
},
"PCIeInterface": {
"LanesInUse": 2,
"MaxPCIeType": "Gen2",
"MaxLanes": 4,
"PCIeType": "Gen2"
}
}
],
"PartNumber": "SN30L21970",
"SKU": "00YK550",
"@odata.type": "#NetworkAdapter.v1_3_0.NetworkAdapter",
"Oem": {
"Lenovo": {
"@odata.type": "#LenovoDeviceInfo.v1_0_0.LenovoDeviceInfo",
"UUID": "00000000000000000000B02628C5541C"
}
},
"Manufacturer": "Broadcom Limited",
"@odata.etag": "\"9b40314193f036ad3898f8482b8a3a9a\"",
"Model": "5720",
"Description": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network."
}