iDRAC8 with Lifecycle Controller Version 2.70.70.70 Redfish API Guide

PDF

NetworkDeviceFunctions — Settings

Description

This resource is used to set the new value and create job to update the attributes of the logical interface exposed by the network adapter.

URL

/redfish/v1/Systems/System.Embedded.1/NetworkAdapters/<NetworkAdapters-Id/NetworkDeviceFunctions/<NetworkDeviceFunction-Id>/Settings

HTTP methods and privileges

Table 1. HTTP methods and privileges for the resourceThis table provides details about the supported HTTP methods and privileges for the resource.
HTTP method	Required privilege
GET	Login
PATCH	Login + SystemControl

Required parameters

Table 2. Parameters for NetworkDeviceFunction SettingsThis table provides details about the parameters for the resource.
Parameter	Type	Description
Status
MaxVirtualFunctions	Int64	The number of virtual functions (VFs) that are available for this Network Device Function.
NetDevFuncCapabilities	Collection(NetworkDeviceFunction.v1_0_0.NetworkDeviceTechology)	Capabilities of this network device function. NOTE The values of NetDevFuncCapabilities are determined by the port that the partition belongs to. The values of NetDevFuncCapabilities for all the partitions belonging to a particular port are the same.
NetDevFuncType	NetworkDeviceFunction.v1_0_0.NetworkDeviceTechology	The configured capability of this network device function.

FibreChannel
WWPN	String	The effective current World-Wide Port Name (WWPN) of this network device function (physical function). If an assignable WWPN is not supported, WWPN is a read only alias of the PermanentWWPN.
PermanentWWPN	String	PermanentWWPN is the permanent WWPN address assigned to this network device function (physical function).
WWNN	String	The effective current World-Wide Node Name (WWNN) of this network device function (physical function). If an assignable WWNN is not supported, WWNN is a read only alias of the PermanentWWNN.
WWNSource	NetworkDeviceFunction.v1_0_0.WWNSource	The configuration source of the World-Wide Names (WWNs) for this connection (WWPN and WWNN).
FCoELocalVLANId	Int64	For FCoE connections, 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 AllowFIPVLANDiscovery is true and a valid FCoE VLAN ID is found via the FIP VLAN Discovery Protocol.
FCoEActiveVLANId	Int64	The active FCoE VLAN ID.
BootTargets
WWPN	String	World-Wide Port Name (WWPN) to boot from.
LUNID	String	The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.

Ethernet
MACAddress	String	The effective current MAC Address of this network device function. If an assignable MAC address is not supported, this is a read-only alias of the PermanentMACAddress.
PermanentMACAddress	String	This is the permanent MAC address assigned to this network device function (physical function).
MTUSize	Int64	The Maximum Transmission Unit (MTU) configured for this Network Device Function. This value serves as a default for the OS driver when booting. The value only takes effect on boot.

iSCSIBoot
IPAddressType	NetworkDeviceFunction.v1_0_0.IPAddressType	The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields. Mixing of IPv6 and IPv4 addresses on the same network device function shall not be permissible.
InitiatorIPAddress	String	The IPv6 or IPv4 address of the iSCSI boot initiator.
InitiatorName	String	The iSCSI boot initiator name.
InitiatorDefaultGateway	String	The IPv6 or IPv4 iSCSI boot default gateway.
InitiatorNetmask	String	The IPv6 or IPv4 netmask of the iSCSI boot initiator.
TargetInfoViaDHCP	String	A boolean indicating whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.
PrimaryTargetName	String	The name of the primary iSCSI boot target (iSCSI Qualified Name, IQN).
PrimaryTargetIPAddress	String	The IP address (IPv6 or IPv4) for the primary iSCSI boot target.
PrimaryTargetTCPPort	Int64	The TCP port for the primary iSCSI boot target.
PrimaryLUN	Int64	The logical unit number (LUN) for the primary iSCSI boot target.
PrimaryVLANEnable	Boolean	It indicates if this VLAN is enabled for the primary iSCSI boot target.
PrimaryVLANId	Int64	The 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true.
PrimaryDNS	String	The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.
SecondaryTargetName	String	The name of the Secondary iSCSI boot target (iSCSI Qualified Name, IQN).
SecondaryTargetIPAddress	String	The IP address (IPv6 or IPv4) for the Secondary iSCSI boot target.
SecondaryTargetTCPPort	Int64	The TCP port for the Secondary iSCSI boot target.
SecondaryLUN	Int64	The logical unit number (LUN) for the Secondary iSCSI boot target.
SecondaryVLANEnable	Boolean	It indicates if this VLAN is enabled for the Secondary iSCSI boot target.
SecondaryVLANId	Int64	The 802.1q VLAN ID to use for iSCSI boot from the Secondary target. This VLAN ID is only used if SecondaryVLANEnable is true.
SecondaryDNS	String	The IPv6 or IPv4 address of the Secondary DNS server for the iSCSI boot initiator.
IPMaskDNSViaDHCP	Boolean	A boolean indicating whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.
AuthenticationMethod	NetworkDeviceFunction.v1_0_0.AuthenticationMethod	The iSCSI boot authentication method for this network device function.
CHAPUsername	String	The username for CHAP authentication.
CHAPSecret	String	The shared secret for CHAP authentication.

Status codes

Table 3. Status codesThis table provides details about the HTTP status codes returned.
HTTP status code	Extended information	Error message code
200
202
400	Base.1.0.PropertyValueTypeError Base.1.0.PropertyUnknown
403	Base.1.0.InsufficientPrivilege	RAC0506
405	Base.1.0.GeneralError	SYS402
500	Base.1.0.InternalError