mellanox.onyx.onyx_command – Run commands on remote devices running Mellanox ONYX¶
Note
This plugin is part of the mellanox.onyx collection (version 1.0.0).
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 onyx_config to configure Mellanox ONYX devices.
Parameters¶
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:
Authors¶
Samer Deeb (@samerd)