mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
56 lines
1.8 KiB
ReStructuredText
56 lines
1.8 KiB
ReStructuredText
.. _action_plugins:
|
|
|
|
Action Plugins
|
|
==============
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Action plugins act in conjunction with :ref:`modules <working_with_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 :ref:`ansible.cfg <ansible_configuration_settings>`.
|
|
|
|
.. _using_action:
|
|
|
|
Using action plugins
|
|
--------------------
|
|
|
|
Action plugin are executed by default when an associated module is used; no action is required.
|
|
|
|
Plugin list
|
|
-----------
|
|
|
|
You cannot list action plugins directly, they show up as their counterpart modules:
|
|
|
|
Use ``ansible-doc -l`` to see the list of available modules.
|
|
Use ``ansible-doc <name>`` to see specific documentation and examples, this should note if the module has a corresponding action plugin.
|
|
|
|
.. seealso::
|
|
|
|
:ref:`cache_plugins`
|
|
Ansible Cache plugins
|
|
:ref:`callback_plugins`
|
|
Ansible callback plugins
|
|
:ref:`connection_plugins`
|
|
Ansible connection plugins
|
|
:ref:`inventory_plugins`
|
|
Ansible inventory plugins
|
|
:ref:`shell_plugins`
|
|
Ansible Shell plugins
|
|
:ref:`strategy_plugins`
|
|
Ansible Strategy plugins
|
|
:ref:`vars_plugins`
|
|
Ansible Vars plugins
|
|
`User Mailing List <https://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
|