community.network.sros_command 模块 – 在运行 Nokia SR OS 的远程设备上运行命令

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.network

要在 playbook 中使用它,请指定:community.network.sros_command

注意

community.network 集合已被弃用,并将从 Ansible 12 中删除。有关更多信息,请参阅讨论帖

已弃用

在以下版本中删除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 向 SR OS 节点发送任意命令,并返回从设备读取的结果。此模块包含一个参数,该参数将使模块在返回之前等待特定条件,如果未满足条件则超时。

  • 此模块不支持在配置模式下运行命令。请使用 community.network.sros_config 配置 SR OS 设备。

别名:network.sros.sros_command

参数

参数

注释

commands

字符串 / 必需

要通过配置的提供程序发送到远程 SR OS 设备的命令列表。返回命令的输出结果。如果提供了 wait_for 参数,则模块不会返回,直到满足条件或重试次数已过期。

interval

字符串

配置在命令重试之间等待的间隔(以秒为单位)。如果命令未通过指定的条件,则间隔指示在再次尝试命令之前等待的时间。

默认值: 1

match

字符串

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

选项

  • "any"

  • "all" ← (默认)

retries

字符串

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

默认值: 10

wait_for

别名:waitfor

字符串

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

注意

注意

示例

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

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

  - name: Run multiple commands on remote nodes
    community.network.sros_command:
      commands:
        - show version
        - show port detail

  - name: Run multiple commands and evaluate the output
    community.network.sros_command:
      commands:
        - show version
        - show port detail
      wait_for:
        - result[0] contains TiMOS-B-14.0.R4

返回值

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

描述

failed_conditions

列表 / elements=字符串

失败的条件列表

返回: 失败

示例: ["...", "..."]

stdout

列表 / elements=字符串

来自命令的一组响应

返回: 始终返回,除了低级错误(例如操作插件)

示例: ["...", "..."]

stdout_lines

列表 / elements=字符串

拆分为列表的 stdout 值

返回: 始终返回,除了低级错误(例如操作插件)

示例: [["...", "..."], ["..."], ["..."]]

状态

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

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

作者

  • Peter Sprygada (@privateip)