ansible/docs/docsite/rst/plugins/shell.rst
scottb 373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08: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.

../user_guide/playbooks

An introduction to playbooks

inventory

Ansible inventory plugins

callback

Ansible callback plugins

../user_guide/playbooks_filters

Jinja2 filter plugins

../user_guide/playbooks_tests

Jinja2 test plugins

../user_guide/playbooks_lookups

Jinja2 lookup plugins

User Mailing List

Have a question? Stop by the google group!

irc.freenode.net

#ansible IRC chat channel