W3cubDocs

/Ansible

community.general.yaml – yaml-ized Ansible screen output

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.yaml.

Synopsis

  • Ansible output that can be quite a bit easier to read than the default JSON formatting.

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • set as stdout in configuration

Parameters

Parameter Choices/Defaults Configuration Comments
check_mode_markers
boolean
added in 2.9 of ansible.builtin
    Choices:
  • no ←
  • yes
ini entries:

[defaults]
check_mode_markers = no

env:ANSIBLE_CHECK_MODE_MARKERS
Toggle to control displaying markers when running in check mode.
The markers are DRY RUN at the beggining and ending of playbook execution (when calling ansible-playbook --check) and CHECK MODE as a suffix at every play and task that is run in check mode.
display_failed_stderr
boolean
added in 2.7 of ansible.builtin
    Choices:
  • no ←
  • yes
ini entries:

[defaults]
display_failed_stderr = no

env:ANSIBLE_DISPLAY_FAILED_STDERR
Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT)
display_ok_hosts
boolean
added in 2.7 of ansible.builtin
    Choices:
  • no
  • yes ←
ini entries:

[defaults]
display_ok_hosts = yes

env:ANSIBLE_DISPLAY_OK_HOSTS
Toggle to control displaying 'ok' task/host results in a task
display_skipped_hosts
boolean
    Choices:
  • no
  • yes ←
ini entries:

[defaults]
display_skipped_hosts = yes

env:DISPLAY_SKIPPED_HOSTS
Removed in: version 2.12 of ansible.builtin
Why: environment variables without "ANSIBLE_" prefix are deprecated
Alternative: the "ANSIBLE_DISPLAY_SKIPPED_HOSTS" environment variable
env:ANSIBLE_DISPLAY_SKIPPED_HOSTS
Toggle to control displaying skipped task/host results in a task
show_custom_stats
boolean
    Choices:
  • no ←
  • yes
ini entries:

[defaults]
show_custom_stats = no

env:ANSIBLE_SHOW_CUSTOM_STATS
This adds the custom stats set via the set_stats plugin to the play recap
show_per_host_start
boolean
added in 2.9 of ansible.builtin
    Choices:
  • no ←
  • yes
ini entries:

[defaults]
show_per_host_start = no

env:ANSIBLE_SHOW_PER_HOST_START
This adds output that shows when a task is started to execute for each host
show_task_path_on_failure
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no ←
  • yes
ini entries:

[defaults]
show_task_path_on_failure = no

env:ANSIBLE_SHOW_TASK_PATH_ON_FAILURE
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 -vv or greater verbosity.

Authors

  • Unknown (!UNKNOWN)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/yaml_callback.html