Skip to main content

iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

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/<ComputerSystem-Id>/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

Supported Properties


Property	Type	Read Only	Description
Status	Object	Yes	This property describes the status and health of the resource and its children.
MaxVirtualFunctions	Integer	Yes	The number of virtual functions (VFs) that are available for this Network Device Function.
NetDevFuncCapabilities	Array	Yes	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	String	No	The configured capability of this network device function. Following values are supported: Disabled Ehternet FibreChannel iSCSI FibreChannelOverEthernet
FibreChannel	Object	No	Describes Fibre Channel capabilities, status, and configuration of a network device function.
FibreChannel.WWPN	String	No	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.
FibreChannel.PermanentWWPN	String	No	PermanentWWPN is the permanent WWPN address assigned to this network device function (physical function).
FibreChannel.WWNN	String	No	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.
FibreChannel.WWNSource	String	No	The configuration source of the World-Wide Names (WWNs) for this connection (WWPN and WWNN). Following values are supported: ConfiguredLocally ProvidedByFabric
FibreChannel.FCoELocalVLANId	Integer	No	For FCoE connections, VLAN ID is 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.
FibreChannel.FCoEActiveVLANId	Integer	No	The active FCoE VLAN ID.
FibreChannel.BootTargets.WWPN	String	No	World-Wide Port Name (WWPN) to boot from.
FibreChannel.BootTargets.LUNID	String	No	The Logical Unit Number (LUN) ID to boot from on the device referred to by the corresponding WWPN.
Ethernet.MACAddress	String	No	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.
Ethernet.PermanentMACAddress	String	No	This is the permanent MAC address assigned to this network device function (physical function).
Ethernet.MTUSize	Integer	No	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	String	No	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. Following values are supported: IPv4 IPv6
iSCSIBoot.InitiatorIPAddress	String	No	The IPv6 or IPv4 address of the iSCSI boot initiator.
iSCSIBoot.InitiatorName	String	No	The iSCSI boot initiator name.
iSCSIBoot.InitiatorDefaultGateway	String	No	The IPv6 or IPv4 iSCSI boot default gateway.
iSCSIBoot.InitiatorNetmask	String	No	The IPv6 or IPv4 netmask of the iSCSI boot initiator.
iSCSIBoot.TargetInfoViaDHCP	String	No	A boolean indicating whether the iSCSI boot target name, LUN, IP address, and netmask should be obtained from DHCP.
iSCSIBoot.PrimaryTargetName	String	No	The name of the primary iSCSI boot target (iSCSI Qualified Name, IQN).
iSCSIBoot.PrimaryTargetIPAddress	String	No	The IP address (IPv6 or IPv4) for the primary iSCSI boot target.
iSCSIBoot.PrimaryTargetTCPPort	Integer	No	The TCP port for the primary iSCSI boot target.
iSCSIBoot.PrimaryLUN	Integer	No	The logical unit number (LUN) for the primary iSCSI boot target.
iSCSIBoot.PrimaryVLANEnable	Boolean	No	It indicates if this VLAN is enabled for the primary iSCSI boot target.
iSCSIBoot.PrimaryVLANId	Integer	No	The 802.1q VLAN ID to use for iSCSI boot from the primary target. This VLAN ID is only used if PrimaryVLANEnable is true.
iSCSIBoot.PrimaryDNS	String	No	The IPv6 or IPv4 address of the primary DNS server for the iSCSI boot initiator.
iSCSIBoot.SecondaryTargetName	String	No	The name of the Secondary iSCSI boot target (iSCSI Qualified Name, IQN).
iSCSIBoot.SecondaryTargetIPAddress	String	No	The IP address (IPv6 or IPv4) for the Secondary iSCSI boot target.
iSCSIBoot.SecondaryTargetTCPPort	Integer	No	The TCP port for the Secondary iSCSI boot target.
iSCSIBoot.SecondaryLUN	Integer	No	The logical unit number (LUN) for the Secondary iSCSI boot target.
iSCSIBoot.SecondaryVLANEnable	Boolean	No	It indicates if this VLAN is enabled for the Secondary iSCSI boot target.
iSCSIBoot.SecondaryVLANId	Integer	No	The 802.1q VLAN ID to use for iSCSI boot from the Secondary target. This VLAN ID is only used if SecondaryVLANEnable is true.
iSCSIBoot.SecondaryDNS	String	No	The IPv6 or IPv4 address of the Secondary DNS server for the iSCSI boot initiator.
iSCSIBoot.IPMaskDNSViaDHCP	Boolean	No	A boolean indicating whether the iSCSI boot initiator uses DHCP to obtain the iniator name, IP address, and netmask.
iSCSIBoot.AuthenticationMethod	String	No	The iSCSI boot authentication method for this network device function. Following values are supported: None CHAP MutualCHAP
iSCSIBoot.CHAPUsername	String	No	The username for CHAP authentication.
iSCSIBoot.CHAPSecret	String	No	The shared secret for CHAP authentication.

Status codes

Table 2. 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
404	Base.1.5.GeneralError	SYS403
405	Base.1.0.GeneralError	SYS402
500	Base.1.0.InternalError