cisco.nxos.nxos_igmp_module.rst

cisco.nxos.nxos_igmp

Manages IGMP global configuration.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages IGMP global configuration configuration settings.

Parameters

Parameter	Choices/Defaults	Comments
enforce_rtr_alert boolean	Choices: no yes	Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
flush_routes boolean	Choices: no yes	Removes routes when the IGMP process is restarted. By default, routes are not flushed.
restart boolean	Choices: no ← yes	Restarts the igmp process (using an exec config command).
state string	Choices: present ← default	Manages desired state of the resource.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• When state=default, all supported params will be reset to a default state.
• If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place.
• For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
• For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

- name: Default igmp global params (all params except restart)
  cisco.nxos.nxos_igmp:
    state: default

- name: Ensure the following igmp global config exists on the device
  cisco.nxos.nxos_igmp:
    flush_routes: true
    enforce_rtr_alert: true

- name: Restart the igmp process
  cisco.nxos.nxos_igmp:
    restart: true

Return Values

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

Key	Returned	Description
updates list	always	commands sent to the device Sample: ['ip igmp flush-routes']

Status

Authors

• Jason Edelman (@jedelman8)
• Gabriele Gerbino (@GGabriele)