community / community.routeros / 2.14.0 / module / command Run commands on remote devices running MikroTik RouterOS Authors: Egor Zaitsev (@heuels)community.routeros.command (2.14.0) — module
Install with ansible-galaxy collection install community.routeros:==2.14.0
collections: - name: community.routeros version: 2.14.0
Sends arbitrary commands to an RouterOS node 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.
The module always indicates a (changed) status. You can use R(the changed_when task property,override_the_changed_result) to determine whether a command task actually resulted in a change or not.
- name: Run command on remote devices community.routeros.command: commands: /system routerboard print
- name: Run command and check to see if output contains routeros community.routeros.command: commands: /system resource print wait_for: result[0] contains MikroTik
- name: Run multiple commands on remote nodes community.routeros.command: commands: - /system routerboard print - /system identity print
- name: Run multiple commands and evaluate the output community.routeros.command: commands: - /system routerboard print - /interface ethernet print wait_for: - result[0] contains x86 - result[1] contains ether1
match: choices: - any - all default: all description: - The O(match) argument is used in conjunction with the O(wait_for) argument to specify the match policy. Valid values are V(all) or V(any). If the value is set to V(all) then all conditionals in the wait_for must be satisfied. If the value is set to V(any) then only one of the values must be satisfied. type: str retries: default: 10 description: - 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 O(wait_for) conditions. type: int commands: description: - List of commands to send to the remote RouterOS device over the configured provider. The resulting output from the command is returned. If the O(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired. elements: str required: true type: list interval: default: 1 description: - 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. type: int wait_for: description: - 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. elements: str type: list
failed_conditions: description: The list of conditionals that have failed returned: failed sample: - '...' - '...' type: list stdout: description: The set of responses from the commands returned: always apart from low level errors (such as action plugin) sample: - '...' - '...' type: list stdout_lines: description: The value of stdout split into a list returned: always apart from low level errors (such as action plugin) sample: - - '...' - '...' - - '...' - - '...' type: list