internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 05:42:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

more updates to plugin/config generation (#30787)

Browse Source 
* 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
This commit is contained in:
Brian Coca
2017-10-11 00:15:25 -04:00
committed by GitHub
parent 3886f80e44
commit 2ed46e04f4
16 changed files with 345 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docsite/rst/plugins/shell.rst
View File

@@ -1,15 +1,27 @@
Shell Plugins
-------------
Shell plugins work transparently to ensure that the basic commands Ansible runs are properly formated to work with the target machine.
Shell plugins work transparently to ensure that the basic commands Ansible runs are properly formatted to work with the target machine.
.. _enabling_shell:
Enabling Shell Plugins
++++++++++++++++++++++
.. warning:: These plugins should not be reconfigured unless you have a restricted or exotic setup
in which the default ``/bin/sh`` is not a POSIX compatible shell or not availble for execution.
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>`.
In addition to modifying the default configuration settings in :doc:`../config`, you can use a 'connection variable' :ref:`ansible_shell_type` to select a shell plugin, and update the :ref:`ansible_executable` to match.
.. 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:
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.
.. seealso::