script – Runs a local script on a remote node after transferring it

• Synopsis
• Parameters
• Notes
• See Also
• Examples
• Status

Synopsis

• 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 raw module.
• This module is also supported for Windows targets.

Parameters

Notes

See Also

Examples

- 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

Status

• This module is guaranteed to have backward compatible interface changes going forward. [stableinterface]
• This module is maintained by the Ansible Core Team. [core]

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

• Ansible Core Team
• Michael DeHaan