GET – Network device PCIe functions

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

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Chassis/1/NetworkAdapters/{Locaton}/NetworkDeviceFunctions/{1-M}.{1-N}

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

{1-M}: Index of physical network port.

{1-N}: Index of logical network port.

Request body

None

Response body

Field					Type	Description
Id					String	Physical port index +"." + the logical port index, for the associated NetworkPort resource.
AssignablePhysicalPorts					Array	Items: link
	AssignablePhysicalPorts[N]				Link	Link to possible Ports
PhysicalNetworkPortAssignment					Link	Link to related NetworkPort.
Description					String	A Network Device Function represents a logical interface exposed by the network adapter.
DeviceEnabled					Boolean	True
InfiniBand					Object	Expand. (If this is InfiniBand, the below items will be displayed)
	PermanentPortGUID				String	The permanent port GUID assigned to this network device function.
	MTUSize				Number	The maximum transmission unit (MTU) configured for this network device function.
Ethernet					Object	Expand. (If this is Ethernet, the below items will be displayed)
	PermanentMACAddress				String	This is the permanent MAC address assigned to this network device function (physical function)
	MACAddress				String	This is the currently configured MAC address of the (logical port) network device function.
	MTUSize				Number	The Maximum Transmission Unit (MTU) configured for this network device function.
FibreChannel					Object	Expand. (If this is FibreChannel, the below items will be displayed)
	PermanentWWPN				String	This is the permanent WWPN address assigned to this network device function (physical function).
	WWPN				String	This is the currently configured WWPN address of the network device function (physical function).
Links					Object	Expand.
	EthernetInterface				Link	Link to an Ethernet interface
	PCIeFunction				Link	Link to a PCIeFunction
	PhysicalPortAssignment				Link	Link to a related NetworkPort
Name					String	"Logical Port"+" "+logical port index
NetDevFuncType					String	The configured capability of this network device function.
Status					Object	Expand
	State				String	Enabled
	Health				String	OK
	HealthRollup				String	This represents the health state of this resource and its dependent resources.
@Redfish.Settings					Object	Expanded This object is supported only when NetDevFuncType is iSCSI.
	Messages				Array	Items: object
		Messages[N]			Object	Expanded
			MessageId		String	“RebootRequired”
			RelatedProperties		Array	Items: string
				RelatedProperties[N]	String	The setting name of network device function. The format will be “#/iSCSIBoot/…”.
			Severity		String	“Warning”
			Message		String	“Changes completed successfully, but these changes will not take effect until next reboot.”
			Resolution		String	“Reboot the computer system for the changes to take effect.”
	SettingsObject				Link	Link to the network device function settings pending resource.
	Time				String	Indicate the time when the setting resource was last applied.
	SupportedApplyTimes				Array	Items: string Item count: 1
		SupportedApplyTimes[0]			String	“OnReset”
iSCSIBoot					Object	Expanded. This property is only supported when NetDevFuncType is “iSCSI”.
	AuthenticationMethod				String	The iSCSI boot authentication method for this network device function.
	CHAPSecret				String	The shared secret for CHAP authentication. Only be present if AuthenticationMethod is CHAP.
	CHAPUsername				String	The user name for CHAP authentication. Only be present if AuthenticationMethod is CHAP.
	IPAddressType				String	The type of IP address being populated in the iSCSIBoot IP address fields. Valid values: “IPv4”, “IPV6”
	InitiatorDefaultGateway				String	The IPv6 or IPv4 iSCSI boot default gateway.
	InitiatorIPAddress				String	The IPv6 or IPv4 iSCSI boot default gateway.
	InitiatorName				String	The iSCSI initiator name.
	InitiatorNetmask				String	The IPv6 or IPv4 netmask of the iSCSI boot initiator.
	MutualCHAPSecret				String	The CHAP secret for two-way CHAP authentication. Only be present if AuthenticationMethod is MutualCHAP.
	MutualCHAPUsername				String	The CHAP user name for two-way CHAP authentication. Only be present if AuthenticationMethod is MutualCHAP.
	PrimaryLUN				Number	The logical unit number (LUN) for the primary iSCSI boot target.
	PrimaryTargetIPAddress				String	The IPv4 or IPv6 address for the primary iSCSI boot target.
	PrimaryTargetName				String	The name of the iSCSI primary boot target.
	PrimaryTargetTCPPort				Number	The TCP port for the primary iSCSI boot target.
	TargetInfoViaDHCP				Boolean	An indication of whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "NetDevFuncType": "Ethernet",
    "Ethernet": {
        "PermanentMACAddress": "90:2e:16:05:4d:7c",
        "MTUSize": 72000,
        "MACAddress": "90:2e:16:05:4d:7c"
    },
    "PhysicalNetworkPortAssignment": {
        "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2"
    },
    "AssignablePhysicalPorts@odata.count": 2,
    "@odata.type": "#NetworkDeviceFunction.v1_8_0.NetworkDeviceFunction",
    "DeviceEnabled": true,
    "Name": "Logical Port 1",
    "@odata.context": "/redfish/v1/$metadata#NetworkDeviceFunction.NetworkDeviceFunction",
    "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/NetworkDeviceFunctions/2.1",
    "Links": {
        "EthernetInterface": {
            "@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/NIC2"
        },
        "PhysicalNetworkPortAssignment": {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2"
        },
        "PCIeFunction": {
            "@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/ob_2/PCIeFunctions/ob_2.01"
        }
    },
    "Status": {
        "Health": "OK",
        "HealthRollup": "OK",
        "State": "Enabled"
    },
    "Id": "2.1",
    "@odata.etag": "\"83405fffeb4731d4f240e\"",
    "Description": "A Network Device Function represents a logical interface exposed by the network adapter.",
    "AssignablePhysicalPorts": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/1"
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/ob-2/Ports/2"
        }
    ]
}

Give documentation feedback

GET – Network device PCIe functions

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example