Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added DOCUMENTATION to shell module. #1143

Merged
merged 1 commit into from
Sep 29, 2012
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 32 additions & 0 deletions library/shell
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# 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".

DOCUMENTATION = '''
---
module: shell
short_description: Execute commands in nodes.
description:
- The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the command module but runs the command through the user's configured shell on the remote node.
version_added: "0.0.2"
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
examples:
- code: shell somescript.sh >> somelog.txt
description: Execute the command in remote shell
notes:
- If you want to execute a command securely and predicably, it may be better to use the '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.
requirements: [ ]
author: Michael DeHaan
'''