ansible.builtin.nxos_igmp_interface (v2.5.10) — module

Manages IGMP interface configuration.

| "added in version" 2.2 of ansible.builtin"

Authors: Jason Edelman (@jedelman8), Gabriele Gerbino (@GGabriele)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.5.10

Description

Manages IGMP interface configuration settings.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- nxos_igmp_interface:
    interface: ethernet1/32
    startup_query_interval: 30
    state: present

Inputs

    
state:
    choices:
    - present
    - default
    default: present
    description:
    - Manages desired state of the resource.
    required: false

restart:
    choices:
    - 'true'
    - 'false'
    default: null
    description:
    - Restart IGMP.
    required: false

version:
    choices:
    - '2'
    - '3'
    default: null
    description:
    - IGMP version. It can be 2 or 3.
    required: false

interface:
    description:
    - The full interface name for IGMP configuration. e.g. I(Ethernet1/2).
    required: true

query_mrt:
    default: null
    description:
    - Sets the response time advertised in IGMP queries. Values can range from 1 to 25
      seconds. The default is 10 seconds.
    required: false

oif_prefix:
    default: null
    description:
    - Configure a prefix for static outgoing interface (OIF).
    required: false

oif_source:
    default: null
    description:
    - Configure a source for static outgoing interface (OIF).
    required: false

report_llg:
    choices:
    - 'true'
    - 'false'
    default: false
    description:
    - 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.
    required: false

robustness:
    default: null
    description:
    - Sets the robustness variable. Values can range from 1 to 7. The default is 2.
    required: false

oif_routemap:
    default: null
    description:
    - Configure a routemap for static outgoing interface (OIF).
    required: false

group_timeout:
    default: null
    description:
    - Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535
      seconds. The default is 260 seconds.
    required: false

query_interval:
    default: null
    description:
    - Sets the frequency at which the software sends IGMP host query messages. Values
      can range from 1 to 18000 seconds. The default is 125 seconds.
    required: false

immediate_leave:
    choices:
    - 'true'
    - 'false'
    default: false
    description:
    - 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.
    required: false

last_member_qrt:
    default: null
    description:
    - 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.
    required: false

querier_timeout:
    default: null
    description:
    - 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.
    required: false

startup_query_count:
    default: null
    description:
    - Query count used when the IGMP process starts up. The range is from 1 to 10. The
      default is 2.
    required: false

startup_query_interval:
    default: null
    description:
    - Query interval used when the IGMP process starts up. The range is from 1 to 18000.
      The default is 31.
    required: false

last_member_query_count:
    default: null
    description:
    - 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.
    required: false

Outputs

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