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

list / elements=string / required

通过配置的提供程序发送到远程 ECCLI 设备的命令列表。返回命令的最终输出。如果提供了 wait_for 参数，则模块不会返回，直到满足条件或重试次数已过期。如果发送到设备的命令需要回答提示，则可以传递包含 command、answer 和 prompt 的字典。常见答案是 ‘y’ 或 “\r”（回车符，必须使用双引号）。请参阅示例。

interval

integer

配置命令重试之间等待的间隔（以秒为单位）。如果命令未通过指定的条件，则间隔指示在再次尝试该命令之前等待多长时间。

默认值： 1

match

string

match 参数与 wait_for 参数结合使用，以指定匹配策略。有效值为 all 或 any。如果该值设置为 all，则必须满足 wait_for 中的所有条件。如果该值设置为 any，则只需满足其中一个值。

选择

  • "any"

  • "all" ←（默认）

retries

integer

指定在认为命令失败之前应尝试的重试次数。每次重试都会在目标设备上运行该命令，并根据 wait_for 条件进行评估。

默认值： 10

wait_for

别名：waitfor

list / elements=string

要针对命令输出进行评估的条件列表。任务将等待每个条件为真，然后才能继续前进。如果在配置的重试次数内条件不为真，则任务将失败。请参阅示例。

注释

注意

  • 已针对 IPOS 19.3 进行测试

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

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

  • 从 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

list / elements=string

失败的条件列表

返回：失败

示例： ["...", "..."]

stdout

list / elements=string

来自命令的响应集

返回：始终返回，除了低级错误（例如操作插件）

示例： ["...", "..."]

stdout_lines

list / elements=string

将 stdout 的值拆分为列表

返回：始终返回，除了低级错误（例如操作插件）

示例： [["...", "..."], ["..."], ["..."]]

状态

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

  • 有关更多信息，请参阅 已弃用。

作者

  • Ericsson IPOS OAM 团队 (@itercheng)