Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

EthernetInterface

Description

This resource contains NIC resources as part of the Redfish Specification.

Fields

FieldTypeDescription
DescriptionDescription
DHCPv4DHCPv4ConfigurationThis property shall contain the configuration of DHCP v4.
DHCPv6DHCPv6ConfigurationThis property shall contain the configuration of DHCP v6.
FQDNstringThis property shall contain the fully qualified domain name that DNS obtains for this interface.
FullDuplexbooleanThis property shall indicate whether full-duplex mode is enabled on the Ethernet connection for this interface.
HostNamestringThis property shall contain the DNS host name for this interface. Modifying this property may modify the `HostName` in one or more `EthernetInterface` resources that belong to the same system, manager, or other device. If this interface is subordinate to a `ComputerSystem` resource, modifying this property may modify the `HostName` of the `ComputerSystem` resource that contains this interface. If this interface is subordinate to a `Manager` resource, modifying this property may modify the `HostName` of the `ManagerNetworkProtocol` resource of the `Manager` resource that contains this interface. Services should ignore this property in modification requests if `FQDN` is also provided in the same request.
IdId
IPv4AddressesarrayThis property shall contain an array of objects that represent the IPv4 connection characteristics currently in use by this interface for any value of `AddressOrigin`. It is recommended that this property be regarded as read-only with configuration of static addresses performed by updating the values within `IPv4StaticAddresses`. Services may reject updates to this array for this reason. This property should contain an empty array if there are no active IPv4 addresses.
IPv4StaticAddressesarrayThis property shall contain an array of objects that represent all IPv4 static addresses assigned to, but not necessarily in use by, this interface. The `IPv4Addresses` property shall also list the addresses that this interface uses. Services should represent static addresses that are not configured as `null` values, as described by the ‘PATCH on array properties’ clause of the Redfish Specification. Services should not represent static addresses that are not configured as invalid IP addresses, such as `0.0.0.0`.
IPv6AddressesarrayThis property shall contain an array of objects that represent the IPv6 connection characteristics for this interface for any value of `AddressOrigin`. This property should contain an empty array if there are no active IPv6 addresses.
IPv6AddressPolicyTablearrayThis property shall contain an array of objects that represent the RFC6724-defined address selection policy table.
IPv6DefaultGatewaystringThis property shall contain the current IPv6 default gateway address in use on this interface.
IPv6EnabledbooleanThis property shall indicate whether IPv6 is enabled on this interface. If this property contains `false`, the interface shall not contain any assigned IPv6 addresses, shall not initiate DHCPv6 requests, and shall not send or process ICMPv6 packets. If this property is not present, but this interface contains other IPv6 properties, the value shall be assumed to be `true`.
IPv6StaticAddressesarrayThis property shall contain an array of objects that represent the IPv6 static connection characteristics for this interface. Services should represent static addresses that are not configured as `null` values, as described by the ‘PATCH on array properties’ clause of the Redfish Specification. Services should not represent static addresses that are not configured as invalid IP addresses, such as `::`.
IPv6StaticDefaultGatewaysarrayThe values in this array shall represent the IPv6 static default gateway addresses for this interface.
LinksLinksThis property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
LinkStatusLinkStatusThis property shall contain the link status of this interface, or port.
MACAddressMACAddressThis property shall contain the effective current MAC address of this interface. If an assignable MAC address is not supported, this value is a read-only alias of the PermanentMACAddress.
MaxIPv6StaticAddressesintegerThis property shall indicate the number of array items supported by `IPv6StaticAddresses`, or the maximum number of static IPv6 addresses that can be configured on this interface.
NameName
NameServersarrayThis property shall contain the DNS servers in use on this interface.
OemOemThis property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements.
RoutingScopeRoutingScopeThis property shall contain the routing scope for this interface. This property shall only be present if this interface belongs to a virtual machine or container.
SpeedMbpsintegerThis property shall contain the link speed of the interface, in megabits per second (Mbit/s) units. This property shall be writable only when the `AutoNeg` property is `false`.
StaticNameServersarrayThis property shall contain the statically-defined set of DNS server IP addresses to use when DHCP provisioning is not enabled for name server configuration. As an implementation option, they can be used in addition to DHCP-provided addresses, or in cases where the DHCP server provides no DNS assignments.
StatusStatusThis property shall contain any status or health properties of the resource.
VLANVLANThis property shall contain 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.
VLANsVLanNetworkInterfaceCollectionThis property shall contain a link to a resource collection of type `VLanNetworkInterfaceCollection`, which applies only if the interface supports more than one VLAN. If this property is present, the `VLANEnabled` and `VLANId` properties shall not be present.