ansible/library/shell

48 lines
1.6 KiB
Text
Raw Normal View History

# There is actually no actual shell module source, when you use 'shell' in ansible,
# it runs the 'command' module with special arguments and it behaves differently.
# See the command source and the comment "#USE_SHELL".
2012-09-29 20:40:06 +02:00
DOCUMENTATION = '''
---
module: shell
short_description: Execute commands in nodes.
description:
2012-10-01 09:18:54 +02:00
- The shell module takes the command name followed by a list of arguments,
space delimited. It is almost exactly like the M(command) module but runs
2012-10-05 14:59:49 +02:00
the command through a shell (C(/bin/sh)) on the remote node.
2012-10-01 09:18:54 +02:00
version_added: "0.2"
2012-09-29 20:40:06 +02:00
options:
(free form):
description:
- The command module takes a free form command to run
required: null
default: null
creates:
description:
- a filename, when it already exists, this step will NOT be run
required: false
default: null
chdir:
description:
- cd into this directory before running the command (0.6 and later)
required: false
default: null
executable:
description:
- change the shell used to execute the command. Should be an absolute path to the executable.
required: false
default: null
version_added: "0.9"
2012-09-29 20:40:06 +02:00
examples:
- code: "shell: somescript.sh >> somelog.txt"
2012-09-29 20:40:06 +02:00
description: Execute the command in remote shell
notes:
2012-10-01 09:18:54 +02:00
- If you want to execute a command securely and predicably, it may be
better to use the M(command) module instead. Best practices when writing
playbooks will follow the trend of using M(command) unless M(shell) is
explicitly required. When running ad-hoc commands, use your best
judgement.
2012-09-29 20:40:06 +02:00
requirements: [ ]
author: Michael DeHaan
2012-10-01 09:18:54 +02:00
'''