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.

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
autostate	Boolean	`true`, `false`	No
description	String		No
vrf	String		No
ip_address	IP		No
ip_secondary_addresses	List	IP	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
ip_forward	Boolean	`true`, `false`	No
ip_drop_glean	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
switchport_access_vlan	Integer	min: `1`, max: `4094`	No
negotiate_auto	Choice	`on`, `off`, `25g`	No
beacon	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
itu_channel	Integer	min: `1`, max: `96`	No
switchport	Boolean	`true`, `false`	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
mac_ipv6_extract	Boolean	`true`, `false`	No
encapsulation	String		No
mdix	Choice	`auto`, `mdi`, `mdi-x`	No
media_type	Choice	`none`, `10g-tx`	No
switchport_mode	Choice	`access`, `trunk`, `fex-fabric`, `dot1q-tunnel`, `promiscuous`, `host`, `trunk-secondary`, `trunk-promiscuous`, `vntag`	No
switchport_trunk_native_vlan	Integer	min: `1`, max: `4094`	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
switchport_transparent_mode	Boolean	`true`, `false`	No
logging_event_port_trunk_status	Boolean	`true`, `false`	No
switchport_trunk_allowed_vlans	String		No
uni_directional_ethernet	Choice	`disable`, `send-only`, `receive-only`	No
switchport_voice_cos	Integer	min: `-1`, max: `7`	No
switchport_voice_trust	Boolean	`true`, `false`	No
switchport_voice_vlan	Integer	min: `1`, max: `4092`	No
switchport_voice_vlan_type	Choice	`none`, `tagged`, `dot1p`, `untagged`	No
ip_unnumbered	String		No
ip_verify_unicast_source_reachable_via	Choice	`disabled`, `strict`, `loose`, `loose-allow-default`, `strict-allow-vni-hosts`	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_directed_broadcast	Boolean	`true`, `false`	No
ip_directed_broadcast_acl	String		No
ip_redirects	Boolean	`true`, `false`	No
ip_unreachables	Boolean	`true`, `false`	No
ip_port_unreachable	Boolean	`true`, `false`	No
ospf	Class	`[ospf]`	No
ospfv3	Class	`[ospfv3]`	No
pim	Class	`[pim]`	No
isis	Class	`[isis]`	No
hsrp	Class	`[hsrp]`	No
ipv6_address_autoconfig	Boolean	`true`, `false`	No
ipv6_nd_default_route	Boolean	`true`, `false`	No
ipv6_forward	Boolean	`true`, `false`	No
ipv6_link_local_use_bia	Boolean	`true`, `false`	No
ipv6_address_use_link_local_only	Boolean	`true`, `false`	No
ipv6_verify_unicast_source_reachable_via	Choice	`disabled`, `strict`, `loose`, `loose-allow-default`, `strict-allow-vni-hosts`	No
ipv6_address_link_local	String		No
ipv6_addresses	List	`[ipv6_addresses]`	No
vpc_id	Integer	min: `1`, max: `16384`	No
ip_dhcp_relay	Class	`[ip_dhcp_relay]`	No
ipv6_dhcp_smart_relay	Boolean	`true`, `false`	No
ipv6_dhcp_relay_addresses	List	`[ipv6_dhcp_relay_addresses]`	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
ip_access_group_in	String		No
ip_access_group_out	String		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	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.interface_groups.configuration)

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

pim (nxos.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_route_map	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	`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.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

ipv6_addresses (nxos.interface_groups.configuration)

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

ip_dhcp_relay (nxos.interface_groups.configuration)

Name	Type	Constraint	Mandatory
information_trusted	Boolean	`true`, `false`	No
smart_relay	Boolean	`true`, `false`	No
subnet_broadcast	Boolean	`true`, `false`	No
information_option	Boolean	`true`, `false`	No
source_subnet	String		No
addresses	List	`[addresses]`	No

ipv6_dhcp_relay_addresses (nxos.interface_groups.configuration)

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

nd (nxos.interface_groups.configuration)

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

subinterfaces (nxos.interface_groups.configuration)

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

spanning_tree (nxos.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`, `p2p`, `shared`	No
port_type	Choice	`edge`, `network`, `normal`	No
port_priority	Integer	min: `0`, max: `224`	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_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

addresses (nxos.interface_groups.configuration.ip_dhcp_relay)

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

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: "101-102,1010,1020"
        mtu: 9216
        switchport_trunk_native_vlan: 1