Action Plugins — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# Action Plugins

- Enabling Action Plugins
- Using Action Plugins
- Plugin List

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.

## 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 can use `ansible-doc -t cache -l` to see the list of available plugins. Use `ansible-doc -t cache <plugin name>` to see specific documentation and examples.

See also

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