New in version 2.1.
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
commands |
no | The commands to send to the remote junos 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 been exceeded. | |||||||||||||||||||||||||||||||||||||
display (added in 2.3) |
no | depends on input argument I(rpcs) or I(commands) |
|
Encoding scheme to use when serializing output from the device. This handles how to properly understand the output and apply the conditionals path to the result set. For rpcs argument default display is
xml and for commands argument default display is text .aliases: format, output | |||||||||||||||||||||||||||||||||||
interval |
no | 1 | Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again. | ||||||||||||||||||||||||||||||||||||
match (added in 2.2) |
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 be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals. | ||||||||||||||||||||||||||||||||||||
rpcs (added in 2.3) |
no | The rpcs argument accepts a list of RPCs to be executed over a netconf session and the results from the RPC execution is return to the playbook via the modules results dictionary. | |||||||||||||||||||||||||||||||||||||
wait_for (added in 2.2) |
no | Specifies what to evaluate from the output of the command and what conditionals to apply. This argument will cause the task to wait for a particular conditional to be true before moving forward. If the conditional is not true by the configured retries, the task fails. See examples.
aliases: waitfor |
- name: run show version on remote devices junos_command: commands: show version - name: run show version and check to see if output contains Juniper junos_command: commands: show version wait_for: result[0] contains Juniper - name: run multiple commands on remote nodes junos_command: commands: - show version - show interfaces - name: run multiple commands and evaluate the output junos_command: commands: - show version - show interfaces wait_for: - result[0] contains Juniper - result[1] contains Loopback0 - name: run commands and specify the output format junos_command: commands: show version display: json - name: run rpc on the remote device junos_command: rpcs: get-software-information
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.
This module is maintained by those with core commit privileges
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.