mellanox.onyx.onyx_igmp_interface – Configures IGMP interface 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_interface.

Synopsis

  • This module provides declarative management of IGMP interface configuration on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
name
string / required
interface name that we want to configure IGMP on it
state
string
    Choices:
  • enabled ←
  • disabled
IGMP Interface state.

Notes

Note

  • Tested on ONYX 3.6.8130

Examples

- name: Configure igmp interface
  onyx_igmp_interface:
    state: enabled
    name: Eth1/1

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:
['interface ethernet 1/1 ip igmp snooping fast-leave']


Authors

  • Anas Badaha (@anasb)