You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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 plugin-specific documentation and examples. This should note if the module has a corresponding action plugin.

See also

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!
Real-time chat: How to join Ansible chat channels