community.network.pn_igmp_snooping module – CLI command to modify igmp-snooping
Note
This module is part of the community.network collection (version 5.1.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
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
This module can be used to modify Internet Group Management Protocol (IGMP) snooping.
Aliases: network.netvisor.pn_igmp_snooping
Parameters
Parameter |
Comments |
---|---|
Target switch to run the CLI on. |
|
enable or disable IGMP snooping. Choices:
|
|
enable per VLAN IGMP snooping. |
|
VLANs on which to use IGMPv2 protocol. |
|
VLANs on which to use IGMPv3 protocol. |
|
Remove snooping of link-local groups(224.0.0.0/24) on these vlans. |
|
IGMP query interval in seconds. |
|
maximum response time, in seconds, advertised in IGMP queries. |
|
IGMP snooping scope - fabric or local. Choices:
|
|
Allow snooping of link-local groups(224.0.0.0/24) on these vlans. |
|
enable or disable IGMP snooping on vxlans. Choices:
|
|
State the action to perform. Use Choices:
|
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 |
Description |
---|---|
indicates whether the CLI caused changes on the target. Returned: always |
|
the CLI command run on the target node. Returned: always |
|
set of error responses from the igmp-snooping command. Returned: on error |
|
set of responses from the igmp-snooping command. Returned: always |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.