ansible/docs/docsite/rst/plugins/action.rst
Alicia Cozine e700309618
Refine plugin docs (#49324)
* local TOCs, anchors, better headings, :ref:-not-:doc: links on all plugin pages
2018-11-29 14:03:00 -06:00

1.8 KiB

Action Plugins

Action plugins act in conjunction with 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 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 ansible.cfg <ansible_configuration_settings>.

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.

cache_plugins

Ansible Cache plugins

callback_plugins

Ansible callback plugins

connection_plugins

Ansible connection plugins

inventory_plugins

Ansible inventory plugins

shell_plugins

Ansible Shell plugins

strategy_plugins

Ansible Strategy plugins

vars_plugins

Ansible Vars plugins

User Mailing List

Have a question? Stop by the google group!

irc.freenode.net

#ansible IRC chat channel