script 969 Bytes
Newer Older
1 2 3 4

DOCUMENTATION = """
---
module: script
5
short_description: Runs a local script on a remote node after transferring it
6
description:
7 8 9 10 11 12
     - "The M(script) module takes the script name followed by a list of
       space-delimited arguments. "
     - "The local script at path will be transfered 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. "
13 14 15
options:
  free_form:
    description:
16
      - path to the local script file followed by optional arguments.
17 18 19 20
    required: true
    default: null
    aliases: []
notes:
21
  - It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points!
22 23 24
author: Michael DeHaan
"""

25 26 27 28
EXAMPLES = '''
# Example from Ansible Playbooks
- script: /some/local/script.sh --some-arguments 1234
'''