mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
b233f3f296
* updated docs - for devs: - added inventory/vars section - made some updates to general section and other plugin types - for users: - added 'user' plugin section to start describing the plugins - docs on types, what they are and how to use - removed ref to deleted AUTHORS file - corrected several typos/headers - added descriptions to config.rst template - ignore generated files for cli/plugins and config - remove new generated files on `make clean` - moved details from devguid and intro doc to plugin specific pages - pretied up lookup notes - changed precedence ref to not conflict config - removed duplicate config data, as config is autogenerated and up to date - put new plugins under playbooks - added `pass` cause rst/python dislikes fractions - removed dupe in .gitignore, alpha sorted to avoid moar dupes - added try cause rst/python freaks out * generate plugins into their own dir only do plugins that support docs use toctree from main plugins page
107 lines
3.2 KiB
ReStructuredText
107 lines
3.2 KiB
ReStructuredText
.. contents:: Topics
|
|
|
|
|
|
Callback Plugins
|
|
----------------
|
|
|
|
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 marshall the events to a storage backend.
|
|
|
|
.. _callback_examples:
|
|
|
|
Example Callback Plugins
|
|
++++++++++++++++++++++++
|
|
|
|
The :doc:`log_plays <callback/log_plays>` callback is an example of how to record playbook events to a log file,
|
|
and the :doc:`mail callback/mail` callback sends email on playbook failures.
|
|
|
|
The :doc:`osx_say <callback/oxs_say>` callback provided is particularly entertaining --
|
|
it will respond with computer synthesized speech on OS X in relation to playbook events,
|
|
and is guaranteed to entertain and/or annoy coworkers.
|
|
|
|
|
|
.. _enabling_callbacks:
|
|
|
|
Enabling Callback Plugins
|
|
++++++++++++++++++++++++++
|
|
|
|
You can activate a custom callback by either dropping it into a ``callback_plugins`` directory adjacent to your play or inside a role
|
|
or by putting it in one of the callback directory sources configured in :doc:`ansible.cfg <../config>`.
|
|
|
|
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 whitelisted in your :doc:`ansible.cfg <../config>` file in order to function.
|
|
For example:
|
|
|
|
.. code-block:: ini
|
|
|
|
#callback_whitelist = timer, mail, profile_roles
|
|
|
|
|
|
Managing stdout
|
|
```````````````
|
|
|
|
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 :doc:`ansible.cfg <../config>`. For example:
|
|
|
|
.. code-block:: ini
|
|
|
|
stdout_callback = dense
|
|
|
|
or for my custom callback:
|
|
|
|
.. code-block:: ini
|
|
|
|
stdout_callback = mycallback
|
|
|
|
This only affects :doc:`../ansible-playbook` by default.
|
|
|
|
Managing AdHoc
|
|
``````````````
|
|
|
|
The :doc:`ansible <../ansible>` AdHoc command speifically uses a different callback plugin for stdout,
|
|
so there is an extra setting you need to enable it to use the stdout callback defined above, in :doc:`ansible.cfg <../config>`:
|
|
|
|
.. code-block:: ini
|
|
|
|
[defaults]
|
|
bin_ansible_callbacks=True
|
|
|
|
or as an environment variable:
|
|
|
|
.. code-block:: shell
|
|
|
|
export ANSIBLE_LOAD_CALLBACK_PLUGINS=1
|
|
|
|
|
|
Plugin List
|
|
+++++++++++
|
|
|
|
You can use ``ansible-doc -t callback -l`` to see the list of available plugins,
|
|
use ``ansible-doc -t callback <plugin name>`` to see specific documents and examples.
|
|
|
|
|
|
.. toctree:: :maxdepth: 1
|
|
:glob:
|
|
|
|
callback/*
|
|
|
|
|
|
.. seealso::
|
|
|
|
:doc:`../playbooks`
|
|
An introduction to playbooks
|
|
:doc:`inventory`
|
|
Ansible inventory plugins
|
|
:doc:`../playbooks_filters`
|
|
Jinja2 filter plugins
|
|
:doc:`../playbooks_tests`
|
|
Jinja2 test plugins
|
|
:doc:`../playbooks_lookups`
|
|
Jinja2 lookup plugins
|
|
:doc:`vars`
|
|
Ansible vars plugins
|
|
`User Mailing List <http://groups.google.com/group/ansible-devel>`_
|
|
Have a question? Stop by the google group!
|
|
`irc.freenode.net <http://irc.freenode.net>`_
|
|
#ansible IRC chat channel
|