Callback plugins enable adding new behaviors to Ansible when responding to events. By default, callback plugins control most of the output you see when running the command line programs, but can also be used to add additional output, integrate with other tools and marshal the events to a storage backend. If necessary, you can create custom callback plugins.
Example callback plugins
The log_plays callback is an example of how to record playbook events to a log file, and the mail callback sends email on playbook failures.
The say callback responds with computer synthesized speech in relation to playbook events.
Enabling callback plugins
You can activate a custom callback by either dropping it into a
callback_plugins directory adjacent to your play, inside a role, or by putting it in one of the callback directory sources configured in ansible.cfg.
Plugins are loaded in alphanumeric order. For example, a plugin implemented in a file named 1_first.py would run before a plugin file named 2_second.py.
Most callbacks shipped with Ansible are disabled by default and need to be enabled in your ansible.cfg file in order to function. For example:
#callbacks_enabled = timer, mail, profile_roles, collection_namespace.collection_name.custom_callback
Setting a callback plugin for
You can only have one plugin be the main manager of your console output. If you want to replace the default, you should define
CALLBACK_TYPE = stdout in the subclass and then configure the stdout plugin in ansible.cfg. For example:
stdout_callback = dense
or for my custom callback:
stdout_callback = mycallback
This only affects ansible-playbook by default.
Setting a callback plugin for ad hoc commands
The ansible ad hoc command specifically uses a different callback plugin for stdout, so there is an extra setting in Ansible Configuration Settings you need to add to use the stdout callback defined above:
You can also set this as an environment variable:
Types of callback plugins
There are three types of callback plugins:
- stdout callback plugins
These plugins handle the main console output. Only one of these can be active.
- aggregate callback plugins
Aggregate callbacks can add additional console output next to a stdout callback. This can be aggregate information at the end of a playbook run, additional per-task output, or anything else.
- notification callback plugins
Notification callbacks inform other applications, services, or systems. This can be anything from logging to databases, informing on errors in Instant Messaging applications, or sending emails when a server is unreachable.
You can use
ansible-doc -t callback -l to see the list of available plugins.
ansible-doc -t callback <plugin name> to see specific documents and examples.
- Action plugins
- Cache plugins
- Connection plugins
- Inventory plugins
- Shell plugins
- Strategy plugins
- Vars plugins
- User Mailing List
Have a question? Stop by the google group!
- Real-time chat
How to join Ansible chat channels