Skip to main content

GET – Network Device Function Instance

Dependence​

  1. A Network Device Function represents a logical interface exposed by the network adapter.

  2. These resources are populated by Host Interface, and Extra AMI BIOS Support is needed.

Request​

GET https://{{ip}}/redfish/v1/Chassis/Self/NetworkAdapters/{{NetworkAdapter_instance}}/NetworkDeviceFunctions/
{{NetworkDeviceFunctions_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. NetworkDeviceFunction

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.

NetDevFuncType

String

True

The configured capability of this network device function.

Enum

Description

Disabled

Neither enumerated nor visible to the operating system.

Ethernet

Appears to the operating system as an Ethernet device.

FibreChannel

Appears to the operating system as a Fibre Channel device.

iSCSI

Appears to the operating system as an iSCSI device.

FibreChannelOverEthernet

Appears to the operating system as an FCoE device.

DeviceEnabled

Boolean

True

Whether the network device function is enabled. Disabled network device functions shall not be enumerated or seen by t operating system.

NetDevFuncCapabilities

Array

True

Capabilities of this network device function. Array Items are of Type NetDevFuncType.

Ethernet

Object

 

This object shall contain Ethernet capabilities, status, and configuration values for this network device function.

Name

Type

Read Only

Description

PermanentMACAddress

String

True

This is the permanent MAC address assigned to this network device function (physical function).

MACAddress

String

False

This is the currently configured MAC address of the (logical port) network device function.

VLANs

Object

True

This is a reference to a collection of VLANs and is only used if the interface supports more than one VLANs.

See VLAN Properties.

MTUSize

Number

False

The Maximum Transmission Unit (MTU) configured for this network device function.

iSCSIBoot

Object

 

This object shall contain iSCSI boot capabilities, status, and configuration values for this network device function.

See ISCSI Boot Properties.

Note
TheISCSIBoot attributes can be deleted / removed by patching null value to each property inside SCSIBoot object.

FibreChannel

Object

 

This object shall contain Fibre Channel capabilities, status, an configuration values for this network device function.

See Fibre Channel Properties.

BootMode

String

False

The boot mode configured for this network device function.

Enum

Description

Disabled

Do not indicate to UEFI/BIOS that this device is bootable.

PXE

Boot this device using the embedded PXE support. Only applicable if the NetworkDeviceFunctionType is set to Ethernet

iSCSI

Boot this device using the embedded iSCSoI obt support and configuration. Only applicable if the NetworkDeviceFunctionType is set to iSCSI.

FibreChannel

Boot this device using the embedded Fibre Channel support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannel.

FibreChannelOverEthernet

Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot support and configuration. Only applicable if the NetworkDeviceFunctionType is set to FibreChannelOverEthernet.

VirtualFunctionsEnabled

Boolean

True

Whether Single Root I/O Virtualization (SR-IOV) Virtual Functions (VFs) are enabled for this Network Device Function.

MaxVirtualFunctions

Number

True

The number of virtual functions (VFs) that are available for this Network Device Function.

Actions

Object

True

This object will contain the actions for this resource under Oem property if any.

AssignablePhysicalPorts

Array

True

An array of physical ports to which this network device function may be assigned.

AssignablePhysicalPorts@odata.count

Number

True

Number of AssignablePhysicalPorts available.

Links

Object

True

Links for this controller.

Name

Type

Read Only

Description

Endpoints@odata.count

Number

True

An integer representing the number of items in a collection.

Endpoints

Array

True

An array of references to endpoints associated with this network device function.

The type shall contain an array property who's members reference resources, of type Endpoint, which are associated with this network device function.

PhysicalPortAssignment

Object

True

The physical port that this network device function is currently assigned to.

PCIeFunction

Object

True

A reference to the collection of members of this collection.

Note
Will be populated through Host Interface.
Table 2. VLAN Properties

Name

Type

Read only

Description

VLANId

Number

False

This indicates the VLAN identifier for this VLAN.

Minimum value: 0

Maximum value: 4094

VLANEnable

boolean

False

This indicates if this VLAN is enabled.

Table 3. iSCSI Boot Properties

Name

Type

Read only

Description

IPAddressType

String

False

Allowable values are as following

Note
Redfish.AllowableValues array should always be shown to indicate the supported allow values.

Enum

Description

IPv4

IPv4 addressing is used for all IP-fields in this object.

IPv6

IPv6 addressing is used for all IP-fields in this object.

InitiatorIPAddress

String

False

The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.

InitiatorName

String

False

The iSCSI boot initiator name.

InitiatorDefaultGateway

String

False

The IPv6 or IPv4 iSCSI boot default gateway.

InitiatorNetmask

String

False

The IPv6 or IPv4 netmask of the iSCSI boot initiator.

TargetInfoViaDHCP

Boolean

False

Whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.

PrimaryTargetName

String

False

The name of the iSCSI primary boot target.

PrimaryTargetIPAddress

String

False

The IP address (IPv6 or IPv4) for the primary iSCSI boot target.

PrimaryTargetTCPPort

Number

False

The TCP port for the primary iSCSI boot target.

PrimaryLUN

Number

False

The logical unit number (LUN) for the primary iSCSI boot target.

PrimaryVLANEnable

Boolean

False

This indicates if the primary VLAN is enabled.

PrimaryVLANId

Number

False

The 802.1qVLAN ID to use for iSCSI boot from the primary target.

Minimum = "0"

Maximum ="4094"

PrimaryDNS

String

False

The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.

SecondaryTargetName

String

False

The name of the iSCSIsecondary boot target.

SecondaryTargetIPAddress

String

False

The IP address (IPv6 or IPv4) for the secondary iSCSI boot target.

SecondaryTargetTCPPort

Number

False

The TCP port for the secondary iSCSI boot target.

SecondaryLUN

Number

False

The logical unit number (LUN) for the secondary iSCSI boot target.

SecondaryVLANEnable

Boolean

False

This indicates if the secondary VLAN is enabled.

SecondaryVLANId

Number

False

The 802.1q VLAN ID to use for iSCSI boot from the seconda target.

Minimum = "0"

Maximum ="4094"

SecondaryDNS

String

False

The IPv6 or IPv4 address of the secondary DNS server for the iSCSI boot initiator.

IPMaskDNSViaDHCP

Boolean

False

Whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.

RouterAdvertisementEnabled

Boolean

False

Whether IPv6 router advertisement is enabled for the iSCSI boot target.

AuthenticationMethod

String

False

The iSCSI boot authentication method for this network device function.

Allowable values are as following

Note
Redfish.AllowableValues array should always be shown to indicate the supported allow values.

Enum

Description

None

No iSCSI authentication is used.

CHAP

iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.

MutualCHAP

iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.

CHAPUsername

String

False

The username for CHAP authentication.

CHAPSecret

String

False

The shared secret for CHAP authentication.

MutualCHAPUsername

String

False

The CHAP Username for 2-way CHAP authentication.

MutualCHAPSecret

String

False

The CHAP Secret for 2-way CHAP authentication.

Table 4. Fibre Channel Properties

Name

Type

Read only

Description

PermanentWWPN

String

True

The value of this property shall be the permanent World-Wide Port Name (WWPN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.

PermanentWWNN

String

True

"The value of this property shall be the permanent World-Wide Node Name (WWNN) of this network device function (physical function). This value is typically programmed during the manufacturing time. This address is not assignable.

FibreChannelId

String

True

The Fibre Channel Id assigned by the switch for this interface.

WWPN

String

False

The value of this property shall be the effective current World - Wide Port Name (WWPN) of this network device function (physical function). If an assignable WWPN is not supported, this is a read only alias of the Permanent WWPN.

WWNN

String

False

The value of this property shall be the effective current Wo-rld Wide Node Name (WWNN) of this network device function (physical function). If an assignable WWNN is not supported, this is a read only alias of the Permanent WWNN.

WWNSource

String

False

The configuration source of the WWNs for this connection (WWPN and WWNN).

Enum

Description

ConfiguredLocally

The set of FC/FCoE boot targets was applied locally through API or UI.

ProvidedByFabric

The set of FC/FCoE boot targets was applied by the Fibre Channel fabric.

FCoELocalVLANId

Number

False

For FCoE connections, the value of this property shall be the VLAN ID configured locally by setting this property. This value shall be used for FCoE traffic to this network device function during boot unless Allow FIPVLANDiscovery is true and a vali FCoE VLAN ID is found via the FIP VLAN Discovery Protocol.

Minimum = "0"

Maximum ="4094"

AllowFIPVLANDiscovery

Boolean

False

For FCoE connections, the value of this property shall be a boolean indicating whether the FIP VLAN Discovery Protocol is used to determine the FCoE VLAN ID selected by the network device function for the FCoE connectionI.f true, and the FIP VLAN Discovery succeeds, the FCoEActiveVLANId property shall reflect the FCoE VLAN ID to be used for all FCoE traffic. If false, or if the FIP VLAN Discovery protocol fails, the FCoELocalVLANId shall be used for all FCoE traffic and the FCoEActiveVLANId shall reflect the FCoELocalVLANId.

FCoEActiveVLANId

Number

True

For FCoE connections, the value of this property shall be null or a VLAN ID currently being used for FCoE traffic. When the FCoE link is down this value shall be null. When the FCoE link is up this value shall be either the FCoELocalVLANId property or a VLAN discovered via the FIP protocol.

Minimum = "0"

Maximum ="4094"

BootTargets

Array

False

An array of Fibre Channel boot targets configured for this network device function.

Name

Type

Read Only

Description

WWPN

String

False

The World-Wide Port Name to boot from.

LUNID

String

False

The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.

BootPriority

Number

False

The value of this property shall be the relative priority for this entry in the boot targets array. Lower numbers shall represent higher priority, with zero being the highest priority. The BootPriority shall be unique for all entries of the BootTargets array.

Response example​

{
    "@odata.context": "/redfish/v1/$metadata#NetworkDeviceFunction.NetworkDeviceFunction",
    "@odata.etag": "\"1618913716\"",
    "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkDeviceFunctions/NetworkDeviceFunction0",
    "@odata.type": "#NetworkDeviceFunction.v1_3_2.NetworkDeviceFunction",
    "AssignablePhysicalPorts": [
        {
            "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkPorts/
DevType7_SlotA_Instance0_PORT0"
        }
    ],
    "BootMode@Redfish.AllowableValues": [
        "Disabled",
        "PXE",
        "iSCSI",
        "FibreChannel",
        "FibreChannelOverEthernet"
    ],
    "Ethernet": {
        "MACAddress": "B0:26:28:E5:24:88",
        "MTUSize": 1500,
        "PermanentMACAddress": "B0:26:28:E5:24:88"
    },
    "FibreChannel": {
        "WWNSource@Redfish.AllowableValues": [
            "ConfiguredLocally",
            "ProvidedByFabric"
        ]
    },
    "Id": "NetworkDeviceFunction0",
    "Links": {
        "Endpoints@odata.count": 0,
        "PCIeFunction": {
            "@odata.id": "/redfish/v1/Chassis/Self/PCIeDevices/00_01_00/PCIeFunctions/DevType3_OCP1_DevIndex10"
        },
        "PhysicalPortAssignment": {
            "@odata.id": "/redfish/v1/Chassis/Self/NetworkAdapters/DevType7_NIC0/NetworkPorts/
DevType7_SlotA_Instance0_PORT0"
        }
    },
    "Name": "NetworkDeviceFunction0",
    "NetDevFuncType@Redfish.AllowableValues": [
        "Disabled",
        "Ethernet",
        "FibreChannel",
        "iSCSI",
        "FibreChannelOverEthernet"
    ],
    "iSCSIBoot": {
        "AuthenticationMethod@Redfish.AllowableValues": [
            "None",
            "CHAP",
            "MutualCHAP"
        ],
        "IPAddressType@Redfish.AllowableValues": [
            "IPv4",
            "IPv6"
        ]
    }
}