New in version 2.2.
Sends arbitrary commands to an SR OS 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 sros_config to configure SR OS devices.
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. |
||
host | yes | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
||
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. |
password | no | Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead. |
||
port | no | 22 | Specifies the port to use when building the connection to the remote device. |
|
provider | no | Convenience argument that allows connection arguments to be passed as a dict object. These include host , port , username , password , ssh_keyfile , and timeout . All constraints (required, choices, etc) must be met either by individual arguments or values in this dict. |
||
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. |
|
ssh_keyfile | no | Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
timeout | no | 10 | Specifies idle timeout for the connection, in seconds. Useful if the console freezes before continuing. For example when saving configurations. |
|
username | no | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead. |
||
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 Common 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 | list | [['...', '...'], ['...'], ['...']] |
stdout | The set of responses from the commands | always | list | ['...', '...'] |
failed_conditions | The list of conditionals that have failed | failed | list | ['...', '...'] |
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/sros_command_module.html