Skip to main content

iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

Ethernet — Instance

URL

/redfish/v1/Managers/<ManagerInstance-Id>/EthernetInterfaces/<EthernetInstance-Id>

HTTP methods and privileges

Table 1. HTTP methods and privileges for instance of EthernetInterfacesThis table provides details about the supported HTTP methods and privileges for the instance of the resource.
HTTP method	Required privilege
PATCH	ConfigureManager

Properties

Table 2. Supported properties for EthernetInterfacesThis table provides details about the properties for the resource.
Property	Type	Read-only	Description
Hostname	String	No	The DNS Host Name, without any domain information.
IPv4Addresses	Array	No	Updates IPv4
IPv6Addresses	Array	No	Updates IPv6
IPv6Static	Array	No	Updates IPv6Static
AutoNeg	Boolean	No	An indication of whether the speed and duplex are automatically negotiated and configured on this interface.
FQDN	String	No	The complete, fully qualified domain name that DNS obtains for this interface.
FullDuplex	Boolean	No	An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface.
IPV6AddressPolicyTable	Array	No	An array that represents the RFC6724-defined address selection policy table.
IPv6DefaultGateway	String	Yes	This is the IPv6 default gateway address that is currently in use on this interface.
IPv6StaticAddresses	Array	Yes	Represents in an array all of the IPv6 static addresses to be assigned on this interface.
LinkStatus	String	Yes	The link status of this interface, or port.
NOTE LinkDown status is reported for a network failure or even when the network cable is unplugged.
MACAddress	String	No	The currently configured MAC address of the interface, or logical port.
MTUSize	Integer	No	The currently configured maximum transmission unit (MTU), in bytes, on this interface.
MaxIPv6StaticAddresses	Integer	Yes	The maximum number of static IPv6 addresses that can be configured on this interface.
NameServers	String	Yes	The DNS servers in use on this interface.
PermanentMACAddress	String	Yes	The permanent MAC address assigned to this interface, or port.
SpeedMbps	Integer	No	The current speed, in Mbps, of this interface.
Status	Object	Yes	The status and health of the Resource and its subordinate or dependent Resources.
Status.Health	Object	Yes	The health state of this Resource in the absence of its dependent Resources.
Status.State	Object	Yes	The known state of the Resource, such as, enabled.
VLAN	Boolean	Yes	This property contains the VLAN for this interface. If this interface supports more than one VLAN, the VLAN property shall be absent and, instead, the VLAN collection link shall be present.
VLAN.VLANEnable	Boolean	No	An indication of whether this VLAN is enabled for this VLAN network interface.
VLAN.VLANId	Integer	No	The ID for this VLAN.

Status codes and error message codes

Table 3. Status codes and error message codes for EthernetInterfacesThis table provides details about the HTTP status codes and error codes returned by the resource.
HTTP status code	Extended information	Error Message Code
200	Base.1.0.success
400	Base.1.0.PropertyValueTypeError Base.1.0.PropertyValueNotInList Base.1.0.PropertyUnknown Base.1.0.PropertyNotWritable Base.1.0.PropertyValueFormatError	ISM0013 RAC0253 RAC0254 RAC0255 RAC0259 SWC0296
500	Base.1.0.InternalError