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, ICMPv6 (redirects, unreachables), spanning tree, and QoS service policies, along with IPv4/IPv6 addressing, access group filtering, and interface group inheritance for standardized configuration.

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

Diagram

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No
templates	List	templates	No

devices (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

templates (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
interfaces	Class	interfaces	No

interfaces (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
ethernets	List	ethernets	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
id	String		Yes
interface_groups	List	String	No
shutdown	Boolean	true, false	No
shutdown_lan	Boolean	true, false	No
negotiate_auto	Choice	on, off, 25000	No
bandwidth	Integer	min: 0, max: 3200000000	No
beacon	Boolean	true, false	No
buffer_boost	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
flowcontrol_receive	Boolean	true, false	No
flowcontrol_send	Boolean	true, false	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_error_disable	Boolean	true, false	No
link_flap_error_disable_count	Integer	min: 2, max: 30	No
link_flap_error_disable_interval	Integer	min: 5, max: 420	No
logging_event_port_link_status	Boolean	true, false	No
link_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	MAC		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, 25000, 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
bfd	Class	bfd	No
ptp	Class	ptp	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
storm_control	Class	storm_control	No
cdp	Boolean	true, false	No
lldp_receive	Boolean	true, false	No
lldp_transmit	Boolean	true, false	No
lldp_tlv_set_management_address	IP		No
lldp_tlv_set_management_address_ipv6	IP		No
lldp_tlv_set_vlan	Integer	min: 0, max: 4094	No
lldp_dcbx_version	Choice	auto, CEE, IEEE	No
udld	Boolean	true, false	No
udld_aggressive	Boolean	true, false	No
evpn_multisite_dci_tracking	Boolean	true, false	No
evpn_multisite_fabric_tracking	Boolean	true, false	No
ttag	Boolean	true, false	No
ttag_inner	Boolean	true, false	No
ttag_marker	Boolean	true, false	No
ttag_strip	Boolean	true, false	No
port_type_fabric	Boolean	true, false	No
priority_flow_control_mode	Choice	auto, on, off	No
priority_flow_control_send_tlv	Boolean	true, false	No
priority_flow_control_watch_dog_interval	Boolean	true, false	No
priority_flow_control_watch_dog_disable_action	Boolean	true, false	No
priority_flow_control_watch_dog_interface_multiplier	Integer	min: 0, max: 40	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
id	String		Yes
interface_groups	List	String	No
shutdown	Boolean	true, false	No
shutdown_lan	Boolean	true, false	No
negotiate_auto	Choice	on, off, 25g	No
bandwidth	Integer	min: 0, max: 3200000000	No
beacon	Boolean	true, false	No
buffer_boost	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
flowcontrol_receive	Boolean	true, false	No
flowcontrol_send	Boolean	true, false	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
bfd	Class	bfd	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
storm_control	Class	storm_control	No
cdp	Boolean	true, false	No
lldp_receive	Boolean	true, false	No
lldp_transmit	Boolean	true, false	No
lldp_tlv_set_management_address_v4	String		No
lldp_tlv_set_management_address_v6	String		No
lldp_tlv_set_vlan	Integer	min: 0, max: 4094	No
lldp_dcbx_version	Choice	auto, CEE, IEEE	No
udld	Boolean	true, false	No
udld_aggressive	Boolean	true, false	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
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
autostate_exclude_vlans	Class	autostate_exclude_vlans	No
block	List	Choice[unicast, multicast]	No
isolated	Boolean	true, false	No
mac_learning	Boolean	true, false	No
trunk_native_vlan	Integer	min: 1, max: 4094	No
trunk_allowed_vlans	Class	trunk_allowed_vlans	No
monitor	Boolean	true, false	No
priority_extend_cos	Integer	min: -1, max: 7	No
priority_extend_trust	Boolean	true, false	No
voice_vlan	Integer	min: 1, max: 4092	No
voice_vlan_type	Choice	none, tagged, dot1p, untagged	No

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

Name	Type	Constraint	Mandatory	Default Value
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
autostate_exclude_vlans	Class	autostate_exclude_vlans	No
block	List	Choice[unicast, multicast]	No
isolated	Boolean	true, false	No
mac_learning	Boolean	true, false	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

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
address	IP		No
tag	Integer	min: 0, max: 4294967295	No
secondary_addresses	List	secondary_addresses	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, rx, any, any-allow-default, rx-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

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

Name	Type	Constraint	Mandatory	Default Value
address	IP		No
tag	Integer	min: 0, max: 4294967295	No
secondary_addresses	List	secondary_addresses	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

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
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, rx, any, any-allow-default, rx-allow-vni-hosts	No
address_link_local	IP		No
addresses	List	addresses	No
dhcp_smart_relay	Boolean	true, false	No
dhcp_relay_addresses	List	dhcp_relay_addresses	No
redirects	Boolean	true, false	No
unreachables	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
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
redirects	Boolean	true, false	No
unreachables	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
process	String		Yes
advertise_secondaries	Boolean	true, false	No
advertise_subnet	Boolean	true, false	No
area	Any	IP or Integer[min: 0, max: 4294967295]	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	point-to-point, broadcast	No
prefix_attributes_n_flag_clear	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	simple, md5, none	No

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
process	String		Yes
advertise_secondaries	Boolean	true, false	No
area	Any	IP or Integer[min: 0, max: 4294967295]	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

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
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	String		No
neighbor_policy_prefix_list	String		No
strict_rfc_compliant	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
instance_name	String		Yes
circuit_type	Choice	level-1, level-2, level-1-2	No
ipv4	Boolean	true, false	No
ipv6	Boolean	true, false	No
network_point_to_point	Boolean	true, false	No
passive_interface	Choice	level-1, level-2, level-1-2, no-level-1, no-level-2, no-level-1-2	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
prefix_attributes_n_flag_clear	Boolean	true, false	No
suppressed	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
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

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

Name	Type	Constraint	Mandatory	Default Value
interval	Integer	min: 0, max: 999	No
min_rx	Integer	min: 0, max: 999	No
multiplier	Integer	min: 0, max: 50	No
echo	Boolean	true, false	No
echo_rx_interval	Integer	min: 0, max: 999	No
optimize_subinterface	Boolean	true, false	No
per_link	Boolean	true, false	No
source_ip	IP		No
vpc_watch	Boolean	true, false	No
track_member_link	Boolean	true, false	No
authentication_type	Choice	none, keyed-sha1, meticulous-keyed-sha1	No
authentication_key_id	Integer	min: 1, max: 255	No
authentication_key	String		No
authentication_interop	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
interval	Integer	min: 0, max: 999	No
min_rx	Integer	min: 0, max: 999	No
multiplier	Integer	min: 0, max: 50	No
echo	Boolean	true, false	No
echo_rx_interval	Integer	min: 0, max: 999	No
optimize_subinterface	Boolean	true, false	No
per_link	Boolean	true, false	No
source_ip	String		No
vpc_watch	Boolean	true, false	No
track_member_link	Boolean	true, false	No
authentication_type	Choice	none, sha1, met-sha1	No
authentication_key_id	Integer	min: 1, max: 255	No
authentication_key	String		No
authentication_interop	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
admin_state	Boolean	true, false	No
announce_interval	Integer	min: -3, max: 4	No
announce_interval_profile	Choice	none, aes67, smpte-2059-2	No
announce_timeout	Integer	min: 2, max: 10	No
announce_timeout_profile	Choice	none, aes67, smpte-2059-2	No
sync_interval	Integer	min: -7, max: 1	No
sync_interval_profile	Choice	none, aes67, smpte-2059-2	No
delay_request_minimum_interval	Integer	min: -4, max: 6	No
delay_request_minimum_interval_profile	Choice	none, aes67, smpte-2059-2	No
transmission	Choice	multicast, unicast	No
transport	Choice	ipv4, ipv6, ethernet	No
role	Choice	master, slave, dynamic	No
cost	Integer	min: 0, max: 255	No
vlan	Integer	min: 1, max: 4094	No
domain	Integer	min: 0, max: 127	No
profile_override	Boolean	true, false	No
destination_mac	Choice	forwardable, non-forwardable	No
receive_no_match	Choice	accept, drop, follow-rx	No
transmission_unicast_negotiation_schema	String		No
neighbor_propagation_delay_threshold	Integer	min: 5, max: 2000000	No
asymmetric_delay_value	Integer	min: 0, max: 512000000	No
asymmetric_delay_direction	Choice	none, forward-path, reverse-path	No
ucast_source	IP		No
ucast_source_ipv6	IP		No
ucast_source_vrf	String		No
ucast_source_vrf_ipv6	String		No
ipv6_multicast_scope_tx	Integer	min: 0, max: 65535	No
ipv6_multicast_scope_rx	Integer	min: 0, max: 65535	No
ucast_peers	List	ucast_peers	No

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

Name	Type	Constraint	Mandatory	Default Value
ra_bootfile_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
dadns_interval	Integer	min: 1000, max: 6000	No
delete_adj_on_mac_delete	Boolean	true, false	No
ra_dns_search_list_suppress	Boolean	true, false	No
ra_dns_server_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
ra_route_suppress	Boolean	true, false	No
router_preference	Choice	low, medium, high	No

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
id	Integer	min: 1, max: 4093	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
mac_address	MAC		No
mac_address_ipv6_extract	Boolean	true, false	No
snmp_trap_link_status	Boolean	true, false	No
vrf	String		No
ip	Class	ip	No
ipv6	Class	ipv6	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
hsrp	Class	hsrp	No
bfd	Class	bfd	No
nd	Class	nd	No

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

Name	Type	Constraint	Mandatory	Default Value
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
ip	Class	ip	No
ipv6	Class	ipv6	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
hsrp	Class	hsrp	No
bfd	Class	bfd	No
nd	Class	nd	No

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

Name	Type	Constraint	Mandatory	Default Value
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	Default Value
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, point-to-point, shared	No
port_type	Choice	edge, network, normal	No
port_priority	Integer	min: 0, max: 224	No
mst_pre_standard	Boolean	true, false	No
mst_simulate_pvst	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
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
mst_pre_standard	Boolean	true, false	No
mst_simulate_pvst	Boolean	true, false	No

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

Name	Type	Constraint	Mandatory	Default Value
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

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

Name	Type	Constraint	Mandatory	Default Value
action	List	Choice[none, shutdown, trap]	No
broadcast_level	List	Number	No
broadcast_pps	Integer	min: 0, max: 4294967295	No
multicast_level	List	Number	No
multicast_pps	Integer	min: 0, max: 4294967295	No
unicast_level	List	Number	No
unicast_pps	Integer	min: 0, max: 4294967295	No

autostate_exclude_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

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

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

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

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
tag	Integer	min: 0, max: 4294967295	No

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

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
vrf	String		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	Default Value
address	IP		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

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

Name	Type	Constraint	Mandatory	Default Value
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	IP		Yes
vrf	String		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	Default Value
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	Integer	min: 250, max: 254000	No
timers_hold	Integer	min: 750, max: 255000	No
ip	IP		No
mac_address	MAC		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

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

Name	Type	Constraint	Mandatory	Default Value
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

ucast_peers (nxos.devices.configuration.interfaces.ethernets.ptp)

Name	Type	Constraint	Mandatory	Default Value
ip	IP		Yes
transmission_unicast_negotiation_schema	String		No

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

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

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

Example 5: Access port with storm control, flow control, and switchport isolation

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/20
              description: "HOST: IP-Phone-01 + PC"
              switchport:
                mode: access
                access_vlan: 101
                isolated: true
                mac_learning: true
                voice_vlan: 201
                voice_vlan_type: tagged
                priority_extend_trust: true
              flowcontrol_receive: true
              flowcontrol_send: false
              storm_control:
                action:
                  - shutdown
                broadcast_level:
                  - 50.0
                multicast_level:
                  - 50.0
              spanning_tree:
                port_type: edge
                bpduguard: true

Example 6: Routed interface with subinterfaces using dot1q encapsulation and IP addressing

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/49
              description: "EXTERNAL: Firewall Eth1"
              switchport:
                enabled: false
              subinterfaces:
                - id: 100
                  description: "VRF-A Transit"
                  encapsulation: "100"
                  vrf: VRF-A
                  ip:
                    address: 10.100.0.1/30
                  ipv6:
                    addresses:
                      - address: 2001:db8:100::1/126
                        type: primary
                  ospf:
                    process: "1"
                    area: 0.0.0.0
                    network: p2p
                - id: 200
                  description: "VRF-B Transit"
                  encapsulation: "200"
                  vrf: VRF-B
                  ip:
                    address: 10.200.0.1/30

Example 7: Interface with CDP, LLDP, and UDLD configuration

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/25
              description: "HOST: Server-02 with discovery protocols"
              switchport:
                mode: trunk
                trunk_allowed_vlans:
                  ids:
                    - 100
                    - 200
              cdp: false
              lldp_receive: true
              lldp_transmit: true
              lldp_tlv_set_management_address: 10.1.1.1
              lldp_tlv_set_vlan: 100
              lldp_dcbx_version: IEEE
              udld: true
              udld_aggressive: true
              spanning_tree:
                port_type: edge
                bpduguard: true

Example 9: Routed interface with IP address tags and secondary addresses

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/30
              description: "L3: Peering with tag"
              switchport:
                enabled: false
              ip:
                address: 10.1.50.1/24
                tag: 100
                secondary_addresses:
                  - address: 10.1.51.1/24
                    tag: 200
                  - address: 10.1.52.1/24

Example 10: DCI and fabric uplinks with EVPN multisite interface tracking

nxos:
  devices:
    - name: BGW1
      configuration:
        interfaces:
          ethernets:
            - id: 1/49
              description: "DCI: Remote-Site Eth1/49"
              switchport:
                enabled: false
              evpn_multisite_dci_tracking: true
            - id: 1/50
              description: "FABRIC: Spine1 Eth1/1"
              switchport:
                enabled: false
              evpn_multisite_fabric_tracking: true

Example 11: PTP ttag interface configuration for latency measurement

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/1
              description: "FABRIC: SPINE1 with ttag"
              switchport:
                enabled: false
              ttag: true
              ttag_marker: true
            - id: 1/2
              description: "FABRIC: SPINE2 with ttag strip"
              switchport:
                enabled: false
              ttag: true
              ttag_strip: true

Example 12: Fabric-facing interface with port-type fabric designation

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/49
              description: "FABRIC: Spine1 Eth1/1"
              switchport:
                enabled: false
              mtu: 9216
              port_type_fabric: true

Example 13: Ethernet interface with Priority Flow Control enabled for lossless traffic

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/31
              description: "STORAGE: NetApp-01 (PFC enabled)"
              switchport:
                mode: trunk
                trunk_allowed_vlans:
                  ids:
                    - 300
              mtu: 9216
              priority_flow_control_mode: "on"
              priority_flow_control_send_tlv: true
              priority_flow_control_watch_dog_interval: true
              priority_flow_control_watch_dog_interface_multiplier: 5

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

Example 5: Access port with storm control, flow control, and switchport isolation

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/20
              description: "HOST: IP-Phone-01 + PC"
              switchport:
                mode: access
                access_vlan: 101
                isolated: true
                mac_learning: true
                voice_vlan: 201
                voice_vlan_type: tagged
                voice_trust: true
              flowcontrol_receive: true
              flowcontrol_send: false
              storm_control:
                action:
                  - shutdown
                broadcast_level:
                  - 50.0
                multicast_level:
                  - 50.0
              spanning_tree:
                port_type: edge
                bpduguard: true

Example 6: Routed interface with subinterfaces using dot1q encapsulation and IP addressing

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/49
              description: "EXTERNAL: Firewall Eth1"
              switchport:
                enabled: false
              subinterfaces:
                - id: 100
                  description: "VRF-A Transit"
                  encapsulation: "100"
                  vrf: VRF-A
                  ip:
                    address: 10.100.0.1/30
                  ipv6:
                    addresses:
                      - address: 2001:db8:100::1/126
                        type: primary
                  ospf:
                    process: "1"
                    area: 0.0.0.0
                    network: p2p
                - id: 200
                  description: "VRF-B Transit"
                  encapsulation: "200"
                  vrf: VRF-B
                  ip:
                    address: 10.200.0.1/30

Example 7: Interface with CDP, LLDP, and UDLD configuration

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/25
              description: "HOST: Server-02 with discovery protocols"
              switchport:
                mode: trunk
                trunk_allowed_vlans:
                  ids:
                    - 100
                    - 200
              cdp: false
              lldp_receive: true
              lldp_transmit: true
              lldp_tlv_set_management_address_v4: 10.1.1.1
              lldp_tlv_set_vlan: 100
              lldp_dcbx_version: IEEE
              udld: true
              udld_aggressive: true
              spanning_tree:
                port_type: edge
                bpduguard: true

Example 9: Routed interface with IP address tags and secondary addresses

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          ethernets:
            - id: 1/30
              description: "L3: Peering with tag"
              switchport:
                enabled: false
              ip:
                address: 10.1.50.1/24
                tag: 100
                secondary_addresses:
                  - address: 10.1.51.1/24
                    tag: 200
                  - address: 10.1.52.1/24

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