ansible_runner.display_callback package

Submodules

ansible_runner.display_callback.callback.awx_display module

class ansible_runner.display_callback.callback.awx_display.AnsibleJSONEncoderLocal(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

The class AnsibleJSONEncoder exists in Ansible core for this function this performs a mostly identical function via duck typing

default(o)

Returns JSON-valid representation for special Ansible python objects which including vault objects and datetime objects

class ansible_runner.display_callback.callback.awx_display.CallbackModule

Callback module for logging ansible/ansible-playbook events.

CALLBACK_NAME = 'awx_display'

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)

clear_play()

clear_task(local=False)

set_options(*args, **kwargs)

This is different than the normal plugin method as callbacks get called early and really don’t accept keywords. Also _options was already taken for CLI args and callbacks use _plugin_options instead.

set_play(play)

set_playbook(playbook)

set_task(task, local=False)

v2_on_file_diff(result)

v2_playbook_on_cleanup_task_start(task)

v2_playbook_on_handler_task_start(task)

v2_playbook_on_import_for_host(result, imported_file)

v2_playbook_on_include(included_file)

v2_playbook_on_no_hosts_matched()

v2_playbook_on_no_hosts_remaining()

v2_playbook_on_not_import_for_host(result, missing_file)

v2_playbook_on_notify(handler, host)

v2_playbook_on_play_start(play)

v2_playbook_on_setup()

v2_playbook_on_start(playbook)

v2_playbook_on_stats(stats)

v2_playbook_on_task_start(task, is_conditional)

v2_playbook_on_vars_prompt(varname, private=True, prompt=None, encrypt=None, confirm=False, salt_size=None, salt=None, default=None, unsafe=None)

v2_runner_item_on_failed(result)

v2_runner_item_on_ok(result)

v2_runner_item_on_skipped(result)

v2_runner_on_async_failed(result)

v2_runner_on_async_ok(result)

v2_runner_on_async_poll(result)

v2_runner_on_failed(result, ignore_errors=False)

v2_runner_on_file_diff(result, diff)

v2_runner_on_no_hosts(task)

v2_runner_on_ok(result)

v2_runner_on_skipped(result)

v2_runner_on_start(host, task)

Event used when host begins execution of a task

Added in version 2.8.

v2_runner_on_unreachable(result)

v2_runner_retry(result)

class ansible_runner.display_callback.callback.awx_display.EventContext

Store global and local (per thread/process) data associated with callback events and other display output methods.

add_global(**kwargs)

add_local(**kwargs)

dump(fileobj, data, max_width=78, flush=False)

dump_begin(fileobj)

dump_end(fileobj)

get()

get_begin_dict()

get_end_dict()

get_global()

get_local()

remove_global(**kwargs)

remove_local(**kwargs)

set_global(**kwargs)

set_local(**kwargs)

class ansible_runner.display_callback.callback.awx_display.IsolatedFileWrite

Class that will write partial event data to a file

set(key, value)

ansible_runner.display_callback.callback.awx_display.current_time()

ansible_runner.display_callback.callback.awx_display.display_with_context(f)

ansible_runner.display_callback.callback.awx_display.with_context(**context)

ansible_runner.display_callback.callback.awx_display.with_verbosity(f)

Module contents