Ansible Runner Documentation
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)[source]
The class AnsibleJSONEncoder exists in Ansible core for this function
this performs a mostly identical function via duck typing
-
default(o)[source]
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[source]
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)[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
-
v2_runner_on_unreachable(result)[source]
-
v2_runner_retry(result)[source]
-
class ansible_runner.display_callback.callback.awx_display.EventContext[source]
Store global and local (per thread/process) data associated with callback
events and other display output methods.
-
add_global(**kwargs)[source]
-
add_local(**kwargs)[source]
-
dump(fileobj, data, max_width=78, flush=False)[source]
-
dump_begin(fileobj)[source]
-
dump_end(fileobj)[source]
-
get()[source]
-
get_begin_dict()[source]
-
get_end_dict()[source]
-
get_global()[source]
-
get_local()[source]
-
remove_global(**kwargs)[source]
-
remove_local(**kwargs)[source]
-
set_global(**kwargs)[source]
-
set_local(**kwargs)[source]
-
class ansible_runner.display_callback.callback.awx_display.IsolatedFileWrite[source]
Class that will write partial event data to a file
-
set(key, value)[source]
-
ansible_runner.display_callback.callback.awx_display.current_time()[source]
-
ansible_runner.display_callback.callback.awx_display.display_with_context(f)[source]
-
ansible_runner.display_callback.callback.awx_display.with_context(**context)[source]
-
ansible_runner.display_callback.callback.awx_display.with_verbosity(f)[source]