mirror of
https://github.com/ansible/ansible-documentation.git
synced 2026-04-05 14:59:02 +07:00
bf86a30bef
* Replace old communication refs with Communication guide ref or forum * Update docs/docsite/rst/community/documentation_contributions.rst Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
54 lines
1.8 KiB
ReStructuredText
54 lines
1.8 KiB
ReStructuredText
.. _action_plugins:
|
|
|
|
Action plugins
|
|
==============
|
|
|
|
.. contents::
|
|
:local:
|
|
:depth: 2
|
|
|
|
Action plugins act in conjunction with :ref:`modules <module_plugins>` 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. If necessary, you can :ref:`create custom action plugins <developing_actions>`.
|
|
|
|
.. _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 plugins are executed by default when an associated module is used; no additional 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 plugin-specific documentation and examples. This should note if the module has a corresponding action plugin.
|
|
|
|
.. seealso::
|
|
|
|
:ref:`cache_plugins`
|
|
Cache plugins
|
|
:ref:`callback_plugins`
|
|
Callback plugins
|
|
:ref:`connection_plugins`
|
|
Connection plugins
|
|
:ref:`inventory_plugins`
|
|
Inventory plugins
|
|
:ref:`shell_plugins`
|
|
Shell plugins
|
|
:ref:`strategy_plugins`
|
|
Strategy plugins
|
|
:ref:`vars_plugins`
|
|
Vars plugins
|
|
:ref:`Communication<communication>`
|
|
Got questions? Need help? Want to share your ideas? Visit the Ansible communication guide
|