scriptmodule takes the script name followed by a list of space-delimited arguments.
cmdparameter is required, see the examples.
| chdir |
added in 2.4
Change into this directory on the remote node before running the script.
| cmd |
Path to the local script to run followed by optional arguments.
| creates |
A filename on the remote node, when it already exists, this step will not be run.
| decrypt |
added in 2.4
| || |
This option controls the autodecryption of source files using vault.
| executable |
added in 2.6
Name or path of a executable to invoke the script with.
| free_form |
Path to the local script file followed by optional arguments.
| removes |
A filename on the remote node, when it does not exist, this step will not be run.
sshconnection plugin will force pseudo-tty allocation via
-ttwhen scripts are executed. Pseudo-ttys do not have a stderr channel and all stderr is sent to stdout. If you depend on separated stdout and stderr result keys, please switch to a copy+command set of tasks instead of using script.
- name: Run a script with arguments (free form) script: /some/local/script.sh --some-argument 1234 - name: Run a script with arguments (using 'cmd' parameter) script: cmd: /some/local/script.sh --some-argument 1234 - name: Run a script only if file.txt does not exist on the remote node script: /some/local/create_file.sh --some-argument 1234 args: creates: /the/created/file.txt - name: Run a script only if file.txt exists on the remote node script: /some/local/remove_file.sh --some-argument 1234 args: removes: /the/removed/file.txt - name: Run a script using an executable in a non-system path script: /some/local/script args: executable: /some/remote/executable - name: Run a script using an executable in a system path script: /some/local/script.py args: executable: python3
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.