community.network.voss_command 模块 – 在运行 Extreme VOSS 的远程设备上运行命令

注意

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

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

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

要在 Playbook 中使用它，请指定：community.network.voss_command。

注意

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

已弃用

移除于:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 将任意命令发送到运行 VOSS 的 Extreme VSP 设备，并返回从设备读取的结果。此模块包含一个参数，该参数将导致模块等待特定条件，然后再返回，如果未满足条件，则会超时。

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

别名：network.voss.voss_command

参数

参数

注释

commands

string / 必选

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

interval

string

配置命令重试之间等待的秒数间隔。如果命令未通过指定的条件，则间隔指示在再次尝试命令之前要等待多长时间。

默认值： 1

match

string

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

选择

  • "any"

  • "all" ← （默认）

retries

string

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

默认值： 10

wait_for

string

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

注意

注意

  • 已针对 VOSS 7.0.0 进行测试

示例

tasks:
  - name: Run show sys software on remote devices
    community.network.voss_command:
      commands: show sys software

  - name: Run show sys software and check to see if output contains VOSS
    community.network.voss_command:
      commands: show sys software
      wait_for: result[0] contains VOSS

  - name: Run multiple commands on remote nodes
    community.network.voss_command:
      commands:
        - show sys software
        - show interfaces vlan

  - name: Run multiple commands and evaluate the output
    community.network.voss_command:
      commands:
        - show sys software
        - show interfaces vlan
      wait_for:
        - result[0] contains Version
        - result[1] contains Basic

  - name: Run command that requires answering a prompt
    community.network.voss_command:
      commands:
        - command: 'reset'
          prompt: 'Are you sure you want to reset the switch? (y/n)'
          answer: 'y'

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

failed_conditions

list / elements=string

失败的条件列表

返回：失败

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

stdout

list / elements=string

来自命令的一组响应

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

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

stdout_lines

list / elements=string

stdout 的值拆分为列表

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

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

状态

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

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

作者

  • Lindsay Hill (@LindsayHill)