Documentation homepage Last update: Sep 22, 2021

Action plugins

Action plugins act in conjunction 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. If necessary, you can create custom action plugins.

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.

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:

cache_plugins Cache plugins

callback_plugins Callback plugins

connection_plugins Connection plugins

inventory_plugins Inventory plugins

shell_plugins Shell plugins

strategy_plugins Strategy plugins

vars_plugins Vars plugins User Mailing List Have a question? Stop by the google group!

communication_irc How to join Ansible chat channels