community.network.eric_eccli_command 模块 – 在运行 ERICSSON ECCLI 的远程设备上运行命令

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

• 将任意命令发送到 ERICSSON eccli 节点并返回从设备读取的结果。此模块包含一个参数，该参数将导致模块在返回之前等待特定条件，或者如果未满足条件则超时。

• 此模块还支持以原始命令样式在配置模式下运行命令。

别名：network.eric_eccli.eric_eccli_command

参数

参数	注释
commands 列表 / 元素=字符串 / 必需	要通过配置的提供程序发送到远程 ECCLI 设备的命令列表。返回命令的结果输出。如果提供了 wait_for 参数，则只有在满足条件或重试次数过期后才能返回模块。如果发送到设备的命令需要回答提示，则可以传递包含 command、answer 和 prompt 的字典。常见的答案是“y”或“\r”（回车符，必须用双引号括起来）。请参阅示例。
interval 整数	配置以秒为单位的间隔，用于在命令重试之间等待。如果命令未通过指定的条件，则间隔指示在再次尝试命令之前要等待的时间。 默认值： 1
match 字符串	match 参数与 wait_for 参数一起使用，用于指定匹配策略。有效值为 all 或 any。如果该值为 all，则必须满足 wait_for 中的所有条件。如果该值为 any，则只需要满足其中一个条件即可。 选项 "any" "all" ← (默认)
retries 整数	指定在命令被认为失败之前应尝试的重试次数。命令在每次重试时都在目标设备上运行，并根据 wait_for 条件进行评估。 默认值： 10
wait_for 别名：waitfor 列表 / 元素=字符串	要根据命令输出评估的条件列表。任务将等待每个条件都为真才能继续执行。如果在配置的重试次数内条件不为真，则任务失败。请参阅示例。

备注

注意

• 针对 IPOS 19.3 进行了测试

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

• 有关使用 Ansible 管理爱立信设备的更多信息，请参阅爱立信文档。

• 从 Ansible 2.5 开始，我们建议使用 connection: network_cli。

• 有关更多信息，请参阅 ERIC_ECCLI 平台选项指南。

示例

tasks:
  - name: Run show version on remote devices
    community.network.eric_eccli_command:
      commands: show version

  - name: Run show version and check to see if output contains IPOS
    community.network.eric_eccli_command:
      commands: show version
      wait_for: result[0] contains IPOS

  - name: Run multiple commands on remote nodes
    community.network.eric_eccli_command:
      commands:
        - show version
        - show running-config interfaces

  - name: Run multiple commands and evaluate the output
    community.network.eric_eccli_command:
      commands:
        - show version
        - show running-config interfaces
      wait_for:
        - result[0] contains IPOS
        - result[1] contains management

返回值

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

键	描述
failed_conditions 列表 / 元素=字符串	已失败的条件列表 返回值： failed 示例： ["...", "..."]
stdout 列表 / 元素=字符串	命令的响应集 返回值： 除低级错误（例如操作插件）外，始终返回 示例： ["...", "..."]
stdout_lines 列表 / 元素=字符串	stdout 值拆分为列表 返回值： 除低级错误（例如操作插件）外，始终返回 示例： [["...", "..."], ["..."], ["..."]]

状态

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

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

作者

• 爱立信 IPOS OAM 团队 (@itercheng)

资源链接

• 问题追踪器
• 代码仓库