Skip to content

default

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version historical.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

  • This is the default output callback for ansible-playbook.

Requirements

The following Python packages are needed on the host that executes this module:

Parameters

Parameter Defaults / Choices Comments
check_mode_markers
bool
Toggle to control displaying markers when running in check mode.
The markers are C(DRY RUN) at the beginning and ending of playbook execution (when calling C(ansible-playbook --check)) and C(CHECK MODE) as a suffix at every play and task that is run in check mode.
Env: ANSIBLE_CHECK_MODE_MARKERS
Version Added: 2.9
display_failed_stderr
bool
Toggle to control whether failed and unreachable tasks are displayed to STDERR rather than STDOUT.
Env: ANSIBLE_DISPLAY_FAILED_STDERR
Version Added: 2.7
display_ok_hosts
bool
Default: True
Toggle to control displaying 'ok' task/host results in a task.
Env: ANSIBLE_DISPLAY_OK_HOSTS
Version Added: 2.7
display_skipped_hosts
bool
Default: True
Toggle to control displaying skipped task/host results in a task.
Env: ANSIBLE_DISPLAY_SKIPPED_HOSTS
pretty_results
bool
Configure the result format to be more readable.
When O(result_format) is set to V(yaml) this option defaults to V(true), and defaults to V(false) when configured to V(json).
Setting this option to V(true) will force V(json) and V(yaml) results to always be pretty printed regardless of verbosity.
When set to V(true) and used with the V(yaml) result format, this option will modify module responses in an attempt to produce a more human friendly output at the expense of correctness, and should not be relied upon to aid in writing variable manipulations or conditionals. For correctness, set this option to V(false) or set O(result_format) to V(json).
Env: ANSIBLE_CALLBACK_FORMAT_PRETTY
Version Added: 2.13
result_format
str
Default: json
Choices: json, yaml
Define the task result format used in the callback output.
These formats do not cause the callback to emit valid JSON or YAML formats.
The output contains these formats interspersed with other non-machine parsable data.
Env: ANSIBLE_CALLBACK_RESULT_FORMAT
Version Added: 2.13
show_custom_stats
bool
This adds the custom stats set via the set_stats plugin to the play recap.
Env: ANSIBLE_SHOW_CUSTOM_STATS
show_per_host_start
bool
This adds output that shows when a task starts to execute for each host.
Env: ANSIBLE_SHOW_PER_HOST_START
Version Added: 2.9
show_task_path_on_failure
bool
When a task fails, display the path to the file containing the failed task and the line number. This information is displayed automatically for every task when running with C(-vv) or greater verbosity.
Env: ANSIBLE_SHOW_TASK_PATH_ON_FAILURE
Version Added: 2.11