cisco.nxos.nxos_igmp_snooping_module.rst

cisco.nxos.nxos_igmp_snooping

Manages IGMP snooping global configuration.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages IGMP snooping global configuration.

Parameters

Parameter	Choices/Defaults	Comments
group_timeout string		Group membership timeout value for all VLANs on the device. Accepted values are integer in range 1-10080, never and default.
link_local_grp_supp boolean	Choices: no yes	Global link-local groups suppression.
report_supp boolean	Choices: no yes	Global IGMPv1/IGMPv2 Report Suppression.
snooping boolean	Choices: no yes	Enables/disables IGMP snooping on the switch.
state string	Choices: present ← default	Manage the state of the resource.
v3_report_supp boolean	Choices: no yes	Global IGMPv3 Report Suppression and Proxy Reporting.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• When state=default, params will be reset to a default state.
• group_timeout also accepts never as an input.
• For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
• For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

# ensure igmp snooping params supported in this module are in there default state
- cisco.nxos.nxos_igmp_snooping:
    state: default

# ensure following igmp snooping params are in the desired state
- cisco.nxos.nxos_igmp_snooping:
    group_timeout: never
    snooping: true
    link_local_grp_supp: false
    optimize_mcast_flood: false
    report_supp: true
    v3_report_supp: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list	always	command sent to the device Sample: ['ip igmp snooping link-local-groups-suppression', 'ip igmp snooping group-timeout 50', 'no ip igmp snooping report-suppression', 'no ip igmp snooping v3-report-suppression', 'no ip igmp snooping']

Status

Authors

• Jason Edelman (@jedelman8)
• Gabriele Gerbino (@GGabriele)