Interface Group

Interface groups provide a mechanism for applying consistent configurations to multiple interfaces across one or more NX-OS devices, enabling reusable interface configuration templates that promote standardization and reduce configuration complexity. Each interface group is identified by a name and contains a shared configuration set covering Layer 2/3 attributes, switching modes, VLANs, MTU, speed, duplex, and protocol sub-sections such as OSPF, PIM, IS-IS, HSRP, and spanning tree. Interfaces reference their interface groups by name, inheriting the group configuration as defaults that can be overridden by interface-specific settings for maximum flexibility.

Protocol Settings

The protocol sub-sections (ospf, ospfv3, isis, eigrp, pim, bfd, hsrp, nd, epbr, ptp, spanning_tree), the VRRP and VRRPv3 settings (vrrp_groups, vrrpv3_groups, vrrs_pathways, fhrp_delay_minimum, fhrp_delay_reload) and subinterfaces of an interface group use the same attributes as the corresponding interface sections, which are documented on the respective protocol pages: OSPF, OSPFv3, IS-IS, EIGRP, PIM, BFD, HSRP, VRRP, VRRPv3, ND, ePBR, Spanning Tree, PTP, and on the Subinterface page.

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory	Default Value
interface_groups	List	interface_groups	No

interface_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
configuration	Class	configuration	No

configuration (nxos.interface_groups)

Name	Type	Constraint	Mandatory
shutdown	Boolean	`true`, `false`	No
shutdown_lan	Boolean	`true`, `false`	No
autostate	Boolean	`true`, `false`	No
description	String		No
vrf	String		No
carrier_delay	Integer	min: `0`, max: `60000`	No
delay	Integer	min: `1`, max: `16777215`	No
bandwidth	Integer	min: `0`, max: `3200000000`	No
management	Boolean	`true`, `false`	No
load_interval_counter_1	Integer	min: `5`, max: `600`	No
load_interval_counter_2	Integer	min: `5`, max: `600`	No
load_interval_counter_3	Integer	min: `5`, max: `600`	No
medium	Choice	`broadcast`, `p2p`	No
mtu	Integer	min: `64`, max: `9216`	No
mtu_inherit	Boolean	`true`, `false`	No
fabric_forwarding_mode	Choice	`anycast-gateway`	No
fabric_forwarding_mode_anycast_gateway_proxy	Boolean	`true`, `false`	No
fabric_forwarding_description	String		No
negotiate_auto	Choice	`on`, `off`, `25000`	No
beacon	Boolean	`true`, `false`	No
buffer_boost	Boolean	`true`, `false`	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
switchport	Class	switchport	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
mac_ipv6_extract	Boolean	`true`, `false`	No
encapsulation	Integer	min: `1`, max: `4094`	No
mdix	Choice	`auto`, `mdi`, `mdi-x`	No
media_type	Choice	`none`, `10g-tx`	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
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
lacp_port_priority	Integer	min: `1`, max: `65535`	No
lacp_rate	Choice	`normal`, `fast`	No
lacp_min_links	Integer	min: `1`, max: `32`	No
lacp_max_bundle	Integer	min: `1`, max: `32`	No
lacp_suspend_individual	Boolean	`true`, `false`	No
lacp_graceful_convergence	Boolean	`true`, `false`	No
port_channel_hash_distribution	Choice	`none`, `adaptive`, `fixed`	No
lacp_mode_delay	Boolean	`true`, `false`	No
lacp_vpc_convergence	Boolean	`true`, `false`	No
port_channel_load_defer	Boolean	`true`, `false`	No
ip	Class	ip	No
ipv6	Class	ipv6	No
igmp	Class	igmp	No
mpls_ip_forwarding	Boolean	`true`, `false`	No
macsec_keychain	String		No
macsec_policy	String		No
macsec_fallback_keychain	String		No
vpc_id	Integer	min: `1`, max: `16384`	No
vpc_orphan_port_suspend	Boolean	`true`, `false`	No
service_policy_type_qos_input	String		No
service_policy_type_qos_input_statistics	Boolean	`true`, `false`	No
service_policy_type_queuing_output	String		No
service_policy_type_queuing_output_statistics	Boolean	`true`, `false`	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
vtp	Boolean	`true`, `false`	No
evpn_multisite_dci_tracking	Boolean	`true`, `false`	No
evpn_multisite_fabric_tracking	Boolean	`true`, `false`	No
evpn_multihoming_core_tracking	Boolean	`true`, `false`	No
ethernet_segment	Class	ethernet_segment	No
private_vlan_mapping	Class	private_vlan_mapping	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
power_inline	Choice	`auto`, `static`, `never`	No
power_inline_max	Integer	min: `4000`, max: `60000`	No
power_inline_default_consumption	Integer	min: `4000`, max: `30000`	No
power_inline_police_action	Choice	`errdisable`, `log`	No
power_inline_port_priority	Choice	`high`, `low`	No

configuration (nxos.interface_groups)

Name	Type	Constraint	Mandatory
shutdown	Boolean	`true`, `false`	No
shutdown_lan	Boolean	`true`, `false`	No
autostate	Boolean	`true`, `false`	No
description	String		No
vrf	String		No
carrier_delay	Integer	min: `0`, max: `60000`	No
delay	Integer	min: `1`, max: `16777215`	No
bandwidth	Integer	min: `0`, max: `3200000000`	No
management	Boolean	`true`, `false`	No
load_interval_counter_1	Integer	min: `60`, max: `600`	No
load_interval_counter_2	Integer	min: `60`, max: `600`	No
load_interval_counter_3	Integer	min: `60`, max: `600`	No
medium	Choice	`broadcast`, `p2p`	No
mtu	Integer	min: `64`, max: `9216`	No
mtu_inherit	Boolean	`true`, `false`	No
fabric_forwarding_mode	Choice	`anycast-gw`, `proxy-gw`	No
fabric_forwarding_description	String		No
negotiate_auto	Choice	`on`, `off`, `25000`	No
beacon	Boolean	`true`, `false`	No
buffer_boost	Boolean	`true`, `false`	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
switchport	Class	switchport	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
mac_ipv6_extract	Boolean	`true`, `false`	No
encapsulation	String		No
mdix	Choice	`auto`, `mdi`, `mdi-x`	No
media_type	Choice	`none`, `10g-tx`	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
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
lacp_min_links	Integer	min: `1`, max: `32`	No
lacp_max_bundle	Integer	min: `1`, max: `32`	No
lacp_suspend_individual	Boolean	`true`, `false`	No
lacp_graceful_convergence	Boolean	`true`, `false`	No
port_channel_hash_distribution	Choice	`none`, `adaptive`, `fixed`	No
lacp_mode_delay	Boolean	`true`, `false`	No
lacp_vpc_convergence	Boolean	`true`, `false`	No
port_channel_load_defer	Boolean	`true`, `false`	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
ptp	Class	ptp	No
vpc_id	Integer	min: `1`, max: `16384`	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

switchport (nxos.interface_groups.configuration)

Name	Type	Constraint	Mandatory
enabled	Boolean	`true`, `false`	No
mode	Choice	`access`, `trunk`, `fex-fabric`, `dot1q-tunnel`, `private-vlan-host`, `private-vlan-promiscuous`, `private-vlan-trunk-secondary`, `private-vlan-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
private_vlan	Class	private_vlan	No
vlan_mapping	Class	vlan_mapping	No

switchport (nxos.interface_groups.configuration)

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
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

ip (nxos.interface_groups.configuration)

Name	Type	Constraint	Mandatory
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
policy_route_map	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	IP		No
dhcp_relay_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
dhcp_relay_source_interface_id	Any	String or Integer[min: `0`]	No
dhcp_relay_addresses	List	dhcp_relay_addresses	No
dhcp_snooping_trust	Boolean	`true`, `false`	No
arp_inspection_trust	Boolean	`true`, `false`	No
verify_source_dhcp_snooping_vlan	Boolean	`true`, `false`	No

ip (nxos.interface_groups.configuration)

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

ipv6 (nxos.interface_groups.configuration)

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`, `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_source_interface_type	Choice	`ethernet`, `loopback`, `mgmt`, `port-channel`, `vlan`, `vni`	No
dhcp_relay_source_interface_id	Any	String or Integer[min: `0`]	No
dhcp_relay_addresses	List	dhcp_relay_addresses	No
redirects	Boolean	`true`, `false`	No
unreachables	Boolean	`true`, `false`	No
policy_route_map	String		No

ipv6 (nxos.interface_groups.configuration)

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`, `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

igmp (nxos.interface_groups.configuration)

Name	Type	Constraint	Mandatory
version	Choice	`2`, `3`	No
startup_query_interval	Integer	min: `0`, max: `18000`	No
startup_query_count	Integer	min: `0`, max: `10`	No
robustness_variable	Integer	min: `1`, max: `7`	No
querier_timeout	Integer	min: `1`, max: `65535`	No
query_max_response_time	Integer	min: `1`, max: `8387`	No
query_interval	Integer	min: `1`, max: `18000`	No
last_member_query_response_time	Integer	min: `1`, max: `25`	No
last_member_query_count	Integer	min: `1`, max: `5`	No
group_timeout	Integer	min: `3`, max: `65535`	No
allow_v3_asm	Boolean	`true`, `false`	No
state_limit	Integer	min: `0`, max: `4294967295`	No
state_limit_reserved_route_map	String		No
state_limit_reserved	Integer	min: `0`, max: `4294967295`	No
report_policy	String		No
report_policy_prefix_list	String		No
access_group	String		No
access_group_prefix_list	String		No
join_groups	List	join_groups	No
join_group_route_map	String		No
static_groups	List	static_groups	No
static_oifs	List	static_oifs	No
static_oif_route_map	String		No
report_link_local_groups	Boolean	`true`, `false`	No
immediate_leave	Boolean	`true`, `false`	No
suppress_v3_gsq	Boolean	`true`, `false`	No

storm_control (nxos.interface_groups.configuration)

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

ethernet_segment (nxos.interface_groups.configuration)

Name	Type	Constraint	Mandatory
vpc	Boolean	`true`, `false`	No
esi	String		No
esi_system_mac	Boolean	`true`, `false`	No
esi_system_mac_address	MAC		No
esi_system_mac_local_identifier	Integer	min: `0`, max: `16777215`	No
esi_tag	Integer	min: `0`, max: `65535`	No

private_vlan_mapping (nxos.interface_groups.configuration)

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

autostate_exclude_vlans (nxos.interface_groups.configuration.switchport)

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

autostate_exclude_vlans (nxos.interface_groups.configuration.switchport)

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

trunk_allowed_vlans (nxos.interface_groups.configuration.switchport)

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

trunk_allowed_vlans (nxos.interface_groups.configuration.switchport)

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

private_vlan (nxos.interface_groups.configuration.switchport)

Name	Type	Constraint	Mandatory
mapping_primary_vlan	Integer	min: `1`, max: `4094`	No
mapping_secondary_vlans	Class	mapping_secondary_vlans	No
host_association_primary_vlan	Integer	min: `1`, max: `4094`	No
host_association_secondary_vlan	Integer	min: `1`, max: `4094`	No
trunk_native_vlan	Integer	min: `1`, max: `4094`	No
trunk_allowed_vlans	Class	trunk_allowed_vlans	No
trunk_promiscuous_mappings	List	trunk_promiscuous_mappings	No
trunk_secondary_associations	List	trunk_secondary_associations	No

vlan_mapping (nxos.interface_groups.configuration.switchport)

Name	Type	Constraint	Mandatory
enable	Boolean	`true`, `false`	No
vlans	List	vlans	No
dot1q_tunnel	Integer	min: `1`, max: `4094`	No
dot1q_tunnel_vlans	Class	dot1q_tunnel_vlans	No
dot1q_tunnel_all	Boolean	`true`, `false`	No

secondary_addresses (nxos.interface_groups.configuration.ip)

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

dhcp_relay_addresses (nxos.interface_groups.configuration.ip)

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

addresses (nxos.interface_groups.configuration.ipv6)

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

dhcp_relay_addresses (nxos.interface_groups.configuration.ipv6)

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

join_groups (nxos.interface_groups.configuration.igmp)

Name	Type	Constraint	Mandatory	Default Value
group	IP		Yes
source	IP		No

static_groups (nxos.interface_groups.configuration.igmp)

Name	Type	Constraint	Mandatory	Default Value
group	IP		Yes
source	IP		No

static_oifs (nxos.interface_groups.configuration.igmp)

Name	Type	Constraint	Mandatory	Default Value
group	IP		Yes
source	IP		No

ranges (nxos.interface_groups.configuration.private_vlan_mapping)

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

mapping_secondary_vlans (nxos.interface_groups.configuration.switchport.private_vlan)

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

trunk_promiscuous_mappings (nxos.interface_groups.configuration.switchport.private_vlan)

Name	Type	Constraint	Mandatory	Default Value
primary_vlan	Integer	min: `1`, max: `4094`	Yes
secondary_vlans	Class	secondary_vlans	No

trunk_secondary_associations (nxos.interface_groups.configuration.switchport.private_vlan)

Name	Type	Constraint	Mandatory	Default Value
primary_vlan	Integer	min: `1`, max: `4094`	Yes
secondary_vlan	Integer	min: `1`, max: `4094`	No

vlans (nxos.interface_groups.configuration.switchport.vlan_mapping)

Name	Type	Constraint	Mandatory
vlan	Integer	min: `1`, max: `4094`	Yes
inner_vlan	Integer	min: `1`, max: `4094`	No
translated_vlan	Integer	min: `1`, max: `4094`	No
rx	Boolean	`true`, `false`	No

dot1q_tunnel_vlans (nxos.interface_groups.configuration.switchport.vlan_mapping)

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

secondary_vlans (nxos.interface_groups.configuration.switchport.private_vlan.trunk_promiscuous_mappings)

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

ospf (nxos.interface_groups.configuration)

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

ospfv3 (nxos.interface_groups.configuration)

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

pim (nxos.interface_groups.configuration)

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	String		No
neighbor_policy_prefix_list	String		No
strict_rfc_compliant	Boolean	`true`, `false`	No

isis (nxos.interface_groups.configuration)

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

hsrp (nxos.interface_groups.configuration)

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

bfd (nxos.interface_groups.configuration)

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

ptp (nxos.interface_groups.configuration)

Name	Type	Constraint	Mandatory
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.interface_groups.configuration)

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

subinterfaces (nxos.interface_groups.configuration)

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

spanning_tree (nxos.interface_groups.configuration)

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`, `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

groups (nxos.interface_groups.configuration.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	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

ucast_peers (nxos.interface_groups.configuration.ptp)

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

ranges (nxos.interface_groups.configuration.switchport.autostate_exclude_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 interface group with L3, OSPF, and PIM for spine-leaf underlay

nxos:
  interface_groups:
    - name: FABRIC_INTERFACE
      configuration:
        switchport:
          enabled: false
        medium: p2p
        ip:
          unnumbered: loopback0
        ospf:
          process: "1"
          area: 0.0.0.0
          network: point-to-point
        pim:
          sparse_mode: true

Example 2: Loopback interface group with OSPF and PIM for overlay anchor points

nxos:
  interface_groups:
    - name: LOOPBACK_INTERFACE
      configuration:
        ospf:
          process: "1"
          area: 0.0.0.0
          network: point-to-point
        pim:
          sparse_mode: true

Example 3: Host-facing access interface group for server connectivity

nxos:
  interface_groups:
    - name: SERVER_ACCESS
      configuration:
        shutdown: false
        switchport:
          mode: access
          access_vlan: 101
        mtu: 9216
        speed: 10g
        spanning_tree:
          port_type: edge

    - name: TRUNK_TO_HOST
      configuration:
        shutdown: false
        switchport:
          mode: trunk
          trunk_allowed_vlans:
            ids:
              - 1010
              - 1020
            ranges:
              - from: 101
                to: 102
          trunk_native_vlan: 1
        mtu: 9216

Examples

Example 1: Fabric uplink interface group with L3, OSPF, and PIM for spine-leaf underlay

nxos:
  interface_groups:
    - name: FABRIC_INTERFACE
      configuration:
        switchport: false
        medium: p2p
        ip_unnumbered: lo0
        ospf:
          process: "1"
          area: 0.0.0.0
          network: p2p
        pim:
          sparse_mode: true

Example 2: Loopback interface group with OSPF and PIM for overlay anchor points

nxos:
  interface_groups:
    - name: LOOPBACK_INTERFACE
      configuration:
        ospf:
          process: "1"
          area: 0.0.0.0
          network: p2p
        pim:
          sparse_mode: true

Example 3: Host-facing access interface group for server connectivity

nxos:
  interface_groups:
    - name: SERVER_ACCESS
      configuration:
        shutdown: false
        switchport_mode: access
        switchport_access_vlan: 101
        mtu: 9216
        speed: 10g
        spanning_tree:
          port_type: edge

    - name: TRUNK_TO_HOST
      configuration:
        shutdown: false
        switchport_mode: trunk
        switchport_trunk_allowed_vlans:
          ids:
            - 1010
            - 1020
          ranges:
            - from: 101
              to: 102
        mtu: 9216
        switchport_trunk_native_vlan: 1