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/{Id}

Request body

None

Response body

Field

Type

Description

Id

String

slot_{N}_{PCIe_address}, N is the slot number.

Controllers

Array

The set of network controllers ASICs that make up this Network adapter.

 

Controllers[]

Object

Expanded.

  

Location

Object

The location of network adapter.

   

PartLocation

Object

The part location within the placement.

    

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.

    

LocationType

String

The type of location of network adapter.

    

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).

  

FirmwarePackageVersion

String

The version of the user-facing firmware package

  

PCIeInterface

Object

Expanded.

Note
This object is not supported in AMD platform.
   

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.

  

Links

Object

Links for this controller.

   

PCIeDevices

Array

Items: link

    

PCIeDevices[]

Link

Link to related PCIeDevice.

   

Ports

Array

Items: link

    

Ports[]

Link

Link to related Ports.

   

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.

   

DataCenterBridging

Object

Data center bridging (DCB) for this controller.

    

Capable

Boolean

An indication of whether this controller is capable of data center bridging (DCB).

   

NPAR

Object

Expanded.

    

NparCapable

Boolean

An indication of whether the controller supports NIC function partitioning.

    

NparEnabled

Boolean

An indication of whether NIC function partitioning is active on this controller.

   

VirtualizationOffload

Object

Expanded.

    

SRIOV

Object

Expanded.

     

SRIOVVEPACapable

Boolean

An indication of whether this controller supports single root input/output virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode.

    

VirtualFunction

Object

Expanded.

     

DeviceMaxCount

Number

The maximum number of virtual functions supported by this controller.

     

MinAssignmentGroupSize

Number

The minimum number of virtual functions that can be allocated or moved between physical functions for this controller.

     

NetworkPortMaxCount

Number

The maximum number of virtual functions supported per network port for this controller.

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.

Ports

Link

Link to related PortsCollection.

NetworkDeviceFunctions

Link

Link to related NetworkDeviceFunctionsCollection.

Status

Object

Expanded.

 

State

String

Enabled

 

Health

String

This represents the health state of this resource.

Status code

HTTP Status CodeError Message ID
500InternalError

Example

The following example JSON response is returned:

{
"@odata.context": "/redfish/v1/$metadata#NetworkAdapter.NetworkAdapter",
"@odata.etag": "\"7C8FCFF9\"",
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000",
"@odata.type": "#NetworkAdapter.v1_9_0.NetworkAdapter",
"Controllers": [
{
"ControllerCapabilities": {
"NetworkDeviceFunctionCount": 0,
"NetworkPortCount": 2
},
"FirmwarePackageVersion": "4.07.04",
"Links": {
"NetworkDeviceFunctions": [],
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot3_0xb0000"
}
],
"Ports": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/Ports/1"
},
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/Ports/2"
}
]
},
"Location": {
"PartLocation": {
"LocationOrdinalValue": 3,
"LocationType": "Slot",
"ServiceLabel": "PCI 3"
}
},
"PCIeInterface": {
"LanesInUse": 8,
"MaxLanes": 8,
"MaxPCIeType": "Gen4",
"PCIeType": "Gen4"
}
}
],
"Description": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network.",
"Id": "slot3_0xb0000",
"Manufacturer": "QLogic",
"Model": "QLE2772",
"Name": "QLogic QLE2772 32Gb 2-Port PCIe Fibre Channel Adapter",
"NetworkDeviceFunctions": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/NetworkDeviceFunctions"
},
"Oem": {
...
}
},
"PartNumber": "SN37A28357",
"Ports": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot3_0xb0000/Ports"
},
"SKU": "01KR591",
"SerialNumber": "C1MP0630A9E",
"Status": {
"Health": "OK",
"State": "Enabled"
}
}