community.network.cnos_conditional_command 模块 – 在运行 Lenovo CNOS 的设备上基于条件执行单个命令

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install community.network。

要在 playbook 中使用它，请指定： community.network.cnos_conditional_command。

注意

community.network 集合已弃用，并将从 Ansible 12 中移除。请参阅 讨论主题 以了解更多信息。

已弃用

在以下版本中移除：

6.0.0版本

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

  • 此模块允许您修改交换机的运行配置。它提供了一种通过评估当前运行配置并在仅当特定设置尚未配置时才执行命令的方式，在网络设备上执行单个 CNOS 命令。CNOS 命令作为方法的参数传递。此模块的功能与 cnos_command 模块相同。唯一的例外是，可以指定以下清单变量 [“condition = <flag 字符串>”]。当此清单变量被指定为任务的变量时，该命令将对匹配标志字符串的网络元素执行。通常，命令会在网络设备组中执行。当需要跳过在一个或多个设备上执行命令时，建议使用此模块。此模块使用 SSH 管理网络设备配置。

别名：network.cnos.cnos_conditional_command

参数

参数

注释

clicommand

字符串 / 必需

这将 CLI 命令指定为此方法的属性。命令使用双引号传递。变量可以直接放在 CLI 命令中，也可以从 vars 目录调用。

condition

字符串 / 必需

如果您在清单文件中针对任何设备指定 condition=false，则会跳过该设备的命令执行。

deviceType

字符串 / 必需

这指定了执行方法的设备类型。自 Ansible 2.4 起添加了选项 NE1072T、NE1032、NE1032T、NE10032、NE2572。自 2.8 起添加了选项 NE0152T

选项

  • "g8272_cnos"

  • "g8296_cnos"

  • "g8332_cnos"

  • "NE0152T"

  • "NE1072T"

  • "NE1032"

  • "NE1032T"

  • "NE10032"

  • "NE2572"

enablePassword

字符串

配置用于在交换机上进入全局配置命令模式的密码。如果交换机不要求此密码，则忽略该参数。虽然通常值应来自清单文件，但您也可以将其指定为变量。此参数是可选的。如果未指定，则不使用默认值。

flag

字符串 / 必需

如果需要执行任务，则必须将标志设置为与该设备清单中指定的标志相同。

host

字符串 / 必需

这是用于搜索 /etc/ansible/hosts 中的主机文件并识别将应用模板的设备 IP 地址的变量。通常，Ansible 关键字 {{ inventory_hostname }} 在 playbook 中指定为需要配置的网络元素组的抽象。

outputfile

字符串 / 必需

这指定了保存每个命令执行输出的文件路径。合并的模板文件中指定的每个命令和来自设备的每个响应都保存在此处。通常位置是 results 文件夹，但您可以根据您的写入权限选择其他位置。

password

字符串 / 必需

配置用于验证与远程设备连接的密码。password 参数的值用于验证 SSH 会话。虽然通常值应来自清单文件，但您也可以将其指定为变量。此参数是可选的。如果未指定，则不使用默认值。

username

字符串 / 必需

配置用于验证与远程设备连接的用户名。username 参数的值用于验证 SSH 会话。虽然通常值应来自清单文件，但您也可以将其指定为变量。此参数是可选的。如果未指定，则不使用默认值。

备注

注意

示例

Tasks : The following are examples of using the module
 cnos_conditional_command. These are written in the main.yml file of the tasks
 directory.
---
- name: Applying CLI template on VLAG Tier1 Leaf Switch1
  community.network.cnos_conditional_command:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_conditional_command_
                  {{ inventory_hostname }}_output.txt"
      condition: "{{ hostvars[inventory_hostname]['condition']}}"
      flag: leaf_switch2
      command: "spanning-tree mode enable"

返回值

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

键

描述

msg

字符串

成功或失败消息

返回：始终

示例： "Command Applied"

状态

  • 此模块将在6.0.0版本中移除。[已弃用]

  • 更多信息请参见 已弃用。

作者

  • Anil Kumar Muraleedharan (@amuraleedhar)