GET – Network Adapter Instance

Dependence

An Instance of Network Adapter represents the physical network adapter capable of connecting to a computer network.
These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.

Request

GET https://{{ip}}/redfish/v1/Chassis/Self/NetworkAdapters/{{NetwrokAdapter_instance}}
Content-Type: application/json

Response

The response of the request will be in JSON format. The properties are mentioned in the following tables.

Table 1. NetworkAdapter Properties
Name	Type	Read only	Description
(OData Attributes)			Refer to OData Support
Oem	Object		OEM Extension (Optional), Refer to Resource Complex Types
Id(M)	String	True	Refer to Resource Type Definitions
Name(M)	String	True
Description	String	True
Status	Object	True	Refer to Resource Complex Types.
Manufacturer	String	True	The manufacturer or OEM of this network adapter.
Model	String	True	The model string for this network adapter.
SKU	String	True	The manufacturer SKU for this network adapter.
SerialNumber	String	True	The serial number for this network adapter.
PartNumber	String	True	Part number for this network adapter.
Controllers	Array		The set of network controllers ASICs that make up this NetworkAdapter. Refer to Controller Properties.
Actions	Object	True	This object will contain the actions for this resource under Oem property if any.
NetworkDeviceFunctions(N)	Object	True	Contains a reference to the members of NetworkDeviceFunctionCollection.
NetworkPorts(N)	Object	True	Contains a reference to the members of NetworkPortCollection.
Assembly	Object	True	The link to the assembly Resource associated with this adapter. Platform specific porting needed.

Table 2. Controller Properties

Name

Type

Read only

Description

FirmwarePackageVersion

String

True

Resource Identifier

Location

Object

True

See Resource.v1_8_1 schema property.

PCIeInterface

Object

True

The PCIe interface details for this controller.

See PCIe Interface Properties.

Identifiers

Object

True

The Durable names for the network adapter.

Name	Type	Read only	Description
DurableName	String	True	This indicates the worldwide, persistent name of the resource.
DurableNameFormat	String	True	This represents the format of the DurableName property.

Links

String

True

Links for this controller.

Name

Type

Read Only

Description

PCIeDevices@odata.count

Number

True

An integer representing the number of items in a collection.

Note

Require PCIe support, only northBound available.

PCIeDevices

Array

An array of references to the PCIeDevice collection.

Note

Require PCIe support, only north bound available.

Oem

Object

True

Refer to Resource Complex Types.

NetworkPorts

Array

True

An array of links to the NetworkPorts associated with this Network Controller.

NetworkPorts@odata.count

Number

True

An integer representing the number of items in a collection.

NetworkDeviceFunctions@odata.count

Number

True

An integer representing the number of items in a collection.

NetworkDeviceFunctions

Array

An array of references to the NetworkDeviceFun ctions.

ControllerCapabilities

String

True

Description of the Resource

Name

Type

Read Only

Description

NetworkPortCount

Number

True

The number of physical ports on this controller.

NetworkDeviceFunctionCount

Number

True

The maximum number of physical functions available on this controller.

DataCenterBridging

Object

This object shall contain capability, status, and configuration values related to Data Center Bridging (DCB) for this controller.

Name: Capable

Type: Boolean

Read only: True

Description: Whether this controller is capable of Data Center Bridging (DCB).

VirtualizationOffload

Object

This object shall contain capability, status, and configuration values related to virtualization offload for this controller. Refer to VirtualizationOffload Properties.

NPAR

Object

NIC Partitioning (NPAR) capabilities for this controller. Refer to NPAR Properties.

NPIV

Object

N_Port ID Virtualization (NPIV) capabilties for this controller. Refer to NPIV Properties.

Table 3. VirtualizationOffload Properties

Name

Type

Read only

Description

VirtualFunction

Object

True

Name	Type	Read Only	Description
DeviceMaxCount	Number	True	The maximum number of Virtual Functions (VFs) supported by this controller.
NetworkPortMaxCount	Number	True	The maximum number of Virtual Functions (VFs) supported per network port for this controller.
MinAssignmentGroupSize	Number	True	The minimum number of Virtual Functions (VFs) that can be allocated or moved between physical functions for this controller.

SRIOV

String

True

Single-Root Input/Output Virtualization (SR-IOV) capabilities.

Name	Type	Read Only	Description
SRIOVVEPACapable	Boolean	True	Whether this controller supports Single Root Input/Output Virtualization (SR-IOV) in Virtual Ethernet Port Aggregator (VEPA) mode

Table 4. NPAR Properties
Name	Type	Read only	Description
NparCapable	Boolean	True	Indicates whether or not NIC function partitioning is support by a controller.
NparEnabled	Boolean	True	When true, NIC function partitioning is active on this controller.

Table 5. NPIV Properties
Name	Type	Read only	Description
MaxDeviceLogins	Number	True	The maximum number of N_Port ID Virtualization (NPIV) logins allowed simultaneously from all ports on this controller.
MaxPortLogins	Number	True	The maximum number of N_Port ID Virtualization (NPIV) logins allowed per physical port on this controller.

Response example

{
    "@odata.context": "/redfish/v1/$metadata#NetworkAdapter.NetworkAdapter",
    "@odata.etag": "\"1618913716\"",
    "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0",
    "@odata.type": "#NetworkAdapter.v1_2_1.NetworkAdapter",
    "Controllers": [
        {
            "ControllerCapabilities": {
                "NetworkDeviceFunctionCount": 1,
                "NetworkPortCount": 1
            },
            "Links": {
                "NetworkDeviceFunctions": [
                    {
      "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkDeviceFunctions/NetworkDeviceFunction0"
                    }
                ],
                "NetworkDeviceFunctions@odata.count": 1,
                "NetworkPorts": [
                    {
                        "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkPorts/
DevType7_SlotA_Instance0_PORT0"
                    }
                ],
                "NetworkPorts@odata.count": 1,
                "PCIeDevices": [
                    {
                        "@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00"
                    }
                ],
                "PCIeDevices@odata.count": 1
            },
            "PCIeInterface": {
                "LanesInUse": 0,
                "MaxPCIeType": "Gen1",
                "PCIeType": "Gen1"
            }
        }
    ],
    "Id": "DevType7_NIC0",
    "Name": "DevType7_NIC0",
    "NetworkDeviceFunctions": {
        "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkDeviceFunctions"
    },
    "NetworkPorts": {
        "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkPorts"
    },
    "Status": {
        "Health": "OK",
        "State": "Disabled"
    }
}

Give documentation feedback

GET – Network Adapter Instance

Dependence​

Request​

Response​

Response example​

Dependence

Request

Response

Response example