Ethernet

Ethernet interfaces provide the fundamental physical connectivity for NX-OS devices, supporting various speeds from 100m to 800g with comprehensive Layer 2 switching and Layer 3 routing capabilities including access/trunk modes, VLAN assignment, and FEX fabric connectivity. They offer extensive configuration options including auto-negotiation, FEC mode, duplex, MTU, link debounce, carrier delay, beacon, storm control, dot1q tagging, voice VLAN, load intervals, and advanced features such as port channels with LACP, VPC membership, subinterfaces, and uRPF for security. Ethernet interfaces support protocol sub-sections for OSPF, OSPFv3, PIM, IS-IS, HSRP, DHCP relay, IPv6 ND, spanning tree, and QoS service policies, along with IPv4/IPv6 addressing, access group filtering, and interface group inheritance for standardized configuration.

Diagram

Classes

interfaces (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
ethernets	List	`[ethernets]`	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory
id	String		Yes
interface_groups	List	String	No
shutdown	Boolean	`true`, `false`	No
negotiate_auto	Choice	`on`, `off`, `25g`	No
bandwidth	Integer	min: `0`, max: `3200000000`	No
beacon	Boolean	`true`, `false`	No
delay	Integer	min: `1`, max: `16777215`	No
description	String		No
dfe_adaptive_tuning	Boolean	`true`, `false`	No
dfe_tuning_delay	Integer	min: `100`, max: `10000`	No
dot1q_ethertype	Integer	min: `1536`, max: `65535`	No
duplex	Choice	`auto`, `full`, `half`	No
fec	Choice	`fc-fec`, `rs-fec`, `fec-off`, `auto`, `rs-ieee`, `rs-cons16`, `kp-fec`	No
itu_channel	Integer	min: `1`, max: `96`	No
link_active_jitter_management	Boolean	`true`, `false`	No
link_debounce_time	Integer	min: `0`, max: `20000`	No
link_debounce_link_up	Integer	min: `0`, max: `20000`	No
link_flap_err_disable	Boolean	`true`, `false`	No
link_flap_err_disable_max	Integer	min: `2`, max: `30`	No
link_flap_err_disable_interval	Integer	min: `5`, max: `420`	No
logging_event_port_link_status	Boolean	`true`, `false`	No
loopback	Boolean	`true`, `false`	No
link_mac_up_timer	Integer	min: `0`, max: `120`	No
link_max_bring_up_timer	Integer	min: `0`, max: `120`	No
link_transmit_reset	Boolean	`true`, `false`	No
mac_address	String		No
mdix	Choice	`auto`, `mdi`, `mdi-x`	No
media_type	Choice	`none`, `10g-tx`	No
medium	Choice	`broadcast`, `p2p`	No
mtu	Integer	min: `576`, max: `9216`	No
packet_timestamp_egress_source_id	Integer	min: `0`, max: `8388606`	No
packet_timestamp_ingress_source_id	Integer	min: `0`, max: `8388606`	No
packet_timestamp	Choice	`disable`, `enable-ingress`, `enable-egress`, `enable-both`	No
snmp_trap_link_status	Boolean	`true`, `false`	No
speed	Choice	`unknown`, `100m`, `1g`, `10g`, `40g`, `auto`, `auto-100m`, `auto-100m-1g`, `100g`, `25g`, `10m`, `50g`, `200g`, `400g`, `2.5g`, `5g`, `auto-2.5g-5g-10g`, `auto-100m-1g-2.5g-5g`, `800g`	No
speed_group	Choice	`unknown`, `1000`, `10000`, `40000`, `auto`, `25000`	No
squelch	Boolean	`true`, `false`	No
logging_event_port_trunk_status	Boolean	`true`, `false`	No
uni_directional_ethernet	Choice	`disable`, `send-only`, `receive-only`	No
vrf	String		No
switchport	Class	`[switchport]`	No
ip	Class	`[ip]`	No
ipv6	Class	`[ipv6]`	No
channel_group	Integer	min: `1`, max: `4096`	No
channel_group_mode	Choice	`on`, `static`, `active`, `passive`, `mac-pin`	No
channel_group_force	Boolean	`true`, `false`	No
ospf	Class	`[ospf]`	No
ospfv3	Class	`[ospfv3]`	No
pim	Class	`[pim]`	No
isis	Class	`[isis]`	No
hsrp	Class	`[hsrp]`	No
service_policy_type_qos_input	String		No
service_policy_type_qos_input_statistics	Boolean	`true`, `false`	No
nd	Class	`[nd]`	No
subinterfaces	List	`[subinterfaces]`	No
spanning_tree	Class	`[spanning_tree]`	No

switchport (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
enabled	Boolean	`true`, `false`	No
mode	Choice	`access`, `trunk`, `fex-fabric`, `dot1q-tunnel`, `promiscuous`, `host`, `trunk-secondary`, `trunk-promiscuous`, `vntag`	No
access_vlan	Integer	min: `1`, max: `4094`	No
trunk_native_vlan	Integer	min: `1`, max: `4094`	No
trunk_allowed_vlans	Class	`[trunk_allowed_vlans]`	No
transparent_mode	Boolean	`true`, `false`	No
voice_cos	Integer	min: `-1`, max: `7`	No
voice_trust	Boolean	`true`, `false`	No
voice_vlan	Integer	min: `1`, max: `4092`	No
voice_vlan_type	Choice	`none`, `tagged`, `dot1p`, `untagged`	No

ip (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
address	IP		No
secondary_addresses	List	IP	No
forward	Boolean	`true`, `false`	No
drop_glean	Boolean	`true`, `false`	No
unnumbered	String		No
directed_broadcast	Boolean	`true`, `false`	No
directed_broadcast_acl	String		No
redirects	Boolean	`true`, `false`	No
unreachables	Boolean	`true`, `false`	No
port_unreachable	Boolean	`true`, `false`	No
verify_unicast_source_reachable_via	Choice	`disabled`, `strict`, `loose`, `loose-allow-default`, `strict-allow-vni-hosts`	No
access_group_in	String		No
access_group_out	String		No
dhcp_relay_information_trusted	Boolean	`true`, `false`	No
dhcp_relay_smart_relay	Boolean	`true`, `false`	No
dhcp_relay_subnet_broadcast	Boolean	`true`, `false`	No
dhcp_relay_information_option	Boolean	`true`, `false`	No
dhcp_relay_source_subnet	String		No
dhcp_relay_addresses	List	`[dhcp_relay_addresses]`	No

ipv6 (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
address_autoconfig	Boolean	`true`, `false`	No
nd_default_route	Boolean	`true`, `false`	No
forward	Boolean	`true`, `false`	No
link_local_use_bia	Boolean	`true`, `false`	No
address_use_link_local_only	Boolean	`true`, `false`	No
verify_unicast_source_reachable_via	Choice	`disabled`, `strict`, `loose`, `loose-allow-default`, `strict-allow-vni-hosts`	No
address_link_local	String		No
addresses	List	`[addresses]`	No
dhcp_smart_relay	Boolean	`true`, `false`	No
dhcp_relay_addresses	List	`[dhcp_relay_addresses]`	No

ospf (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
process	String		Yes
advertise_secondaries	Boolean	`true`, `false`	No
advertise_subnet	Boolean	`true`, `false`	No
area	String		No
bfd	Boolean	`true`, `false`	No
cost	Integer	min: `0`, max: `65535`	No
dead_interval	Integer	min: `0`, max: `65535`	No
hello_interval	Integer	min: `0`, max: `65535`	No
mtu_ignore	Boolean	`true`, `false`	No
network	Choice	`unspecified`, `p2p`, `bcast`	No
prefix_attribute_n_flag	Choice	`unspecified`, `clear`	No
passive_interface	Boolean	`true`, `false`	No
priority	Integer	min: `0`, max: `255`	No
retransmit_interval	Integer	min: `1`, max: `65535`	No
transmit_delay	Integer	min: `1`, max: `450`	No
authentication_key	String		No
message_digest_key_id	Integer	min: `0`, max: `255`	No
authentication_key_secure_mode	Boolean	`true`, `false`	No
authentication_key_chain	String		No
message_digest_key	String		No
message_digest_key_secure_mode	Boolean	`true`, `false`	No
authentication	Choice	`unspecified`, `simple`, `md5`, `none`	No

ospfv3 (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
process	String		Yes
advertise_secondaries	Boolean	`true`, `false`	No
area	String		No
bfd	Boolean	`true`, `false`	No
cost	Integer	min: `0`, max: `65535`	No
dead_interval	Integer	min: `0`, max: `65535`	No
hello_interval	Integer	min: `1`, max: `65535`	No
network	Choice	`none`, `p2p`, `bcast`	No
passive_interface	Boolean	`true`, `false`	No
priority	Integer	min: `0`, max: `255`	No
instance_id	Integer	min: `0`, max: `255`	No
mtu_ignore	Boolean	`true`, `false`	No
retransmit_interval	Integer	min: `1`, max: `65535`	No
transmit_delay	Integer	min: `1`, max: `450`	No

pim (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
bfd_instance	Boolean	`true`, `false`	No
dr_priority	Integer	min: `1`, max: `4294967295`	No
passive	Boolean	`true`, `false`	No
sparse_mode	Boolean	`true`, `false`	No
border	Boolean	`true`, `false`	No
dr_delay	Integer	min: `1`, max: `65535`	No
jp_policy	String		No
neighbor_policy_route_map	String		No
neighbor_policy_prefix_list	String		No
strict_rfc_compliant	Boolean	`true`, `false`	No

isis (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
instance_name	String		Yes
circuit_type	Choice	`l1`, `l2`, `l12`	No
ipv4	Boolean	`true`, `false`	No
ipv6	Boolean	`true`, `false`	No
network_point_to_point	Choice	`off`, `on`, `use-all-is-mac`	No
passive_interface	Choice	`l1`, `l2`, `l12`, `no-l1`, `no-l2`, `no-l12`, `inherit-def`	No
metric_level_1	Integer	min: `0`, max: `16777216`	No
metric_level_2	Integer	min: `0`, max: `16777216`	No
ipv6_metric_level_1	Integer	min: `0`, max: `16777216`	No
ipv6_metric_level_2	Integer	min: `0`, max: `16777216`	No
priority_level_1	Integer	min: `0`, max: `127`	No
priority_level_2	Integer	min: `0`, max: `127`	No
hello_interval	Integer	min: `1`, max: `65535`	No
hello_interval_level_1	Integer	min: `1`, max: `65535`	No
hello_interval_level_2	Integer	min: `1`, max: `65535`	No
hello_multiplier	Integer	min: `3`, max: `1000`	No
hello_multiplier_level_1	Integer	min: `3`, max: `1000`	No
hello_multiplier_level_2	Integer	min: `3`, max: `1000`	No
hello_padding	Choice	`always`, `transient`, `never`	No
authentication_check	Boolean	`true`, `false`	No
authentication_check_level_1	Boolean	`true`, `false`	No
authentication_check_level_2	Boolean	`true`, `false`	No
authentication_key_chain	String		No
authentication_key_chain_level_1	String		No
authentication_key_chain_level_2	String		No
authentication_type	Choice	`clear`, `md5`, `unknown`	No
authentication_type_level_1	Choice	`clear`, `md5`, `unknown`	No
authentication_type_level_2	Choice	`clear`, `md5`, `unknown`	No
mtu_check	Boolean	`true`, `false`	No
mtu_check_level_1	Boolean	`true`, `false`	No
mtu_check_level_2	Boolean	`true`, `false`	No
bfd	Boolean	`true`, `false`	No
ipv6_bfd	Boolean	`true`, `false`	No
csnp_interval_level_1	Integer	min: `1`, max: `65535`	No
csnp_interval_level_2	Integer	min: `1`, max: `65535`	No
lsp_interval	Integer	min: `10`, max: `65535`	No
retransmit_interval	Integer	min: `1`, max: `65535`	No
retransmit_throttle_interval	Integer	min: `20`, max: `65535`	No
mesh_group	Integer	min: `0`, max: `4294967295`	No
mesh_group_blocked	Boolean	`true`, `false`	No
n_flag_clear	Boolean	`true`, `false`	No
suppress_prefix	Boolean	`true`, `false`	No

hsrp (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
version	Integer	min: `1`, max: `2`	No
bfd	Boolean	`true`, `false`	No
use_bia	Boolean	`true`, `false`	No
use_bia_scope	Choice	`global`, `local`	No
delay_minimum	Integer	min: `0`, max: `10000`	No
delay_reload	Integer	min: `0`, max: `10000`	No
mac_refresh	Integer	min: `0`, max: `10000`	No
groups	List	`[groups]`	No

nd (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
ra_boot_file_url	String		No
suppress_ra	Boolean	`true`, `false`	No
suppress_ra_mtu	Boolean	`true`, `false`	No
managed_config_flag	Boolean	`true`, `false`	No
other_config_flag	Boolean	`true`, `false`	No
redirects	Boolean	`true`, `false`	No
dad_attempts	Integer	min: `0`, max: `15`	No
dad_ns_interval	Integer	min: `1000`, max: `6000`	No
delete_adjacency_on_mac_delete	Boolean	`true`, `false`	No
dns_search_list_suppress	Boolean	`true`, `false`	No
dns_suppress	Boolean	`true`, `false`	No
hop_limit	Integer	min: `0`, max: `255`	No
mac_extract	Choice	`none`, `nud-phase`, `exclude-nud-phase`	No
mtu	Integer	min: `1280`, max: `65535`	No
ns_interval	Integer	min: `1000`, max: `3600000`	No
ra_interval	Integer	min: `4`, max: `1800`	No
ra_interval_minimum	Integer	min: `3`, max: `1350`	No
ra_lifetime	Integer	min: `0`, max: `9000`	No
reachable_time	Integer	min: `0`, max: `3600000`	No
retrans_timer	Integer	min: `0`, max: `4294967295`	No
suppress_ra_route	Boolean	`true`, `false`	No
router_preference	Choice	`unspecified`, `low`, `medium`, `high`	No

subinterfaces (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
id	Integer		Yes
interface_groups	List	String	No
shutdown	Boolean	`true`, `false`	No
bandwidth	Integer	min: `0`, max: `3200000000`	No
delay	Integer	min: `1`, max: `16777215`	No
description	String		No
encapsulation	String		No
logging_event_port_link_status	Boolean	`true`, `false`	No
medium	Choice	`broadcast`, `p2p`	No
mtu	Integer	min: `576`, max: `9216`	No
mtu_inherit	Boolean	`true`, `false`	No
mac_address	String		No
mac_ipv6_extract	Boolean	`true`, `false`	No
snmp_trap_link_status	Boolean	`true`, `false`	No
vrf	String		No
hsrp	Class	`[hsrp]`	No

spanning_tree (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory
bpdufilter	Boolean	`true`, `false`	No
bpduguard	Boolean	`true`, `false`	No
cost	Integer	min: `0`, max: `200000000`	No
guard	Choice	`root`, `loop`, `none`	No
link_type	Choice	`auto`, `p2p`, `shared`	No
port_type	Choice	`edge`, `network`, `normal`	No
port_priority	Integer	min: `0`, max: `224`	No

trunk_allowed_vlans (nxos.devices.configuration.interfaces.ethernets.switchport)

Name	Type	Constraint	Mandatory	Default Value
ids	List	Integer[min: `1`, max: `4094`]	No
ranges	List	`[ranges]`	No

dhcp_relay_addresses (nxos.devices.configuration.interfaces.ethernets.ip)

Name	Type	Constraint	Mandatory	Default Value
address	String		Yes
vrf	String		No

addresses (nxos.devices.configuration.interfaces.ethernets.ipv6)

Name	Type	Constraint	Mandatory
address	String		Yes
type	Choice	`primary`, `secondary`	No
tag	Integer	min: `0`, max: `4294967295`	No
eui64	Boolean	`true`, `false`	No
route_preference	Integer	min: `0`, max: `255`	No

dhcp_relay_addresses (nxos.devices.configuration.interfaces.ethernets.ipv6)

Name	Type	Constraint	Mandatory	Default Value
address	String		Yes
vrf	String		No

groups (nxos.devices.configuration.interfaces.ethernets.hsrp)

Name	Type	Constraint	Mandatory
id	Integer	min: `0`, max: `4095`	Yes
address_family	Choice	`ipv4`, `ipv6`	Yes
authentication_md5_compatibility	Boolean	`true`, `false`	No
authentication_md5_key_chain	String		No
authentication_md5_key_string	String		No
authentication_md5_key_string_type	Choice	`unencrypted`, `hidden`	No
authentication_md5_timeout	Integer	min: `0`, max: `32767`	No
authentication_md5_type	Choice	`key-chain`, `key-string`	No
authentication_text	String		No
authentication_type	Choice	`simple`, `md5`	No
follow	String		No
forwarding_threshold_lower	Integer	min: `0`, max: `255`	No
timers_hello_interval	Integer	min: `250`, max: `254000`	No
timers_hold_interval	Integer	min: `750`, max: `255000`	No
ip	String		No
mac_address	String		No
name	String		No
preempt	Boolean	`true`, `false`	No
preempt_delay_minimum	Integer	min: `0`, max: `3600`	No
preempt_delay_reload	Integer	min: `0`, max: `3600`	No
preempt_delay_sync	Integer	min: `0`, max: `3600`	No
priority	Integer	min: `0`, max: `255`	No

ranges (nxos.devices.configuration.interfaces.ethernets.switchport.trunk_allowed_vlans)

Name	Type	Constraint	Mandatory	Default Value
from	Integer	min: `1`, max: `4094`	Yes
to	Integer	min: `1`, max: `4094`	Yes

Examples

Example 1: Fabric uplink as routed L3 interface with OSPF and PIM (unnumbered from Loopback0)

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/1
              description: "FABRIC: SPINE1 Eth1/1"
              switchport:
                enabled: false
              medium: p2p
              mtu: 9216
              ip:
                unnumbered: loopback0
              ospf:
                process: "1"
                area: 0.0.0.0
                network: p2p
              pim:
                sparse_mode: true

Example 2: Host-facing access port and trunk port for server connectivity

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/10
              description: "HOST: Web-Server-01 (access)"
              switchport:
                mode: access
                access_vlan: 101
              spanning_tree:
                port_type: edge
                bpduguard: true
            - id: 1/11
              description: "HOST: ESXi-Host-01 (trunk)"
              switchport:
                mode: trunk
                trunk_allowed_vlans:
                  ids:
                    - 1010
                    - 1020
                  ranges:
                    - from: 101
                      to: 102
              mtu: 9216
              speed: 25g
              spanning_tree:
                port_type: edge
                bpduguard: true

Example 3: vPC member interface with LACP and host port-channel to server

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/12
              description: "vPC: Host-PO10 member to Server-Rack-A"
              switchport:
                mode: trunk
                trunk_allowed_vlans:
                  ranges:
                    - from: 101
                      to: 102
              mtu: 9216
              channel_group: 10
              channel_group_mode: active
              shutdown: false

Example 4: Routed interface with dual-stack addressing, OSPF authentication, and QoS policy

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/48
              description: "DCI: External-Router Eth0/0"
              switchport:
                enabled: false
              medium: p2p
              mtu: 9216
              ip:
                address: 10.1.10.0/31
              ipv6:
                addresses:
                  - address: 2001:db8:10::1/127
                    type: primary
              speed: 100g
              ospf:
                process: "1"
                area: 0.0.0.0
                network: p2p
                authentication_key_chain: OSPF-UNDERLAY-AUTH
                authentication: none
              pim:
                sparse_mode: true
              service_policy_type_qos_input: PM-FABRIC-INGRESS