ansible.builtin.default (v2.16.0) — callback

Install Ansible via pip

Install with pip install ansible-core==2.16.0

Description

This is the default output callback for ansible-playbook.

Requirements

• set as stdout in configuration

Inputs

    
result_format:
    choices:
    - json
    - yaml
    default: json
    description:
    - 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:
    - name: ANSIBLE_CALLBACK_RESULT_FORMAT
    ini:
    - key: callback_result_format
      section: defaults
    name: Format of the task result
    type: str
    version_added: '2.13'
    version_added_collection: ansible.builtin

pretty_results:
    default: null
    description:
    - 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:
    - name: ANSIBLE_CALLBACK_FORMAT_PRETTY
    ini:
    - key: callback_format_pretty
      section: defaults
    name: Configure output for readability
    type: bool
    version_added: '2.13'
    version_added_collection: ansible.builtin

display_ok_hosts:
    default: true
    description: Toggle to control displaying 'ok' task/host results in a task
    env:
    - name: ANSIBLE_DISPLAY_OK_HOSTS
    ini:
    - key: display_ok_hosts
      section: defaults
    name: Show 'ok' hosts
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

show_custom_stats:
    default: false
    description: This adds the custom stats set via the set_stats plugin to the play recap
    env:
    - name: ANSIBLE_SHOW_CUSTOM_STATS
    ini:
    - key: show_custom_stats
      section: defaults
    name: Show custom stats
    type: bool

check_mode_markers:
    default: false
    description:
    - 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:
    - name: ANSIBLE_CHECK_MODE_MARKERS
    ini:
    - key: check_mode_markers
      section: defaults
    name: Show markers when running in check mode
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin

show_per_host_start:
    default: false
    description: This adds output that shows when a task is started to execute for each
      host
    env:
    - name: ANSIBLE_SHOW_PER_HOST_START
    ini:
    - key: show_per_host_start
      section: defaults
    name: Show per host task start
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin

display_failed_stderr:
    default: false
    description: Toggle to control whether failed and unreachable tasks are displayed
      to STDERR (vs. STDOUT)
    env:
    - name: ANSIBLE_DISPLAY_FAILED_STDERR
    ini:
    - key: display_failed_stderr
      section: defaults
    name: Use STDERR for failed and unreachable tasks
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

display_skipped_hosts:
    default: true
    description: Toggle to control displaying skipped task/host results in a task
    env:
    - name: ANSIBLE_DISPLAY_SKIPPED_HOSTS
    ini:
    - key: display_skipped_hosts
      section: defaults
    name: Show skipped hosts
    type: bool

show_task_path_on_failure:
    default: false
    description: 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:
    - name: ANSIBLE_SHOW_TASK_PATH_ON_FAILURE
    ini:
    - key: show_task_path_on_failure
      section: defaults
    name: Show file path on failed tasks
    type: bool
    version_added: '2.11'
    version_added_collection: ansible.builtin