cisco.nxos.nxos_igmp_interface 模块 – 管理 IGMP 接口配置。

注意

此模块是 cisco.nxos 集合 (版本 9.2.1) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.nxos

要在剧本中使用它,请指定: cisco.nxos.nxos_igmp_interface

cisco.nxos 1.0.0 中的新增功能

摘要

  • 管理 IGMP 接口配置设置。

参数

参数

注释

group_timeout

字符串

设置 IGMPv2 的组成员超时。值可以是 3 到 65,535 秒之间的任意值,或者关键字“default”。默认为 260 秒。

immediate_leave

布尔值

启用设备在收到组的离开消息后立即从组播路由表中删除组条目。使用此命令可以最大限度地减少给定 IGMP 接口上 IGMPv2 组成员的离开延迟,因为设备不会发送特定于组的查询。默认为禁用。

选项

  • false

  • true

interface

字符串 / 必需

IGMP 配置的完整接口名称,例如 *Ethernet1/2*。

last_member_qrt

字符串

设置发送成员报告后等待的查询间隔,之后软件才会删除组状态。值可以是 1 到 25 秒之间的任意值,或者关键字“default”。默认为 1 秒。

last_member_query_count

字符串

设置软件响应主机离开消息时发送 IGMP 查询的次数。值可以是 1 到 5 之间的任意值,或者关键字“default”。默认为 2。

oif_ps

任意

配置静态出站接口 (OIF) 的前缀和源。这是一个字典列表,每个字典都定义了源和前缀,或者如果不需要源则只定义前缀。指定的将在设备上进行配置,如果存在任何以前的前缀/源,则将被删除。也接受关键字“default”,它会删除所有现有前缀/源。

oif_routemap

字符串

配置静态出站接口 (OIF) 的路由映射,或者关键字“default”。

querier_timeout

字符串

设置软件在决定接管作为查询器时使用的查询器超时。值可以是 1 到 65535 秒之间的任意值,或者关键字“default”。默认为 255 秒。

query_interval

字符串

设置软件发送 IGMP 主机查询消息的频率。值可以是 1 到 18000 秒之间的任意值,或者关键字“default”。默认为 125 秒。

query_mrt

字符串

设置在 IGMP 查询中通告的响应时间。值可以是 1 到 25 秒之间的任意值,或者关键字“default”。默认为 10 秒。

report_llg

布尔值

配置 report-link-local-groups。启用为 224.0.0.0/24 中的组发送报告。始终为非链路本地组发送报告。默认情况下,不会为链路本地组发送报告。

选项

  • false

  • true

restart

布尔值

重启 IGMP。由于这只是一个操作,因此它不是幂等的。

选项

  • false ← (默认)

  • true

robustness

字符串

设置稳健性变量。值可以是 1 到 7 之间的任意值,或者关键字“default”。默认为 2。

startup_query_count

字符串

IGMP 进程启动时使用的查询计数。范围为 1 到 10,或者关键字“default”。默认为 2。

startup_query_interval

字符串

IGMP 进程启动时使用的查询间隔。范围为 1 到 18000,或者关键字“default”。默认为 31。

state

字符串

管理资源的所需状态。

选项

  • "present" ← (默认)

  • "absent"

  • "default"

version

字符串

IGMP 版本。可以是 2 或 3,或者关键字“default”。

选项

  • "2"

  • "3"

  • "default"

备注

注意

  • 在 VIRL 上针对 NXOSv 7.3.(0)D1(1) 进行了测试

  • 不支持 Cisco MDS

  • state=default时,支持的参数将重置为默认状态。这些参数包括versionstartup_query_intervalstartup_query_countrobustnessquerier_timeoutquery_mrtquery_intervallast_member_qrtlast_member_query_countgroup_timeoutreport_llgimmediate_leave

  • state=absent时,所有针对oif_psoif_routemap的配置都将被删除。

  • 必须启用PIM才能使用此模块。

  • 此模块适用于第3层接口。

  • 使用‘static-oif’配置路由映射时,不执行路由映射检查(与CLI相同)。

  • 如果在设置其他参数的同时将restart设置为true,则重启将在最后发生,即在配置完成之后。但是,‘restart’本身不是幂等的,因为它是一个动作而不是配置。

  • 有关使用CLI和NX-API的信息,请参阅:ref:`NXOS平台选项指南 <nxos_platform_options>`

  • 有关使用Ansible管理网络设备的更多信息,请参阅:ref:`Ansible网络指南 <network_guide>`

  • 有关使用Ansible管理Cisco设备的更多信息,请参阅`Cisco集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例

- 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

返回值

常用的返回值已在此处记录,以下是此模块特有的字段

描述

changed

布尔值

检查设备上是否进行了更改

返回值:始终

示例:true

end_state

字典

模块执行后igmp接口配置的键值对

返回值:始终

示例:{"oif_ps": [{"prefix": "238.2.2.6"}, {"prefix": "238.2.2.5", "source": "192.168.0.1"}], "startup_query_count": "30"}

existing

字典

现有的igmp_interface配置的键值对

返回值:始终

示例:{"oif_ps": [], "startup_query_count": "2"}

proposed

字典

传入模块的参数的键值对

返回值:始终

示例:{"oif_ps": [{"prefix": "238.2.2.6"}, {"prefix": "238.2.2.5", "source": "192.168.0.1"}], "startup_query_count": "30"}

updates

列表 / 元素=字符串

发送到设备的命令

返回值:始终

示例:["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"]

作者

  • Jason Edelman (@jedelman8)

  • Gabriele Gerbino (@GGabriele)