__ __ __ __ _____ _ _ _____ _ _ _ | \/ | \ \ / / | __ \ (_) | | / ____| | | | | | \ / |_ __\ V / | |__) | __ ___ ____ _| |_ ___ | (___ | |__ ___| | | | |\/| | '__|> < | ___/ '__| \ \ / / _` | __/ _ \ \___ \| '_ \ / _ \ | | | | | | |_ / . \ | | | | | |\ V / (_| | || __/ ____) | | | | __/ | | |_| |_|_(_)_/ \_\ |_| |_| |_| \_/ \__,_|\__\___| |_____/|_| |_|\___V 2.1 if you need WebShell for Seo everyday contact me on Telegram Telegram Address : @jackleetFor_More_Tools:
# Copyright: (c) 2012, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
module: script
version_added: "0.9"
short_description: Runs a local script on a remote node after transferring it
description:
- The C(script) module takes the script name followed by a list of space-delimited arguments.
- Either a free form command or C(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 M(ansible.builtin.raw) module.
- This module is also supported for Windows targets.
options:
free_form:
description:
- Path to the local script file followed by optional arguments.
cmd:
type: str
description:
- Path to the local script to run followed by optional arguments.
creates:
description:
- A filename on the remote node, when it already exists, this step will B(not) be run.
version_added: "1.5"
removes:
description:
- A filename on the remote node, when it does not exist, this step will B(not) be run.
version_added: "1.5"
chdir:
description:
- Change into this directory on the remote node before running the script.
version_added: "2.4"
executable:
description:
- Name or path of a executable to invoke the script with.
version_added: "2.6"
notes:
- It is usually preferable to write Ansible modules rather than pushing scripts. Convert your script to an Ansible module for bonus points!
- The C(ssh) connection plugin will force pseudo-tty allocation via C(-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.
seealso:
- module: ansible.builtin.shell
- module: ansible.windows.win_shell
author:
- Ansible Core Team
- Michael DeHaan
extends_documentation_fragment:
- action_common_attributes
- action_common_attributes.files
- action_common_attributes.raw
- decrypt
attributes:
check_mode:
support: partial
details: while the script itself is arbitrary and cannot be subject to the check mode semantics it adds C(creates)/C(removes) options as a workaround
diff_mode:
support: none
platform:
details: This action is one of the few that requires no Python on the remote as it passes the command directly into the connection string
platforms: all
raw:
support: full
safe_file_operations:
support: none
vault:
support: full
'''
EXAMPLES = r'''
- name: Run a script with arguments (free form)
ansible.builtin.script: /some/local/script.sh --some-argument 1234
- name: Run a script with arguments (using 'cmd' parameter)
ansible.builtin.script:
cmd: /some/local/script.sh --some-argument 1234
- name: Run a script only if file.txt does not exist on the remote node
ansible.builtin.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
ansible.builtin.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
ansible.builtin.script: /some/local/script
args:
executable: /some/remote/executable
- name: Run a script using an executable in a system path
ansible.builtin.script: /some/local/script.py
args:
executable: python3
- name: Run a Powershell script on a windows host
script: subdirectories/under/path/with/your/playbook/script.ps1
'''
| Name | Type | Size | Permission | Actions |
|---|---|---|---|---|
| __pycache__ | Folder | 0755 |
|
|
| __init__.py | File | 0 B | 0644 |
|
| _include.py | File | 3.06 KB | 0644 |
|
| add_host.py | File | 3.82 KB | 0644 |
|
| apt.py | File | 57.4 KB | 0644 |
|
| apt_key.py | File | 17.45 KB | 0644 |
|
| apt_repository.py | File | 28.39 KB | 0644 |
|
| assemble.py | File | 8.76 KB | 0644 |
|
| assert.py | File | 2.75 KB | 0644 |
|
| async_status.py | File | 4.29 KB | 0644 |
|
| async_wrapper.py | File | 11.43 KB | 0644 |
|
| blockinfile.py | File | 13.29 KB | 0644 |
|
| command.py | File | 12.64 KB | 0644 |
|
| copy.py | File | 34.75 KB | 0644 |
|
| cron.py | File | 25.57 KB | 0644 |
|
| debconf.py | File | 7.55 KB | 0644 |
|
| debug.py | File | 2.89 KB | 0644 |
|
| dnf.py | File | 58.16 KB | 0644 |
|
| dpkg_selections.py | File | 2.35 KB | 0644 |
|
| expect.py | File | 8.33 KB | 0644 |
|
| fail.py | File | 1.67 KB | 0644 |
|
| fetch.py | File | 4.17 KB | 0644 |
|
| file.py | File | 39.93 KB | 0644 |
|
| find.py | File | 18.73 KB | 0644 |
|
| gather_facts.py | File | 2.5 KB | 0644 |
|
| get_url.py | File | 26.22 KB | 0644 |
|
| getent.py | File | 5.56 KB | 0644 |
|
| git.py | File | 55.22 KB | 0644 |
|
| group.py | File | 19.57 KB | 0644 |
|
| group_by.py | File | 2.41 KB | 0644 |
|
| hostname.py | File | 28.12 KB | 0644 |
|
| import_playbook.py | File | 2.06 KB | 0644 |
|
| import_role.py | File | 3.27 KB | 0644 |
|
| import_tasks.py | File | 2.14 KB | 0644 |
|
| include_role.py | File | 4.15 KB | 0644 |
|
| include_tasks.py | File | 2.64 KB | 0644 |
|
| include_vars.py | File | 6.45 KB | 0644 |
|
| iptables.py | File | 32.27 KB | 0644 |
|
| known_hosts.py | File | 13.5 KB | 0644 |
|
| lineinfile.py | File | 23.39 KB | 0644 |
|
| meta.py | File | 5.84 KB | 0644 |
|
| package.py | File | 3.33 KB | 0644 |
|
| package_facts.py | File | 17.71 KB | 0644 |
|
| pause.py | File | 3.44 KB | 0644 |
|
| ping.py | File | 2.32 KB | 0644 |
|
| pip.py | File | 30 KB | 0644 |
|
| raw.py | File | 3.57 KB | 0644 |
|
| reboot.py | File | 4.64 KB | 0644 |
|
| replace.py | File | 11.19 KB | 0644 |
|
| rpm_key.py | File | 8.48 KB | 0644 |
|
| script.py | File | 4.03 KB | 0644 |
|
| service.py | File | 63.85 KB | 0644 |
|
| service_facts.py | File | 16.73 KB | 0644 |
|
| set_fact.py | File | 5.62 KB | 0644 |
|
| set_stats.py | File | 2.6 KB | 0644 |
|
| setup.py | File | 10.79 KB | 0644 |
|
| shell.py | File | 6.57 KB | 0644 |
|
| slurp.py | File | 3.19 KB | 0644 |
|
| stat.py | File | 19.62 KB | 0644 |
|
| subversion.py | File | 13.22 KB | 0644 |
|
| systemd.py | File | 22.82 KB | 0644 |
|
| systemd_service.py | File | 22.82 KB | 0644 |
|
| sysvinit.py | File | 13.47 KB | 0644 |
|
| tempfile.py | File | 3.42 KB | 0644 |
|
| template.py | File | 3.1 KB | 0644 |
|
| unarchive.py | File | 42.79 KB | 0644 |
|
| uri.py | File | 27.78 KB | 0644 |
|
| user.py | File | 114.18 KB | 0644 |
|
| validate_argument_spec.py | File | 2.99 KB | 0644 |
|
| wait_for.py | File | 25.91 KB | 0644 |
|
| wait_for_connection.py | File | 3.38 KB | 0644 |
|
| yum.py | File | 72.05 KB | 0644 |
|
| yum_repository.py | File | 24.82 KB | 0644 |
|