Docs4dev
Docs
ansible / latest / collections / mellanox / onyx / onyx_igmp_module.html

mellanox.onyx.onyx_igmp – Configures IGMP global parameters

Note

This plugin is part of the mellanox.onyx collection (version 1.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 mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_igmp.

Synopsis

  • This module provides declarative management of IGMP protocol params on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
default_version
string
    Choices:
  • V2
  • V3
Configure the default operating version of the IGMP snooping
last_member_query_interval
string
Configure the last member query interval, range 1-25
mrouter_timeout
string
Configure the mrouter timeout, range 60-600
port_purge_timeout
string
Configure the host port purge timeout, range 130-1225
proxy_reporting
string
    Choices:
  • enabled
  • disabled
Configure ip igmp snooping proxy and enable reporting mode
report_suppression_interval
string
Configure the report suppression interval, range 1-25
state
string / required
    Choices:
  • enabled
  • disabled
IGMP state.
unregistered_multicast
string
    Choices:
  • flood
  • forward-to-mrouter-ports
Configure the unregistered multicast mode Flood unregistered multicast Forward unregistered multicast to mrouter ports

Notes

Note

  • Tested on ONYX 3.6.6107

Examples

- name: Configure igmp
  onyx_igmp:
    state: enabled
    unregistered_multicast: flood

Return Values

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

Key Returned Description
commands
list / elements=string
always
The list of configuration mode commands to send to the device.

Sample:
['ip igmp snooping', 'ip igmp snooping last-member-query-interval 10', 'ip igmp snooping mrouter-timeout 150', 'ip igmp snooping port-purge-timeout 150']


Authors

  • Samer Deeb (@samerd)

© 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/mellanox/onyx/onyx_igmp_module.html