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

Comments

default_version

string

Configure the default operating version of the IGMP snooping

Choices:

  • V2

  • V3

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

Configure ip igmp snooping proxy and enable reporting mode

Choices:

  • enabled

  • disabled

report_suppression_interval

string

Configure the report suppression interval, range 1-25

state

string / required

IGMP state.

Choices:

  • enabled

  • disabled

unregistered_multicast

string

Configure the unregistered multicast mode Flood unregistered multicast Forward unregistered multicast to mrouter ports

Choices:

  • flood

  • forward-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

Description

commands

list / elements=string

The list of configuration mode commands to send to the device.

Returned: always

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)