mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
bdbb89378f
* centralize doc/config plugin lists also update list for generation in docsite added note to ensure they are in sync * updated shell page to list plugins added some more docs hinting at plugins being configurable * fix edit link for plugins
54 lines
1.8 KiB
ReStructuredText
54 lines
1.8 KiB
ReStructuredText
.. contents:: Topics
|
|
|
|
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 behaviours related to how Ansible executes tasks.
|
|
|
|
.. _enabling_shell:
|
|
|
|
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 :doc:`ansible.cfg <../config>`.
|
|
|
|
.. 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 availble for execution.
|
|
|
|
.. _using_shell:
|
|
|
|
Using Shell Plugins
|
|
+++++++++++++++++++
|
|
|
|
In addition to the default configuration settings in :doc:`../config`, you can use
|
|
a 'connection variable' :ref:`ansible_shell_type` to select the plugin to use.
|
|
In this case, you will also want to update the :ref:`ansible_executable` to match.
|
|
|
|
You can further control the settings for each plugin via other configuration options
|
|
detailed in the plugin themsleves (linked below).
|
|
|
|
.. toctree:: :maxdepth: 1
|
|
:glob:
|
|
|
|
shell/*
|
|
|
|
.. seealso::
|
|
|
|
:doc:`../user_guide/playbooks`
|
|
An introduction to playbooks
|
|
:doc:`inventory`
|
|
Ansible inventory plugins
|
|
:doc:`callback`
|
|
Ansible callback plugins
|
|
:doc:`../user_guide/playbooks_filters`
|
|
Jinja2 filter plugins
|
|
:doc:`../user_guide/playbooks_tests`
|
|
Jinja2 test plugins
|
|
:doc:`../user_guide/playbooks_lookups`
|
|
Jinja2 lookup plugins
|
|
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
|
Have a question? Stop by the google group!
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|