mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
12bf9a8b69
The idea is that some plugin would not be called in some specific case, and the callback should decide by itself. Having a way to globally disable it is much cleaner than disabling every method one by one on the plugin side. My use case is for fedora-infrastructure that cannot be run from git checkout since it try to connect to the message bus, but another case would be to bootstrap infrastructure, or to run the code on a test servers without having all the callback infrastructure setup.
97 lines
2.5 KiB
Python
97 lines
2.5 KiB
Python
# (C) 2012-2013, Michael DeHaan, <michael.dehaan@gmail.com>
|
|
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
class CallbackModule(object):
|
|
|
|
"""
|
|
this is an example ansible callback file that does nothing. You can drop
|
|
other classes in the same directory to define your own handlers. Methods
|
|
you do not use can be omitted. If self.disabled is set to True, the plugin
|
|
methods will not be called.
|
|
|
|
example uses include: logging, emailing, storing info, etc
|
|
"""
|
|
|
|
def __init__(self):
|
|
#if foo:
|
|
# self.disabled = True
|
|
pass
|
|
|
|
def on_any(self, *args, **kwargs):
|
|
pass
|
|
|
|
def runner_on_failed(self, host, res, ignore_errors=False):
|
|
pass
|
|
|
|
def runner_on_ok(self, host, res):
|
|
pass
|
|
|
|
def runner_on_error(self, host, msg):
|
|
pass
|
|
|
|
def runner_on_skipped(self, host, item=None):
|
|
pass
|
|
|
|
def runner_on_unreachable(self, host, res):
|
|
pass
|
|
|
|
def runner_on_no_hosts(self):
|
|
pass
|
|
|
|
def runner_on_async_poll(self, host, res, jid, clock):
|
|
pass
|
|
|
|
def runner_on_async_ok(self, host, res, jid):
|
|
pass
|
|
|
|
def runner_on_async_failed(self, host, res, jid):
|
|
pass
|
|
|
|
def playbook_on_start(self):
|
|
pass
|
|
|
|
def playbook_on_notify(self, host, handler):
|
|
pass
|
|
|
|
def playbook_on_no_hosts_matched(self):
|
|
pass
|
|
|
|
def playbook_on_no_hosts_remaining(self):
|
|
pass
|
|
|
|
def playbook_on_task_start(self, name, is_conditional):
|
|
pass
|
|
|
|
def playbook_on_vars_prompt(self, varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None):
|
|
pass
|
|
|
|
def playbook_on_setup(self):
|
|
pass
|
|
|
|
def playbook_on_import_for_host(self, host, imported_file):
|
|
pass
|
|
|
|
def playbook_on_not_import_for_host(self, host, missing_file):
|
|
pass
|
|
|
|
def playbook_on_play_start(self, pattern):
|
|
pass
|
|
|
|
def playbook_on_stats(self, stats):
|
|
pass
|
|
|