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 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.
		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.
			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.
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.
Ports					Link	Link to related PortsCollection.
NetworkDeviceFunctions					Link	Link to related NetworkDeviceFunctionsCollection.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "Manufacturer": "Broadcom Limited",
    "@odata.context": "/redfish/v1/$metadata#NetworkAdapter.NetworkAdapter",
    "SKU": "",
    "Model": "BCM5719",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Oem": {
        …
    },
    "SerialNumber": "L0NV18D000C",
    "@odata.etag": "\"e83f6e6f3af62ff749494\"",
    "Controllers": [
        {
            "ControllerCapabilities": {
                "NetworkPortCount": 4,
                "NetworkDeviceFunctionCount": 4
            },
            "FirmwarePackageVersion": "214.0.6.1",
            "Links": {
                "PCIeDevices": [
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/slot_13"
                    }
                ],
                "Ports": [
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/Ports/1"
                    },
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/Ports/2"
                    },
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/Ports/3"
                    },
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/Ports/4"
                    }
                ],
                "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"
                    },
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions/3.1"
                    },
                    {
                        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions/4.1"
                    }
                ]
            },
            "PCIeInterface": {
                "PCIeType": "Gen1",
                "LanesInUse": 4,
                "MaxPCIeType": "Gen1",
                "MaxLanes": 4
            },
            "Location": {
                "PartLocation": {
                    "LocationType": "Slot",
                    "ServiceLabel": "PCIe 13",
                    "LocationOrdinalValue": 13
                },
                "InfoFormat@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead.",
                "Info": "Slot 13",
                "Info@Redfish.Deprecated": "The property is deprecated. Please use PartLocation instead.",
                "InfoFormat": "Slot X"
            }
        }
    ],
    "NetworkDeviceFunctions": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/NetworkDeviceFunctions"
    },
    "Name": "Broadcom 5719 1GbE RJ45 4-port OCP Ethernet Adapter",
    "@odata.type": "#NetworkAdapter.v1_9_0.NetworkAdapter",
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13",
    "PartNumber": "SN37A28309",
    "Description": "A NetworkAdapter represents the physical network adapter capable of connecting to a computer network.",
    "Id": "slot-13",
    "Ports": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/slot-13/Ports"
    }
}

Give documentation feedback

GET – Network adapter properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example