diff options
| author | Felix Fontein <felix@fontein.de> | 2023-01-18 22:32:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-18 15:32:47 -0600 |
| commit | f9ae08ad001652fec41a6d163a00a16125b6c83c (patch) | |
| tree | 8769cc266c39e72d4add9441d12be3ff7cee1a86 | |
| parent | 865b457a6e7c5d14ceda53b7248603d3d44c7c4f (diff) | |
| download | ansible-f9ae08ad001652fec41a6d163a00a16125b6c83c.tar.gz | |
Document callback types in documentation (#79651) (#79655)
(cherry picked from commit 51bddd862bfdac9e6cefca854b6f2917cfc2715d)
| -rw-r--r-- | docs/docsite/rst/plugins/callback.rst | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/docsite/rst/plugins/callback.rst b/docs/docsite/rst/plugins/callback.rst index f86469af28..98e4beb754 100644 --- a/docs/docsite/rst/plugins/callback.rst +++ b/docs/docsite/rst/plugins/callback.rst @@ -36,7 +36,7 @@ Most callbacks shipped with Ansible are disabled by default and need to be enabl Setting a callback plugin for ``ansible-playbook`` -------------------------------------------------- -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 :ref:`ansible.cfg <ansible_configuration_settings>`. For example: +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 :ref:`ansible.cfg <ansible_configuration_settings>`. For example: .. code-block:: ini @@ -67,6 +67,25 @@ You can also set this as an environment variable: export ANSIBLE_LOAD_CALLBACK_PLUGINS=1 +.. _callback_plugin_types: + +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. + .. _callback_plugin_list: Plugin list |