ansible_runner.display_callback package

Submodules

ansible_runner.display_callback.display module

ansible_runner.display_callback.events module

ansible_runner.display_callback.minimal module

class ansible_runner.display_callback.minimal.CallbackModule(display=None, options=None)

Bases: ansible.plugins.callback.CallbackBase

This is the default callback interface, which simply prints messages to stdout when new callback events are received.

CALLBACK_NAME = 'minimal'
CALLBACK_TYPE = 'stdout'
CALLBACK_VERSION = 2.0
v2_on_file_diff(result)
v2_runner_on_failed(result, ignore_errors=False)
v2_runner_on_ok(result)
v2_runner_on_skipped(result)
v2_runner_on_unreachable(result)

ansible_runner.display_callback.module module

class ansible_runner.display_callback.module.AWXDefaultCallbackModule[source]

Bases: ansible_runner.display_callback.module.BaseCallbackModule, ansible.plugins.callback.default.CallbackModule

CALLBACK_NAME = 'awx_display'
class ansible_runner.display_callback.module.AWXMinimalCallbackModule[source]

Bases: ansible_runner.display_callback.module.BaseCallbackModule, ansible_runner.display_callback.minimal.CallbackModule

CALLBACK_NAME = 'minimal'
v2_playbook_on_play_start(play)[source]
v2_playbook_on_task_start(task, is_conditional)[source]
class ansible_runner.display_callback.module.BaseCallbackModule[source]

Bases: ansible.plugins.callback.CallbackBase

Callback module for logging ansible/ansible-playbook events.

CALLBACK_TYPE = 'stdout'
CALLBACK_VERSION = 2.0
EVENTS_WITHOUT_PLAY = ['playbook_on_start', 'playbook_on_stats']
EVENTS_WITHOUT_TASK = ['playbook_on_start', 'playbook_on_stats', 'playbook_on_setup', 'playbook_on_notify', 'playbook_on_import_for_host', 'playbook_on_not_import_for_host', 'playbook_on_no_hosts_matched', 'playbook_on_no_hosts_remaining']
capture_event_data(event, **event_data)[source]
clear_play()[source]
clear_task(local=False)[source]
set_play(play)[source]
set_playbook(playbook)[source]
set_task(task, local=False)[source]
v2_on_file_diff(result)[source]
v2_playbook_on_cleanup_task_start(task)[source]
v2_playbook_on_handler_task_start(task)[source]
v2_playbook_on_import_for_host(result, imported_file)[source]
v2_playbook_on_include(included_file)[source]
v2_playbook_on_no_hosts_matched()[source]
v2_playbook_on_no_hosts_remaining()[source]
v2_playbook_on_not_import_for_host(result, missing_file)[source]
v2_playbook_on_notify(handler, host)[source]
v2_playbook_on_play_start(play)[source]
v2_playbook_on_setup()[source]
v2_playbook_on_start(playbook)[source]
v2_playbook_on_stats(stats)[source]
v2_playbook_on_task_start(task, is_conditional)[source]
v2_playbook_on_vars_prompt(varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None, unsafe=None)[source]
v2_runner_item_on_failed(result)[source]
v2_runner_item_on_ok(result)[source]
v2_runner_item_on_skipped(result)[source]
v2_runner_on_async_failed(result)[source]
v2_runner_on_async_ok(result)[source]
v2_runner_on_async_poll(result)[source]
v2_runner_on_failed(result, ignore_errors=False)[source]
v2_runner_on_file_diff(result, diff)[source]
v2_runner_on_no_hosts(task)[source]
v2_runner_on_ok(result)[source]
v2_runner_on_skipped(result)[source]
v2_runner_on_start(host, task)[source]

Event used when host begins execution of a task

New in version 2.8.

v2_runner_on_unreachable(result)[source]
v2_runner_retry(result)[source]
ansible_runner.display_callback.module.current_time()[source]

Module contents

class ansible_runner.display_callback.AWXDefaultCallbackModule[source]

Bases: ansible_runner.display_callback.module.BaseCallbackModule, ansible.plugins.callback.default.CallbackModule

CALLBACK_NAME = 'awx_display'
class ansible_runner.display_callback.AWXMinimalCallbackModule[source]

Bases: ansible_runner.display_callback.module.BaseCallbackModule, ansible_runner.display_callback.minimal.CallbackModule

CALLBACK_NAME = 'minimal'
v2_playbook_on_play_start(play)[source]
v2_playbook_on_task_start(task, is_conditional)[source]