Interface Group

Interface groups provide a powerful mechanism for applying consistent configurations to multiple interfaces across one or more devices. They enable you to define reusable interface configuration templates that can be applied to interfaces with similar roles or requirements, promoting standardization and reducing configuration complexity.

Interface groups are particularly valuable for:

• Role-based interface configuration: Standardizing configurations for server ports, uplinks, access ports, etc.
• Service deployment: Applying consistent security policies, QoS settings, or VLAN configurations
• Operational consistency: Ensuring uniform interface behaviors across your network infrastructure
• Configuration maintenance: Centralizing interface policies for easier updates and troubleshooting

Interface groups work by:

1. Defining a named configuration template with interface-specific settings
2. Referencing the interface group from individual interfaces via the interface_groups attribute
3. Supporting variables for dynamic configuration based on device or group context
4. Allowing multiple interface groups to be applied to a single interface (configurations are merged)

This approach separates interface policy definition from individual interface declarations, making your network configurations more modular and maintainable.

Diagram

Classes

iosxr

Name	Type	Constraint	Mandatory	Default Value
interface_groups	List	[interface_groups]	No

interface_groups (iosxr)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
variables	Map		No
configuration	Class	[configuration]	No

configuration (iosxr.interface_groups)

Name	Type	Constraint	Mandatory	Default Value
arp_cache_limit	Integer	min: 0, max: 127999	No
arp_gratuitous_ignore	Boolean	true, false	No
arp_learning	Choice	disable, local	No
arp_timeout	Integer	min: 30, max: 2144448000	No
bandwidth	Integer	min: 0, max: 9223372036854775807	No
bundle_id	Integer	min: 1, max: 65535	No
bundle_mode	Choice	active, inherit, on, passive	No
bundle_port_priority	Integer	min: 1, max: 65535	No
carrier_delay_down	Integer	min: 0, max: 2147483647	No
carrier_delay_up	Integer	min: 0, max: 2147483647	No
cdp	Boolean	true, false	No
dampening	Boolean	true, false	No
dampening_decay_half_life	Integer	min: 1, max: 45	No
dampening_max_suppress_time	Integer	min: 1, max: 255	No
dampening_restart_penalty	Integer	min: 0, max: 20000	No
dampening_reuse_threshold	Integer	min: 1, max: 20000	No
dampening_suppress_threshold	Integer	min: 1, max: 20000	No
description	String		No
duplex	Choice	full, half	No
encapsulation_dot1q_vlan	Integer	min: 1, max: 4094	No
encapsulation_dot1q_second_dot1q	Integer	min: 1, max: 4094	No
ethernet_cfm	Class	[ethernet_cfm]	No
fec	Choice	base-r, none, standard	No
flow_control	Choice	bidirectional, egress, ingress	No
flow_monitors	Class	[flow_monitors]	No
frequency_synchronization	Class	[frequency_synchronization]	No
ipv4	Class	[ipv4]	No
ipv6	Class	[ipv6]	No
l2transport	Class	[l2transport]	No
lacp_period	Any	Integer[min: 2, max: 30000] or Choice[short] or String[Regex: ^.*[\$\%]\{.*$]	No
lldp	Boolean	true, false	No
lldp_receive_disable	Boolean	true, false	No
lldp_tagged	Boolean	true, false	No
lldp_transmit_disable	Boolean	true, false	No
load_interval	Integer		No
logging_events_link_status	Boolean	true, false	No
mac_address	String		No
macsec_eap_policy	String		No
macsec_fallback_psk_keychain	String		No
macsec_policy	String		No
macsec_psk_keychain	String		No
monitor_sessions	List	[monitor_sessions]	No
mpls_mtu	Integer	min: 68, max: 65535	No
mtu	Integer	min: 64, max: 65535	No
multipoint	Boolean	true, false	No
negotiation_auto	Boolean	true, false	No
negotiation_auto_allow_overrides	Boolean	true, false	No
point_to_point	Boolean	true, false	No
proxy_arp	Boolean	true, false	No
ptp	Class	[ptp]	No
rewrite_ingress_tag_pop_one	Boolean	true, false	No
rewrite_ingress_tag_pop_two	Boolean	true, false	No
speed	Choice	10, 100, 1000	No
service_policy_input	List	[service_policy_input]	No
service_policy_output	List	[service_policy_output]	No
shutdown	Boolean	true, false	No
subinterfaces	List	[subinterfaces]	No
vrf	String		No

ethernet_cfm (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
ais_transmission_up_cos	Integer	min: 0, max: 7	No
ais_transmission_up_interval	Choice	1s, 1m	No
bandwidth_notifications	Class	[bandwidth_notifications]	No
mep_domains	List	[mep_domains]	No

flow_monitors (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
ipv4	List	[ipv4]	No
ipv6	List	[ipv6]	No

frequency_synchronization (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
priority	Integer	min: 1, max: 254	No
quality_receive	Class	[quality_receive]	No
quality_transmit	Class	[quality_transmit]	No
selection_input	Boolean	true, false	No
ssm_disable	Boolean	true, false	No
time_of_day_priority	Integer	min: 1, max: 254	No
wait_to_restore	Integer	min: 0, max: 12	No

ipv4 (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
access_group_egress	Class	[access_group_egress]	No
access_group_ingress	Class	[access_group_ingress]	No
address	IP		No
mask	IP		No
algorithm	Integer	min: 128, max: 255	No
forwarding_enable	Boolean	true, false	No
helper_addresses	List	[helper_addresses]	No
mask_reply	Boolean	true, false	No
mtu	Integer	min: 68, max: 65535	No
point_to_point	Boolean	true, false	No
redirects	Boolean	true, false	No
route_tag	Integer	min: 1, max: 4294967295	No
secondaries	List	[secondaries]	No
tcp_mss_adjust	Boolean	true, false	No
ttl_propagate_disable	Boolean	true, false	No
unnumbered	String		No
unreachables_disable	Boolean	true, false	No
verify_unicast_source_reachable_via_allow_default	Boolean	true, false	No
verify_unicast_source_reachable_via_allow_self_ping	Boolean	true, false	No
verify_unicast_source_reachable_via	Choice	any, rx	No

ipv6 (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
access_group_egress	Class	[access_group_egress]	No
access_group_ingress	Class	[access_group_ingress]	No
addresses	List	[addresses]	No
autoconfig	Boolean	true, false	No
dhcp	Boolean	true, false	No
enable	Boolean	true, false	No
eui64_addresses	List	[eui64_addresses]	No
link_local_address	IP		No
link_local_route_tag	Integer	min: 1, max: 4294967295	No
link_local_zone	String		No
mtu	Integer	min: 1280, max: 65535	No
nd_cache_limit	Integer	min: 0, max: 128000	No
nd_dad_attempts	Integer	min: 0, max: 600	No
nd_managed_config_flag	Boolean	true, false	No
nd_ns_interval	Integer	min: 1000, max: 4294967295	No
nd_other_config_flag	Boolean	true, false	No
nd_prefix_default_no_adv	Boolean	true, false	No
nd_prefix_default_no_autoconfig	Boolean	true, false	No
nd_ra_interval_max	Integer	min: 4, max: 1800	No
nd_ra_interval_min	Integer	min: 3, max: 1800	No
nd_ra_lifetime	Integer	min: 0, max: 9000	No
nd_reachable_time	Integer	min: 0, max: 3600000	No
nd_redirects	Boolean	true, false	No
nd_suppress_ra	Boolean	true, false	No
nd_unicast_ra	Boolean	true, false	No
tcp_mss_adjust	Boolean	true, false	No
ttl_propagate_disable	Boolean	true, false	No
unreachables_disable	Boolean	true, false	No
verify_unicast_source_reachable_via_allow_default	Boolean	true, false	No
verify_unicast_source_reachable_via_allow_self_ping	Boolean	true, false	No
verify_unicast_source_reachable_via	Choice	any, rx	No

l2transport (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
enable	Boolean	true, false	No
encapsulation_dot1q_second_dot1q	Integer	min: 1, max: 4094	No
encapsulation_dot1q_vlan	Integer	min: 1, max: 4094	No

monitor_sessions (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
direction	Choice	rx-only, tx-only	No
ipv4_acl	String		No
ipv6_acl	String		No
mirror_first	Integer	min: 1, max: 10000	No
mirror_interval	Choice	128, 16, 16K, 1K, 2, 256, 2K, 32, 4, 4K, 512, 64, 8, 8K	No
port_level	Boolean	true, false	No
type	Choice	ethernet, ipv4, ipv6, mpls-ipv4, mpls-ipv6	No

ptp (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
enable	Boolean	true, false	No
announce_frequency	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
announce_grant_duration	Integer	min: 60, max: 1000	No
announce_interval	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
announce_timeout	Integer	min: 2, max: 10	No
clock_operation	Choice	one-step, two-step	No
cos	Integer	min: 0, max: 7	No
cos_event	Integer	min: 0, max: 7	No
cos_general	Integer	min: 0, max: 7	No
delay_asymmetry_unit	Choice	nanoseconds, microseconds, milliseconds	No
delay_asymmetry_value	Integer	min: -500000000, max: 500000000	No
delay_request_frequency	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
delay_request_interval	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
delay_response_grant_duration	Integer	min: 60, max: 1000	No
delay_response_timeout	Integer	min: 100, max: 100000	No
dscp	Integer	min: 0, max: 63	No
dscp_event	Integer	min: 0, max: 63	No
dscp_general	Integer	min: 0, max: 63	No
interop	Class	[interop]	No
ipv4_ttl	Integer	min: 1, max: 255	No
ipv6_hop_limit	Integer	min: 1, max: 255	No
local_priority	Integer	min: 1, max: 255	No
masters	List	[masters]	No
multicast	Choice	enable, disable, mixed	No
multicast_target_address	Choice	01-1B-19-00-00-00, 01-80-C2-00-00-0E	No
port_state	Choice	any, master-only, slave-only	No
profile	String		No
slaves	List	[slaves]	No
source_ipv4_address	Any	IP or Choice[disable] or String[Regex: ^.*[\$\%]\{.*$]	No
source_ipv6_address	Any	IP or Choice[disable] or String[Regex: ^.*[\$\%]\{.*$]	No
sync_frequency	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
sync_grant_duration	Integer	min: 60, max: 1000	No
sync_interval	Choice	1, 2, 4, 8, 16, 32, 64, 128	No
sync_timeout	Integer	min: 100, max: 100000	No
transport	Choice	ethernet, ipv4, ipv6	No
unicast_grant_invalid_request	Choice	deny, reduce	No

service_policy_input (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
name	String		No

subinterfaces (iosxr.interface_groups.configuration)

Name	Type	Constraint	Mandatory	Default Value
id	String	Regex: ^[0-9]+(/[0-9]+)*\.[0-9]+$	Yes
interface_groups	List	String	No
arp_cache_limit	Integer	min: 0, max: 127999	No
arp_gratuitous_ignore	Boolean	true, false	No
arp_learning	Choice	disable, local	No
arp_timeout	Integer	min: 30, max: 2144448000	No
bandwidth	Integer	min: 0, max: 9223372036854775807	No
cdp	Boolean	true, false	No
dampening	Boolean	true, false	No
dampening_decay_half_life	Integer	min: 1, max: 45	No
dampening_max_suppress_time	Integer	min: 1, max: 255	No
dampening_reuse_threshold	Integer	min: 1, max: 20000	No
dampening_suppress_threshold	Integer	min: 1, max: 20000	No
description	String		No
encapsulation_dot1q_vlan	Integer	min: 1, max: 4094	No
encapsulation_dot1q_second_dot1q	Integer	min: 1, max: 4094	No
ethernet_cfm	Class	[ethernet_cfm]	No
flow_monitors	Class	[flow_monitors]	No
ipv4	Class	[ipv4]	No
ipv6	Class	[ipv6]	No
l2transport	Class	[l2transport]	No
lldp	Boolean	true, false	No
lldp_receive_disable	Boolean	true, false	No
lldp_tagged	Boolean	true, false	No
lldp_transmit_disable	Boolean	true, false	No
load_interval	Integer		No
logging_events_link_status	Boolean	true, false	No
macsec_eap_policy	String		No
macsec_fallback_psk_keychain	String		No
macsec_policy	String		No
macsec_psk_keychain	String		No
monitor_sessions	List	[monitor_sessions]	No
mpls_mtu	Integer	min: 68, max: 65535	No
mtu	Integer	min: 64, max: 65535	No
multipoint	Boolean	true, false	No
point_to_point	Boolean	true, false	No
proxy_arp	Boolean	true, false	No
ptp	Class	[ptp]	No
rewrite_ingress_tag_pop_one	Boolean	true, false	No
rewrite_ingress_tag_pop_two	Boolean	true, false	No
service_policy_input	List	[service_policy_input]	No
service_policy_output	List	[service_policy_output]	No
shutdown	Boolean	true, false	No
vrf	String		No

bandwidth_notifications (iosxr.interface_groups.configuration.ethernet_cfm)

Name	Type	Constraint	Mandatory	Default Value
hold_off	Integer	min: 0, max: 600	No
log_changes	Boolean	true, false	No
loss_threshold	Integer	min: 2, max: 255	No
wait_to_restore	Integer	min: 0, max: 600	No

mep_domains (iosxr.interface_groups.configuration.ethernet_cfm)

Name	Type	Constraint	Mandatory	Default Value
cos	Integer		No
domain	String		Yes
loss_measurement_counters	Class	[loss_measurement_counters]	No
mep_id	Integer		Yes
propagate_remote_status	Boolean	true, false	No
service	String		Yes
sla_operation_profiles	List	[sla_operation_profiles]	No

ipv4 (iosxr.interface_groups.configuration.flow_monitors)

Name	Type	Constraint	Mandatory	Default Value
monitor_map	String		Yes
sampler_map	String		No
direction	Choice	ingress, egress	Yes

quality_receive (iosxr.interface_groups.configuration.frequency_synchronization)

Name	Type	Constraint	Mandatory	Default Value
mode	Choice	exact, range	No
level	Choice	dnu, dus, eec1, eec2, e-eec, e-prtc, prc, prs, prtc, sec, smc, ssu-a, ssu-b, st2, st3, st3e, st4, stu, tnc	No
highest_level	Choice	dnu, dus, eec1, eec2, e-eec, e-prtc, prc, prs, prtc, sec, smc, ssu-a, ssu-b, st2, st3, st3e, st4, stu, tnc	No
lowest_level	Choice	dnu, dus, eec1, eec2, e-eec, e-prtc, prc, prs, prtc, sec, smc, ssu-a, ssu-b, st2, st3, st3e, st4, stu, tnc	No
option	Integer	min: 1, max: 2	No
generation	Integer	min: 1, max: 2	No

access_group_egress (iosxr.interface_groups.configuration.ipv4)

Name	Type	Constraint	Mandatory	Default Value
acl	String		No
compress	Integer		No
hardware_count	Boolean	true, false	No
interface_statistics	Boolean	true, false	No

helper_addresses (iosxr.interface_groups.configuration.ipv4)

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

secondaries (iosxr.interface_groups.configuration.ipv4)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
mask	IP		Yes
algorithm	Integer	min: 128, max: 255	No
route_tag	Integer	min: 1, max: 4294967295	No

access_group_egress (iosxr.interface_groups.configuration.ipv6)

Name	Type	Constraint	Mandatory	Default Value
acl	String		No
compress	Integer		No
interface_statistics	Boolean	true, false	No

addresses (iosxr.interface_groups.configuration.ipv6)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
length	Integer	min: 0, max: 128	Yes
algorithm	Integer	min: 128, max: 255	No
route_tag	Integer	min: 1, max: 4294967295	No
zone	String		No

eui64_addresses (iosxr.interface_groups.configuration.ipv6)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
length	Integer	min: 0, max: 128	Yes
algorithm	Integer	min: 128, max: 255	No
route_tag	Integer	min: 1, max: 4294967295	No
zone	String		No

interop (iosxr.interface_groups.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
domain	Integer	min: 0, max: 255	No
egress_conversion	Class	[egress_conversion]	No
ingress_conversion	Class	[ingress_conversion]	No
profile	Choice	default, g-8265-1, g-8275-1, g-8275-2	No

masters (iosxr.interface_groups.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
address	String		Yes
clock_class	Integer	min: 0, max: 255	No
delay_asymmetry_unit	Choice	nanoseconds, microseconds, milliseconds	No
delay_asymmetry_value	Integer	min: -500000000, max: 500000000	No
multicast	Choice	enable, mixed	No
non_negotiated	Boolean	true, false	No
priority	Integer	min: 0, max: 255	No

slaves (iosxr.interface_groups.configuration.ptp)

Name	Type	Constraint	Mandatory	Default Value
address	String		Yes
non_negotiated	Boolean	true, false	Yes

loss_measurement_counters (iosxr.interface_groups.configuration.ethernet_cfm.mep_domains)

Name	Type	Constraint	Mandatory	Default Value
aggregate	Boolean	true, false	No
priority_cos_range_from	Integer	min: 0, max: 7	No
priority_cos_range_to	Integer	min: 0, max: 7	No
priority_cos_values	List	Integer[min: 0, max: 7]	No

sla_operation_profiles (iosxr.interface_groups.configuration.ethernet_cfm.mep_domains)

Name	Type	Constraint	Mandatory	Default Value
mac_address	String		No
mep_id	Integer		No
profile	String		Yes

egress_conversion (iosxr.interface_groups.configuration.ptp.interop)

Name	Type	Constraint	Mandatory	Default Value
clock_accuracy	Integer	min: 0, max: 254	No
clock_class_default	Integer	min: 0, max: 255	No
clock_class_mappings	List	[clock_class_mappings]	No
offset_scaled_log_variance	Integer	min: 0, max: 65535	No
priority1	Integer	min: 0, max: 255	No
priority2	Integer	min: 0, max: 255	No

clock_class_mappings (iosxr.interface_groups.configuration.ptp.interop.egress_conversion)

Name	Type	Constraint	Mandatory	Default Value
class_from	Integer	min: 0, max: 255	Yes
class_to	Integer	min: 0, max: 255	Yes

Examples

iosxr:
  interface_groups:
    # Uplink port configuration
    - name: UPLINK_PORT
      configuration:
        description: "Core Network Uplink"
        mtu: 9216
        bandwidth: 10000000
        carrier_delay_up: 10
        carrier_delay_down: 10
        logging_events_link_status: true

    # Management interface configuration
    - name: MGMT_INTERFACE
      configuration:
        description: "Management Interface"
        ipv4:
          address: "${mgmt_ip}"
          mask: "255.255.255.0"
        lldp: true
        logging_events_link_status: true

  # Apply interface groups to devices
  devices:
    - name: Core-Router-01
      variables:
        mgmt_ip: "192.168.1.10"
      configuration:
        interfaces:
          ethernets:
          # Uplink ports using UPLINK_PORT group
          - type: "GigabitEthernet"
            id: "0/0/0/0"
            interface_groups: [UPLINK_PORT]

          # Management interface
          - type: "MgmtEth"
            id: "0/RP0/CPU0/0"
            interface_groups: [MGMT_INTERFACE]