cisco.nxos.nxos_igmp_interface (7.0.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nxos:==7.0.0

Add to requirements.yml

  collections:
    - name: cisco.nxos
      version: 7.0.0

Description

Manages IGMP interface configuration settings.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- cisco.nxos.nxos_igmp_interface:
    interface: ethernet1/32
    startup_query_interval: 30
    oif_ps:
      - {prefix: 238.2.2.6}
      - {source: 192.168.0.1, prefix: 238.2.2.5}
    state: present

Inputs

    
state:
    choices:
    - present
    - absent
    - default
    default: present
    description:
    - Manages desired state of the resource.
    type: str

oif_ps:
    description:
    - Configure prefixes and sources for static outgoing interface (OIF). This is a list
      of dict where each dict has source and prefix defined or just prefix if source is
      not needed. The specified values will be configured on the device and if any previous
      prefix/sources exist, they will be removed. Keyword 'default' is also accepted which
      removes all existing prefix/sources.
    type: raw

restart:
    default: false
    description:
    - Restart IGMP. This is NOT idempotent as this is action only.
    type: bool

version:
    choices:
    - '2'
    - '3'
    - default
    description:
    - IGMP version. It can be 2 or 3 or keyword 'default'.
    type: str

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

query_mrt:
    description:
    - Sets the response time advertised in IGMP queries. Values can range from 1 to 25
      seconds or keyword 'default'. The default is 10 seconds.
    type: str

report_llg:
    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.
    type: bool

robustness:
    description:
    - Sets the robustness variable. Values can range from 1 to 7 or keyword 'default'.
      The default is 2.
    type: str

oif_routemap:
    description:
    - Configure a routemap for static outgoing interface (OIF) or keyword 'default'.
    type: str

group_timeout:
    description:
    - Sets the group membership timeout for IGMPv2. Values can range from 3 to 65,535
      seconds or keyword 'default'. The default is 260 seconds.
    type: str

query_interval:
    description:
    - Sets the frequency at which the software sends IGMP host query messages. Values
      can range from 1 to 18000 seconds or keyword 'default'. The default is 125 seconds.
    type: str

immediate_leave:
    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.
    type: bool

last_member_qrt:
    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 or keyword 'default'.
      The default is 1 second.
    type: str

querier_timeout:
    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 or keyword 'default'. The default
      is 255 seconds.
    type: str

startup_query_count:
    description:
    - Query count used when the IGMP process starts up. The range is from 1 to 10 or keyword
      'default'. The default is 2.
    type: str

startup_query_interval:
    description:
    - Query interval used when the IGMP process starts up. The range is from 1 to 18000
      or keyword 'default'. The default is 31.
    type: str

last_member_query_count:
    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 or keyword 'default'. The default
      is 2.
    type: str

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: bool
end_state:
  description: k/v pairs of igmp interface configuration after module execution
  returned: always
  sample:
    oif_ps:
    - prefix: 238.2.2.6
    - prefix: 238.2.2.5
      source: 192.168.0.1
    startup_query_count: '30'
  type: dict
existing:
  description: k/v pairs of existing igmp_interface configuration
  returned: always
  sample:
    oif_ps: []
    startup_query_count: '2'
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    oif_ps:
    - prefix: 238.2.2.6
    - prefix: 238.2.2.5
      source: 192.168.0.1
    startup_query_count: '30'
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - interface Ethernet1/32
  - ip igmp startup-query-count 30
  - ip igmp static-oif 238.2.2.6
  - ip igmp static-oif 238.2.2.5 source 192.168.0.1
  type: list