alliedtelesis / alliedtelesis.awplus / 1.1.0 / module / awplus_command Run commands on remote devices running AlliedWare Plus | "added in version" 2.9 of alliedtelesis.awplus" Authors: Cheng Yi Kok (@cyk19)alliedtelesis.awplus.awplus_command (1.1.0) — module
Install with ansible-galaxy collection install alliedtelesis.awplus:==1.1.0
collections: - name: alliedtelesis.awplus version: 1.1.0
Sends arbitrary commands to an AlliedWare Plus 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.
This module does not support running commands in configuration mode. Please use M(alliedtelesis.awplus.awplus_config) to configure AlliedWare Plus devices.
- name: run show version on remote devices alliedtelesis.awplus.awplus_command: commands: show version
- name: run multiple commands and evaluate the output alliedtelesis.awplus.awplus_command: commands: - show version - show interface wait_for: - result[0] contains AlliedWare - result[1] contains 8Ts7JJKaMi match: all
- name: copy config file to existing txt file awplus_command: commands: - command: copy main.cfg text.txt prompt: Overwrite flash:/text.txt answer: y - command: copy main.cfg text.txt prompt: Overwrite flash:/text.txt answer: "\r"
match: choices: - any - all default: all description: - The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy. Valid values are C(all) or C(any). If the value is set to C(all) then all conditionals in the wait_for must be satisfied. If the value is set to C(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 I(wait_for) conditions. type: int commands: description: - List of commands to send to the remote AlliedWare Plus device over the configured provider. The resulting output from the command is returned. If the I(wait_for) argument is provided, the module is not returned until the condition is satisfied or the number of retries has expired. If a command sent to the device requires answering a prompt, it is possible to pass a dict containing I(command), I(answer) and I(prompt). Common answers are 'y' or "\r" (carriage return, must be double quotes). elements: raw 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: aliases: - waitfor 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: - result[0] contains 8Ts7JJKaMi type: list stdout: description: The set of responses from the commands returned: always apart from low level errors (such as action plugin) sample: - '! service password-encryption ! hostname aw1 ! banner exe...' 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: - - '!' - service password-encryption - '!' - hostname awplus - '!' - banner ex... type: list