community.general/docs/json/shell.json

{
  "requirements": [], 
  "description": [
    "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 the command through a shell (C(/bin/sh)) on the remote node."
  ], 
  "author": "Michael DeHaan", 
  "notes": [
    "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."
  ], 
  "docuri": "shell", 
  "module": "shell", 
  "filename": "library/shell", 
  "examples": [
    {
      "code": "shell somescript.sh >> somelog.txt", 
      "description": "Execute the command in remote shell"
    }
  ], 
  "version_added": "0.2", 
  "short_description": "Execute commands in nodes.", 
  "now_date": "2012-10-09", 
  "options": {
    "creates": {
      "default": null, 
      "required": false, 
      "description": [
        "a filename, when it already exists, this step will NOT be run"
      ]
    }, 
    "chdir": {
      "default": null, 
      "required": false, 
      "description": [
        "cd into this directory before running the command (0.6 and later)"
      ]
    }, 
    "(free form)": {
      "default": null, 
      "required": null, 
      "description": [
        "The command module takes a free form command to run"
      ]
    }
  }, 
  "ansible_version": "0.8"
}