mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
28 lines
981 B
Plaintext
28 lines
981 B
Plaintext
12 years ago
|
|
||
|
DOCUMENTATION = """
|
||
|
---
|
||
|
module: script
|
||
12 years ago
|
short_description: Runs a local script on a remote node after transferring it
|
||
12 years ago
|
description:
|
||
12 years ago
|
- The M(script) module takes the script name followed by a list of
|
||
|
space-delimited arguments.
|
||
12 years ago
|
- The pathed local script will be transfered to the remote node and then executed.
|
||
|
- The given script will be processed through the shell environment on the remote node.
|
||
12 years ago
|
- This module does not require python on the remote system, much like
|
||
|
the M(raw) module.
|
||
12 years ago
|
options:
|
||
|
free_form:
|
||
|
description:
|
||
12 years ago
|
- path to the local script file followed by optional arguments.
|
||
12 years ago
|
required: true
|
||
|
default: null
|
||
|
aliases: []
|
||
|
examples:
|
||
|
- description: "Example from Ansible Playbooks"
|
||
12 years ago
|
code: "action: script /some/local/script.sh --some-arguments 1234"
|
||
12 years ago
|
notes:
|
||
12 years ago
|
- It is usually preferable to write Ansible modules than pushing scripts. Convert your script to an Ansible module for bonus points!
|
||
12 years ago
|
author: Michael DeHaan
|
||
|
"""
|
||
|
|