ansible/docs/docsite/rst/plugins/shell.rst
Brian Coca 2ed46e04f4 more updates to plugin/config generation (#30787)
* fixed module generation

added missing lookup page
point to plugins when plugins
made modules singular
add display for verbose an debug messages
nicer templating, changed generation order for ref
corrected links
moved most of lookup docs to plugin section

* Copy edits
* Fixed typos
* Clarified wording
2017-10-11 00:15:25 -04:00

1.5 KiB

Shell Plugins

Shell plugins work transparently to ensure that the basic commands Ansible runs are properly formatted to work with the target machine.

Enabling Shell Plugins

You can add a custom shell plugin by dropping it into a shell_plugins directory adjacent to your play, inside a role, or by putting it in one of the shell plugin directory sources configured in ansible.cfg <../config>.

Warning

You should not alter the configuration for these plugins unless you have a setup in which the default /bin/sh is not a POSIX compatible shell or is not availble for execution.

Using Shell Plugins

In addition to the default configuration settings in ../config, you can use a 'connection variable' ansible_shell_type to select the plugin to use. In this case, you will also want to update the ansible_executable to match.

../playbooks

An introduction to playbooks

inventory

Ansible inventory plugins

callback

Ansible callback plugins

../playbooks_filters

Jinja2 filter plugins

../playbooks_tests

Jinja2 test plugins

../playbooks_lookups

Jinja2 lookup plugins

User Mailing List

Have a question? Stop by the google group!

irc.freenode.net

#ansible IRC chat channel