3.25. EthernetInterface

Description

An EthernetInterface represents a logical endpoint for ethernet traffic.

Properties

Name
Name of this interface. (Identifier)
EthernetAddress
Ethernet address to be used by the interface. (Optional)
HAEthernetAddressMode
Define what type of ethernet addressing should be used in HA scenarios. (Default: PrivateSharedMAC)
HAType
Controls the HA mode of the interface. (Default: Critical)
MonitorTargets
The IP addresses of the hosts to monitor for HA diagnostics. (Optional)
MonitorTargetVLANs
Delegate hosts to monitor for HA diagnostics to the following VLANs. (Optional)
HeartbeatTransport
Set to VLAN interface in order to send VLAN-tagged heartbeats. (Default: <local>)
EthernetDevice
Ethernet device that this interface should use. (Optional)
VLANOutboundPrio
Priority value to use by VLAN interfaces that inherit their priority policy from this interface. (Default: 0)
VLANOutboundPrioPolicy
Specifies an inheritable policy for how VLAN interfaces determine the value of the priority field when adding the VLAN header to outbound packets. (Default: Set)
PrivateIP
The private IP address of this high availability node. (Optional)
RouterAdvertisementProfile
The Router Advertisement profile that will be used by the interface. (Default: DefaultProfile)
LAGEnabled
Specifies whether this interface uses Link Aggregation. (Default: No)
LAGMode
Specifies the method used to aggregate links. (Default: RoundRobin)
LAGMembers
The group of Ethernet devices to aggregate.
LAGTxPolicy
Specifies the packet characteristics used to distribute outgoing traffic among the active links. (Default: L3L4)
LAGActiveBackupPrimary
Specifies the primary member device in Active Backup mode. (Optional)
LAGLinkStatePollPeriod
Specifies the interval in milliseconds at which member devices not supporting LSC interrupts are checked for link status changes. (Default: 10)
LAGLinkUpDelay
Specifies the delay in milliseconds before propagating that the link status changed to up for a member device. (Default: 0)
LAGLinkDownDelay
Specifies the delay in milliseconds before propagating that the link status changed to down for a member device. (Default: 0)
LAGFastPeriodicInterval
Specifies the interval in milliseconds between periodic transmissions using fast timeouts. (Default: 900)
LAGSlowPeriodicInterval
Specifies the interval in milliseconds between periodic transmissions using slow timeouts. (Default: 29000)
LAGShortTimeout
Specifies the interval in milliseconds before invalidating received LACPDU information when using short timeouts. (Default: 3000)
LAGLongTimeout
Specifies the interval in milliseconds before invalidating received LACPDU information when using long timeouts. (Default: 90000)
LAGAggregateWaitTimeout
Specifies the number of milliseconds to delay aggregation to allow multiple links to aggregate simultaneously. (Default: 2000)
TargetRx
Expected receive bandwidth for this interface. Requires system restart to take effect. (Restart-required; Default: Auto)
TargetTx
Expected transmit bandwidth for this interface. Requires system restart to take effect. (Restart-required; Default: FollowRx)
MTU
Specifies the size (in bytes) of the largest packet that can be forwarded. (Default: 1500)
IPAddress
The interface's IP addresses. (Default: 0)
IP4Broadcast
The interface's IPv4 broadcast address. (Optional)
RoutingTableMembership
Interface's routing table membership. (Default: <all>)
DHCPEnabled
Indicates if this interface uses DHCP. (Optional)
DHCPPreferredIP
IP address preferred by this interface. (Optional)
DHCPServerFilter
Filter for acceptable DHCP server IP addresses. (Optional)
DHCPAddressFilter
Filter for acceptable IP addresses. (Optional)
DHCPPrimaryDNS
IP address of the primary DNS server. (Optional)
DHCPSecondaryDNS
IP address of the secondary DNS server. (Optional)
DefaultGateway
IP address to the default gateway. (Optional)
DHCPNetwork
IP address to the default gateway. (Optional)
DHCPPrimaryNBNS
IP address of the primary NBNS/WINS server. (Optional)
DHCPSecondaryNBNS
IP address of the secondary NBNS/WINS server. (Optional)
DHCPValidateBcast
Require highest network address as broadcast. (Default: Yes)
DHCPAllowGlobalBcast
Allow 255.255.255.255 as Broadcast address. (Default: No)
DHCPARPOnOfferEnabled
Perform ARP resolves on offered address. (Default: Yes)
DHCPCheckIPConflicts
Check for IP collisions with static routes. (Default: Yes)
DHCPCheckNetConflicts
Check for net collisions with static routes. (Default: Yes)
DHCPReleaseOnShutdown
Release active lease on graceful shutdown. (Default: No)
SecurityEquivalentInterfaces
Security and transport equivalent interfaces. (Optional)
IPv6AddressConfiguration
Controls IPv6 address configuration mode. (Default: Static)
IPv6Network
IPv6 on-link prefixes. (Optional)
IPv6DNS
IPv6 addresses of DNS servers. (Optional)
IPv6Gateway
IPv6 address of default gateway. (Optional)
MaxSLAACAddresses
Maximum number of autoconfigured IPv6 addresses. (Default: 4)
Zone
Specifies the zone that this interface is a member of. (Optional)
Comments
Text describing the current object. (Optional)