mellanox.onyx.onyx_command module – Run commands on remote devices running Mellanox ONYX

Note

This module is part of the mellanox.onyx collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_command.

Synopsis

  • Sends arbitrary commands to an Mellanox ONYX network device and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

  • This module does not support running commands in configuration mode. Please use ERROR while parsing: While parsing M() at index 81: Module name “onyx_config” is not a FQCN to configure Mellanox ONYX devices.

Parameters

Parameter

Comments

commands

string / required

List of commands to send to the remote Mellanox ONYX network device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired.

interval

string

Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again.

Default: 1

match

string

The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.

Choices:

  • "any"

  • "all" ← (default)

retries

string

Specifies the number of retries a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions.

Default: 10

wait_for

string

List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails. See examples.

Notes

Note

  • Tested on ONYX 3.6.4000

Examples

tasks:
  - name: Run show version on remote devices
    onyx_command:
      commands: show version

  - name: Run show version and check to see if output contains MLNXOS
    onyx_command:
      commands: show version
      wait_for: result[0] contains MLNXOS

  - name: Run multiple commands on remote nodes
    onyx_command:
      commands:
        - show version
        - show interfaces

  - name: Run multiple commands and evaluate the output
    onyx_command:
      commands:
        - show version
        - show interfaces
      wait_for:
        - result[0] contains MLNXOS
        - result[1] contains mgmt1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

failed_conditions

list / elements=string

The list of conditionals that have failed

Returned: failed

Sample: ["...", "..."]

stdout

list / elements=string

The set of responses from the commands

Returned: always apart from low level errors (such as action plugin)

Sample: ["...", "..."]

stdout_lines

list / elements=string

The value of stdout split into a list

Returned: always apart from low level errors (such as action plugin)

Sample: [["...", "..."], ["..."], ["..."]]

Authors

  • Samer Deeb (@samerd)