W3cubDocs

/Ansible

nxos_igmp - Manages IGMP global configuration.

New in version 2.2.

Synopsis

Manages IGMP global configuration configuration settings.

Options

parameter required default choices comments
enforce_rtr_alert
 no
  • true
  • false
Enables or disables the enforce router alert option check for IGMPv2 and IGMPv3 packets.
flush_routes
 no
  • true
  • false
Removes routes when the IGMP process is restarted. By default, routes are not flushed.
host
 yes
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.
password
 no
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.
port
 no 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).
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
restart
 no
  • true
  • false
Restarts the igmp process (using an exec config command).
ssh_keyfile
 no
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.
state
 no present
  • present
  • default
Manages desired state of the resource.
transport
 yes 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.
use_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
Configures the username to use to authenticate the connection to the remote device. The value of username 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.

Examples

# configure a simple asn
- nxos_bgp:
      asn=65535
      vrf=test
      router_id=1.1.1.1
      state=present
      username: "{{ un }}"
      password: "{{ pwd }}"
      host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of IGMP configuration after module execution verbose mode dict {'enforce_rtr_alert': True, 'flush_routes': True}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['ip igmp flush-routes']
proposed k/v pairs of parameters passed into module verbose mode dict {'enforce_rtr_alert': True, 'flush_routes': True}
existing k/v pairs of existing IGMP configuration verbose mode dict {'enforce_rtr_alert': True, 'flush_routes': False}

Notes

Note

When state=default, all supported params will be reset to a default state.

Note

If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

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