diff options
author | Scott Butler <sbutler@redhat.com> | 2016-09-28 15:49:17 -0700 |
---|---|---|
committer | Scott Butler <sbutler@redhat.com> | 2016-09-28 15:49:17 -0700 |
commit | 66f8fcea92415a5318e47e1a5f6d6c0553e3e881 (patch) | |
tree | 2a629bbf319704725138b1b880e5d4c6e995bb19 | |
parent | 3c42651fc737ef6d522fd1cda006af9778f62770 (diff) | |
download | ansible-66f8fcea92415a5318e47e1a5f6d6c0553e3e881.tar.gz |
Fixes issue #17759
-rw-r--r-- | docsite/rst/developing_plugins.rst | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docsite/rst/developing_plugins.rst b/docsite/rst/developing_plugins.rst index 696ba0af7b..2ba4b226dc 100644 --- a/docsite/rst/developing_plugins.rst +++ b/docsite/rst/developing_plugins.rst @@ -53,7 +53,17 @@ Plugins are loaded in alphanumeric order; for example, a plugin implemented in a Callbacks need to be whitelisted in your `ansible.cfg` file in order to function. For example:: - #callback_whitelist = timer, mail, myplugin + #callback_whitelist = timer, mail, mycallbackplugin + + +Writing to stdout +````````````````` + +If your callback plugin needs to write to stdout, you should define CALLBACK_TYPE = stdout in the subclass, and then the stdout plugin needs to be configured in `ansible.cfg` to override the default. For example:: + + #stdout_callback = mycallbackplugin + + .. _callback_development: @@ -109,12 +119,7 @@ The following example shows how Ansible's timer plugin is implemented:: runtime = end_time - self.start_time self._display.display("Playbook run took %s days, %s hours, %s minutes, %s seconds" % (self.days_hours_minutes_seconds(runtime))) -Note that the CALLBACK_VERSION and CALLBACK_NAME definitons are required. If your callback plugin needs to write to stdout, you should define CALLBACK_TYPE = stdout in the subclass, and then the stdout plugin needs to be configured in `ansible.cfg` to override the default. For example:: - - #stdout_callback = mycallbackplugin - - - +Note that the CALLBACK_VERSION and CALLBACK_NAME definitons are required. .. _developing_connection_type_plugins: |