New in version 2.2.
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
commands | yes | List of commands to send to the remote SR OS device over the configured provider. 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 | no | 1 | 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. | ||||||||||||||||||||||||||||||||||||
match | no | all |
| 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. | |||||||||||||||||||||||||||||||||||
provider | no | A dict object containing connection details. |
|||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
retries | no | 10 | 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. | ||||||||||||||||||||||||||||||||||||
wait_for | no | 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. aliases: waitfor |
# Note: examples below use the following provider dict to handle # transport and authentication to the node. --- vars: cli: host: "{{ inventory_hostname }}" username: admin password: admin transport: cli --- tasks: - name: run show version on remote devices sros_command: commands: show version provider: "{{ cli }}" - name: run show version and check to see if output contains sros sros_command: commands: show version wait_for: result[0] contains sros provider: "{{ cli }}" - name: run multiple commands on remote nodes sros_command: commands: - show version - show port detail provider: "{{ cli }}" - name: run multiple commands and evaluate the output sros_command: commands: - show version - show port detail wait_for: - result[0] contains TiMOS-B-14.0.R4 provider: "{{ cli }}"
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
stdout_lines | The value of stdout split into a list | always apart from low level errors (such as action plugin) | list | [['...', '...'], ['...'], ['...']] |
stdout | The set of responses from the commands | always apart from low level errors (such as action plugin) | list | ['...', '...'] |
failed_conditions | The list of conditionals that have failed | failed | list | ['...', '...'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/sros_command_module.html