community.network.slxos_command 模块 – 在运行 Extreme Networks SLX-OS 的远程设备上运行命令

注意

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

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

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

要在剧本中使用它，请指定：community.network.slxos_command。

注意

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

已弃用

在以下版本中移除：

6.0.0 版本

原因：

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

替代方案：

未知。

概要

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

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

别名：network.slxos.slxos_command

参数

参数	注释
commands 字符串 / 必需	要通过配置的提供程序发送到远程 SLX-OS 设备的命令列表。返回命令的输出结果。如果提供了 wait_for 参数，则在满足条件或重试次数过期之前，模块不会返回。
interval 字符串	配置命令重试之间等待的间隔（秒）。如果命令未通过指定的条件，则间隔指示在再次尝试命令之前等待多长时间。 默认值： 1
match 字符串	match 参数与 wait_for 参数一起使用，以指定匹配策略。有效值为 all 或 any。如果值为 all，则必须满足 wait_for 中的所有条件。如果值为 any，则只需满足其中一个值即可。 选项 "any" "all" ← (默认)
retries 字符串	指定在命令被认为失败之前应尝试的重试次数。命令在每次重试时都在目标设备上运行，并根据 wait_for 条件进行评估。 默认值： 10
wait_for 字符串	要根据命令输出评估的条件列表。任务将等待每个条件为真才能继续执行。如果在配置的重试次数内条件不为真，则任务失败。请参见示例。

备注

注意

• 针对 SLX-OS 17s.1.02 进行测试

• 如果发送到设备的命令需要回答提示，则可以传递包含 command、answer 和 prompt 的字典。请参见示例。

示例

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

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

  - name: Run multiple commands on remote nodes
    community.network.slxos_command:
      commands:
        - show version
        - show interfaces

  - name: Run multiple commands and evaluate the output
    community.network.slxos_command:
      commands:
        - show version
        - show interface status
      wait_for:
        - result[0] contains SLX
        - result[1] contains Eth
  - name: Run command that requires answering a prompt
    community.network.slxos_command:
      commands:
        - command: 'clear sessions'
          prompt: 'This operation will logout all the user sessions. Do you want to continue (yes/no)?:'
          answer: y

返回值

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

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

状态

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

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

作者

• Lindsay Hill (@LindsayHill)

资源链接

• 问题追踪器
• 代码仓库