cisco.nxos.nxos_pim_interface 模块 – 管理 PIM 接口配置。

注意

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

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

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

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

cisco.nxos 1.0.0 中的新增功能

概要

  • 管理 PIM 接口配置设置。

参数

参数

注释

bfd

字符串

在接口级别启用 PIM 的 BFD。这将覆盖在 PIM 全局级别设置的 bfd 变量。

有效值为“enable”、“disable”或“default”。

依赖项:“feature bfd”

选项

  • "enable"

  • "disable"

  • "default"

border

布尔值

将接口配置为 PIM 域的边界。

选项

  • false ← (默认)

  • true

dr_prio

字符串

配置接口上 PIM DR 选举的优先级。

hello_auth_key

字符串

此接口上 Hello 消息的认证。

hello_interval

整数

此接口的 Hello 间隔(毫秒或秒)。

使用选项 *hello_interval_ms* 指定给定值是毫秒还是秒。默认为秒。

hello_interval_ms

布尔值

在 cisco.nxos 2.0.0 中添加

指定 hello_interval 以毫秒为单位。

设置为 True 时,表示用户以毫秒为单位提供 hello_interval,因此不需要转换。

选项

  • false

  • true

interface

字符串 / 必需

接口的全名,例如 Ethernet1/33。

jp_policy_in

字符串

加入/剪除消息的策略(入站)。

jp_policy_out

字符串

加入/剪除消息的策略(出站)。

jp_type_in

字符串

映射到 jp_policy_in 的策略类型。

选项

  • "prefix"

  • "routemap"

jp_type_out

字符串

映射到 jp_policy_out 的策略类型。

选项

  • "prefix"

  • "routemap"

neighbor_policy

字符串

配置用于过滤邻接关系的邻居策略。

neighbor_type

字符串

映射到 neighbor_policy 的策略类型。

选项

  • "prefix"

  • "routemap"

sparse

布尔值

启用/禁用接口上的稀疏模式。

选项

  • false ← (默认)

  • true

state

字符串

管理资源的所需状态。

选项

  • "present" ← (默认)

  • "absent"

  • "default"

备注

注意

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

  • 不支持 Cisco MDS

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

  • hello_auth_key 参数不是幂等的。

  • hello_auth_key 只支持明文密码。

  • state=absent 时,PIM 接口配置将设置为默认值,并且 PIM-SM 将在接口上被禁用。

  • 必须在设备上启用 PIM 才能使用此模块。

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

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

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

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

示例

- name: Ensure PIM is not running on the interface
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    state: absent

- name: Ensure the interface has pim-sm enabled with the appropriate priority and
    hello interval
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    dr_prio: 10
    hello_interval: 40
    state: present

- name: Ensure join-prune policies exist
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    jp_policy_in: JPIN
    jp_policy_out: JPOUT
    jp_type_in: routemap
    jp_type_out: routemap

- name: disable bfd on the interface
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    bfd: disable

- name: Ensure defaults are in place
  cisco.nxos.nxos_pim_interface:
    interface: eth1/33
    state: default

返回值

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

描述

commands

列表 / 元素=字符串

发送到设备的命令

返回:始终

示例: ["interface eth1/33", "ip pim neighbor-policy test", "ip pim bfd-instance disable", "ip pim neighbor-policy test"]

作者

  • Jason Edelman (@jedelman8)