W3cubDocs

/Ansible

community.network.pn_igmp_snooping – CLI command to modify igmp-snooping

Note

This plugin is part of the community.network collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.pn_igmp_snooping.

Synopsis

  • This module can be used to modify Internet Group Management Protocol (IGMP) snooping.

Parameters

Parameter Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_enable
boolean
    Choices:
  • no
  • yes
enable or disable IGMP snooping.
pn_enable_vlans
string
enable per VLAN IGMP snooping.
pn_igmpv2_vlans
string
VLANs on which to use IGMPv2 protocol.
pn_igmpv3_vlans
string
VLANs on which to use IGMPv3 protocol.
pn_no_snoop_linklocal_vlans
string
Remove snooping of link-local groups(224.0.0.0/24) on these vlans.
pn_query_interval
string
IGMP query interval in seconds.
pn_query_max_response_time
string
maximum response time, in seconds, advertised in IGMP queries.
pn_scope
string
    Choices:
  • local
  • fabric
IGMP snooping scope - fabric or local.
pn_snoop_linklocal_vlans
string
Allow snooping of link-local groups(224.0.0.0/24) on these vlans.
pn_vxlan
boolean
    Choices:
  • no
  • yes
enable or disable IGMP snooping on vxlans.
state
string / required
    Choices:
  • update
State the action to perform. Use update to modify the igmp-snooping.

Examples

- name: 'Modify IGMP Snooping'
  community.network.pn_igmp_snooping:
    pn_cliswitch: 'sw01'
    state: 'update'
    pn_vxlan: True
    pn_enable_vlans: '1-399,401-4092'
    pn_no_snoop_linklocal_vlans: 'none'
    pn_igmpv3_vlans: '1-399,401-4092'

- name: 'Modify IGMP Snooping'
  community.network.pn_igmp_snooping:
    pn_cliswitch: 'sw01'
    state: 'update'
    pn_vxlan: False
    pn_enable_vlans: '1-399'
    pn_no_snoop_linklocal_vlans: 'none'
    pn_igmpv3_vlans: '1-399'

Return Values

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

Key Returned Description
changed
boolean
always
indicates whether the CLI caused changes on the target.
command
string
always
the CLI command run on the target node.
stderr
list / elements=string
on error
set of error responses from the igmp-snooping command.
stdout
list / elements=string
always
set of responses from the igmp-snooping command.


Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_igmp_snooping_module.html