ansible.builtin.script (v2.6.2) — module

Install Ansible via pip

Install with pip install ansible==2.6.2

Description

The C(script) module takes the script name followed by a list of space-delimited arguments.

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(raw) module.

This module is also supported for Windows targets.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Example from Ansible Playbooks
- script: /some/local/script.sh --some-arguments 1234

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Run a script that creates a file, but only if the file is not yet created
- script: /some/local/create_file.sh --some-arguments 1234
  args:
    creates: /the/created/file.txt

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Run a script that removes a file, but only if the file is not yet removed
- script: /some/local/remove_file.sh --some-arguments 1234
  args:
    removes: /the/removed/file.txt

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Run a script using a executable in a non-system path
- script: /some/local/script
  args:
    executable: /some/remote/executable

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Run a script using a executable in a system path
- script: /some/local/script.py
  args:
    executable: python3

Inputs

    
chdir:
    description:
    - cd into this directory on the remote node before running the script
    version_added: '2.4'
    version_added_collection: ansible.builtin

creates:
    description:
    - a filename, when it already exists, this step will B(not) be run.
    version_added: '1.5'
    version_added_collection: ansible.builtin

decrypt:
    default: true
    description:
    - This option controls the autodecryption of source files using vault.
    type: bool
    version_added: '2.4'
    version_added_collection: ansible.builtin

removes:
    description:
    - a filename, when it does not exist, this step will B(not) be run.
    version_added: '1.5'
    version_added_collection: ansible.builtin

free_form:
    description:
    - Path to the local script file followed by optional arguments. There is no parameter
      actually named 'free form'; see the examples!
    required: true

executable:
    description:
    - Name or path of a executable to invoke the script with
    version_added: '2.6'
    version_added_collection: ansible.builtin