nxos_igmp - Manages IGMP global configuration.

New in version 2.2.

Synopsis

  • Manages IGMP global configuration configuration settings.

Parameters

Parameter Choices/Defaults Comments
enforce_rtr_alert
    Choices:
  • true
  • false
Default:
None
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
flush_routes
    Choices:
  • true
  • false
Default:
None
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
provider Default:
None
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
This option is only required if you are using NX-API.
For more information please see the NXOS Platform Options guide.
A dict object containing connection details.
username
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
authorize
(added in 2.5.3)
    Choices:
  • no ←
  • yes
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.
ssh_keyfile
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
use_proxy
(added in 2.5)
    Choices:
  • yes ←
  • no
If no, the environment variables http_proxy and https_proxy will be ignored.
auth_pass
(added in 2.5.3)
 Default:
none
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.
host
required
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
timeout
(added in 2.3)
 Default:
10
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
use_ssl
    Choices:
  • yes
  • no ←
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
password Default:
None
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
validate_certs
    Choices:
  • yes
  • no
Default:
None
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.
port Default:
0 (use common port)
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
transport
required
 Default:
cli
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.
restart
    Choices:
  • true
  • false
Default:
None
Restarts the igmp process (using an exec config command).
state
    Choices:
  • present ←
  • default
Manages desired state of the resource.

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • 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 NXOS Platform Options guide
  • For more information on using Ansible to manage network devices see the Ansible 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)
  nxos_igmp:
    state: default

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

- name: Restart the igmp process
  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

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

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

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/nxos_igmp_module.html