Note
This module is part of ansible-core
and included in all Ansibleinstallations. In most cases, you can use the short module namescript even without specifying the collections:
keyword.However, we recommend you use the FQCN for easy linking to the moduledocumentation and to avoid conflicting with other collections that may havethe same module name.
Matt Oswalt This session. Project: i3-xfce Author: aacebedo File: core.py License: GNU Lesser General Public License v3.0. Def executeplay(playsource, inventory, varmgr, loader, options, callback): # pylint: disable=too-many-arguments ' Execute the playbook ' play = Play.load(playsource, variablemanager=varmgr, loader=loader) tqm = None try: tqm =. This module does not do an ICMP ping, but checks to see if you can run Python-based modules on managed hosts. For example, the following ad hoc command. What follows is an Ansible guide that will take you from installing Ansible to automatically deploying a long-running Python to a remote machine and running it in a Conda environment using.


The
script
module takes the script name followed by a list of space-delimited arguments.Either a free form command or
cmd
parameter is required, see the examples.The local script at path will be transferred to the remote node and then executed.
The given script will be processed through the shell environment on the remote node.
This module does not require python on the remote system, much like the ansible.builtin.raw module.
This module is also supported for Windows targets.

Note
This module has a corresponding action plugin.
Parameter | Choices/Defaults | Comments |
---|---|---|
chdir string | Change into this directory on the remote node before running the script. | |
cmd string | Path to the local script to run followed by optional arguments. | |
creates string | A filename on the remote node, when it already exists, this step will not be run. | |
decrypt boolean |
| This option controls the autodecryption of source files using vault. |
executable string | Name or path of a executable to invoke the script with. | |
free_form string | Path to the local script file followed by optional arguments. | |
removes string | A filename on the remote node, when it does not exist, this step will not be run. |
Note
It is usually preferable to write Ansible modules rather than pushing scripts. Convert your script to an Ansible module for bonus points!
The
ssh
connection plugin will force pseudo-tty allocation via-tt
when 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.If the path to the local script contains spaces, it needs to be quoted.
This module is also supported for Windows targets.
Does not support
check_mode
.
See also
The official documentation on the ansible.builtin.shell module.
Run Ansible Playbook From Python
The official documentation on the ansible.windows.win_shell module.
Authors

Python Example Programs
Ansible Core Team
Michael DeHaan