New in version 2.3.
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
commands |
yes | The commands to send to the remote HUAWEI CloudEngine 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. | |||||||||||||||||||||||||||||||||||||
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 |
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 conditionals. | ||||||||||||||||||||||||||||||||||||
wait_for |
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 |
# 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 --- - name: run display version on remote devices ce_command: commands: display version provider: "{{ cli }}" - name: run display version and check to see if output contains HUAWEI ce_command: commands: display version wait_for: result[0] contains HUAWEI provider: "{{ cli }}" - name: run multiple commands on remote nodes ce_command: commands: - display version - display device provider: "{{ cli }}" - name: run multiple commands and evaluate the output ce_command: commands: - display version - display device wait_for: - result[0] contains HUAWEI - result[1] contains Device provider: "{{ cli }}" - name: run commands and specify the output format ce_command: commands: - command: display version output: json 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 | list | [['...', '...'], ['...'], ['...']] |
stdout | the set of responses from the commands | always | list | ['...', '...'] |
failed_conditions | the conditionals that 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 community maintained without core committer oversight.
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.