mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
373b1dcf59
* 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
57 lines
1.6 KiB
ReStructuredText
57 lines
1.6 KiB
ReStructuredText
Action Plugins
|
|
==============
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Action plugins act in conjunction with :doc:`modules <../modules>` to execute the actions required by playbook tasks.
|
|
They usually execute automatically in the background doing prerequisite work before modules execute.
|
|
|
|
The 'normal' action plugin is used for modules that do not already have an action plugin.
|
|
|
|
.. _enabling_action:
|
|
|
|
Enabling Action Plugins
|
|
-----------------------
|
|
|
|
You can enable a custom action plugin by either dropping it into the ``action_plugins`` directory adjacent to your play, inside a role, or by putting it in one of the action plugin directory sources configured in :doc:`ansible.cfg <../config>`.
|
|
|
|
.. _using_action:
|
|
|
|
Using Action Plugins
|
|
--------------------
|
|
|
|
Action plugin are executed by default when an associated module is used; no action is required.
|
|
|
|
Plugin List
|
|
-----------
|
|
|
|
You can use ``ansible-doc -t cache -l`` to see the list of available plugins.
|
|
Use ``ansible-doc -t cache <plugin name>`` to see specific documentation and examples.
|
|
|
|
.. toctree:: :maxdepth: 1
|
|
:glob:
|
|
|
|
action/*
|
|
|
|
.. seealso::
|
|
|
|
:doc:`cache`
|
|
Ansible Cache plugins
|
|
:doc:`callback`
|
|
Ansible callback plugins
|
|
:doc:`connection`
|
|
Ansible connection plugins
|
|
:doc:`inventory`
|
|
Ansible inventory plugins
|
|
:doc:`shell`
|
|
Ansible Shell plugins
|
|
:doc:`strategy`
|
|
Ansible Strategy plugins
|
|
:doc:`vars`
|
|
Ansible Vars 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
|