IGMP

IGMP (Internet Group Management Protocol) lets NX-OS routers learn which multicast groups have interested receivers on their directly connected networks. The global ip igmp settings are configured under the igmp section and cover SSM translation, route flushing on restart, spoof checking, router alert enforcement, querier election, the IGMP table syslog threshold and the heavy template. SSM translations for other VRFs (vrf context > ip igmp ssm-translate) are configured with ssm_translates under the respective entry in igmp.vrfs. IGMP interface-level configuration covers the IGMP version, querier timers, report policies, state limits, join groups, static groups and static OIFs (individual groups, or route-map based for join groups and static OIFs) across loopback, VLAN, Ethernet, and port-channel interfaces, and Ethernet and port-channel subinterfaces.

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

interface_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
interfaces	Class	interfaces	No
igmp	Class	igmp	No

configuration (nxos.interface_groups)

Name	Type	Constraint	Mandatory	Default Value
subinterfaces	List	subinterfaces	No
igmp	Class	igmp	No

interfaces (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
loopbacks	List	loopbacks	No
vlans	List	vlans	No
ethernets	List	ethernets	No
port_channels	List	port_channels	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
subinterfaces	List	subinterfaces	No
igmp	Class	igmp	No

port_channels (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
subinterfaces	List	subinterfaces	No
igmp	Class	igmp	No

loopbacks (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
igmp	Class	igmp	No

vlans (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
igmp	Class	igmp	No

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

Name	Type	Constraint	Mandatory	Default Value
igmp	Class	igmp	No

igmp (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
ssm_translates	List	ssm_translates	No
bootup_delay	Integer	min: 0, max: 65535	No
flush_routes	Boolean	true, false	No
spoof_check	Boolean	true, false	No
enforce_router_alert	Boolean	true, false	No
any_query_destination	Boolean	true, false	No
querier_elect_strict	Boolean	true, false	No
ha_stateful	Boolean	true, false	No
syslog_threshold	Integer	min: 1, max: 100	No
heavy_template	Boolean	true, false	No
vrfs	List	vrfs	No

igmp (nxos.devices.configuration.interfaces.loopbacks)

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

ssm_translates (nxos.devices.configuration.igmp)

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

vrfs (nxos.devices.configuration.igmp)

Name	Type	Constraint	Mandatory	Default Value
vrf	String		Yes
ssm_translates	List	ssm_translates	No

join_groups (nxos.devices.configuration.interfaces.loopbacks.igmp)

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

static_groups (nxos.devices.configuration.interfaces.loopbacks.igmp)

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

static_oifs (nxos.devices.configuration.interfaces.loopbacks.igmp)

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

Examples

Example 1: IGMPv3 on a receiver-facing SVI with tuned query timers

nxos:
  devices:
    - name: LEAF1
      configuration:
        feature:
          interface_vlan: true
          pim: true
        vlan:
          vlans:
            - id: 100
        interfaces:
          vlans:
            - id: 100
              pim:
                sparse_mode: true
              igmp:
                version: 3
                query_interval: 60
                query_max_response_time: 5
                robustness_variable: 3
                immediate_leave: true

Example 2: Global IGMP settings with SSM translation in the default and a tenant VRF

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        vrfs:
          - name: TENANT1
        igmp:
          flush_routes: true
          enforce_router_alert: true
          syslog_threshold: 80
          ssm_translates:
            - group: 232.1.1.0/24
              source: 10.3.3.3
          vrfs:
            - vrf: TENANT1
              ssm_translates:
                - group: 232.2.2.0/24
                  source: 10.4.4.4

Example 3: Interface report policy, state limit, join groups, static groups and static OIFs

nxos:
  devices:
    - name: LEAF1
      configuration:
        route_maps:
          - name: IGMP_REPORT_POLICY
            entries:
              - order: 10
                action: permit
          - name: IGMP_RESERVED
            entries:
              - order: 10
                action: permit
        interfaces:
          ethernets:
            - id: 1/10
              switchport:
                enabled: false
              ip:
                address: 10.1.10.1/24
              pim:
                sparse_mode: true
              igmp:
                report_policy: IGMP_REPORT_POLICY
                state_limit: 100
                state_limit_reserved_route_map: IGMP_RESERVED
                state_limit_reserved: 50
                join_groups:
                  - group: 239.1.1.1
                  - group: 232.1.1.1
                    source: 10.1.1.1
                static_groups:
                  - group: 239.1.1.3
                static_oifs:
                  - group: 239.1.1.2