ansible/docs/docsite/rst/plugins/shell.rst
Alicia Cozine e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 14:03:00 -06:00

1.9 KiB

Shell Plugins

Shell plugins work to ensure that the basic commands Ansible runs are properly formatted to work with the target machine and allow the user to configure certain behaviors related to how Ansible executes tasks.

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 <ansible_configuration_settings>.

Warning

You should not alter which plugin is used unless you have a setup in which the default /bin/sh is not a POSIX compatible shell or is not available for execution.

Using shell plugins

In addition to the default configuration settings in ansible_configuration_settings, you can use the connection variable ansible_shell_type <ansible_shell_type> to select the plugin to use. In this case, you will also want to update the ansible_shell_executable <ansible_shell_executable> to match.

You can further control the settings for each plugin via other configuration options detailed in the plugin themselves (linked below).

maxdepth

1

shell/*

about_playbooks

An introduction to playbooks

inventory_plugins

Ansible inventory plugins

callback_plugins

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