Documentation

nxos_igmp_interface - Manages IGMP interface configuration.

New in version 2.2.

Synopsis

  • Manages IGMP interface configuration settings.

Options

parameter required default choices comments
group_timeout
no
Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535 seconds. The default is 260 seconds.
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.
immediate_leave
no
  • true
  • false
Enables the device to remove the group entry from the multicast routing table immediately upon receiving a leave message for the group. Use this command to minimize the leave latency of IGMPv2 group memberships on a given IGMP interface because the device does not send group-specific queries. The default is disabled.
interface
yes
The full interface name for IGMP configuration. e.g. Ethernet1/2.
last_member_qrt
no
Sets the query interval waited after sending membership reports before the software deletes the group state. Values can range from 1 to 25 seconds. The default is 1 second.
last_member_query_count
no
Sets the number of times that the software sends an IGMP query in response to a host leave message. Values can range from 1 to 5. The default is 2.
oif_prefix
no
Configure a prefix for static outgoing interface (OIF).
oif_routemap
no
Configure a routemap for static outgoing interface (OIF).
oif_source
no
Configure a source for static outgoing interface (OIF).
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.
querier_timeout
no
Sets the querier timeout that the software uses when deciding to take over as the querier. Values can range from 1 to 65535 seconds. The default is 255 seconds.
query_interval
no
Sets the frequency at which the software sends IGMP host query messages. Values can range from 1 to 18000 seconds. he default is 125 seconds.
query_mrt
no
Sets the response time advertised in IGMP queries. Values can range from 1 to 25 seconds. The default is 10 seconds.
report_llg
no
  • true
  • false
Configures report-link-local-groups. Enables sending reports for groups in 224.0.0.0/24. Reports are always sent for nonlink local groups. By default, reports are not sent for link local groups.
restart
no
  • true
  • false
Restart IGMP.
robustness
no
Sets the robustness variable. Values can range from 1 to 7. The default is 2.
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.
startup_query_count
no
Query count used when the IGMP process starts up. The range is from 1 to 10. The default is 2.
startup_query_interval
no
Query interval used when the IGMP process starts up. The range is from 1 to 18000. The default is 31.
state
no present
  • present
  • default
Manages desired state of the resource.
timeout
(added in 2.3)
no 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).
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. 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.
validate_certs
no
  • yes
  • no
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.
version
no
  • 2
  • 3
IGMP version. It can be 2 or 3.

Examples

- nxos_igmp_interface:
    interface: ethernet1/32
    startup_query_interval: 30
    state: present
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of BGP configuration after module execution always dict {'router_id': '1.1.1.1', 'neighbor_down_fib_accelerate': False, 'confederation_peers': '', 'confederation_id': '', 'bestpath_compare_neighborid': False, 'local_as': '', 'bestpath_always_compare_med': False, 'bestpath_med_non_deterministic': False, 'cluster_id': '', 'vrf': 'test', 'graceful_restart_helper': False, 'timer_bgp_hold': '180', 'bestpath_aspath_multipath_relax': False, 'asn': '65535', 'timer_bestpath_limit': '', 'graceful_restart_timers_stalepath_time': '300', 'graceful_restart_timers_restart': '120', 'maxas_limit': '', 'bestpath_med_confed': False, 'log_neighbor_changes': False, 'timer_bgp_keepalive': '60', 'bestpath_cost_community_ignore': False, 'reconnect_interval': '60', 'suppress_fib_pending': False, 'bestpath_med_missing_as_worst': False, 'bestpath_compare_routerid': False, 'graceful_restart': True}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['router bgp 65535', 'vrf test', 'router-id 1.1.1.1']
proposed k/v pairs of parameters passed into module always dict {'router_id': '1.1.1.1', 'asn': '65535', 'vrf': 'test'}
existing k/v pairs of existing BGP configuration always dict {'router_id': '11.11.11.11', 'neighbor_down_fib_accelerate': False, 'confederation_peers': '', 'confederation_id': '', 'bestpath_compare_neighborid': False, 'local_as': '', 'bestpath_always_compare_med': False, 'bestpath_med_non_deterministic': False, 'cluster_id': '', 'vrf': 'test', 'graceful_restart_helper': False, 'timer_bgp_hold': '180', 'bestpath_aspath_multipath_relax': False, 'asn': '65535', 'timer_bestpath_limit': '', 'graceful_restart_timers_stalepath_time': '300', 'graceful_restart_timers_restart': '120', 'maxas_limit': '', 'bestpath_med_confed': False, 'log_neighbor_changes': False, 'timer_bgp_keepalive': '60', 'bestpath_cost_community_ignore': False, 'reconnect_interval': '60', 'suppress_fib_pending': False, 'bestpath_med_missing_as_worst': False, 'bestpath_compare_routerid': False, 'graceful_restart': True}


Notes

Note

  • When state=default, supported params will be reset to a default state. These include version, startup_query_interval, startup_query_count, robustness, querier_timeout, query_mrt, query_interval, last_member_qrt, last_member_query_count, group_timeout, report_llg, and immediate_leave.
  • When state=absent, all configs for oif_prefix, oif_source, and oif_routemap will be removed.
  • PIM must be enabled to use this module.
  • This module is for Layer 3 interfaces.
  • Route-map check not performed (same as CLI) check when configuring route-map with ‘static-oif’
  • If restart is set to true with other params set, the restart will happen last, i.e. after the configuration takes place.

Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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