community.general.yaml callback – YAML-ized Ansible screen output
Note
This callback plugin is part of the community.general collection (version 9.5.0).
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
.
You need further requirements to be able to use this callback plugin,
see Requirements for details.
To use it in a playbook, specify: community.general.yaml
.
Callback plugin
This plugin is a stdout callback. You can use only use one stdout callback at a time. Additional aggregate or notification callbacks can be enabled though. See Callback plugins for more information on callback plugins.
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 |
Comments |
---|---|
Toggle to control displaying markers when running in check mode. The markers are Choices:
Configuration:
|
|
Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT) Choices:
Configuration:
|
|
Toggle to control displaying ‘ok’ task/host results in a task Choices:
Configuration:
|
|
Toggle to control displaying skipped task/host results in a task Choices:
Configuration:
|
|
This adds the custom stats set via the set_stats plugin to the play recap Choices:
Configuration:
|
|
This adds output that shows when a task is started to execute for each host Choices:
Configuration:
|
|
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 Choices:
Configuration:
|
Notes
Note
With ansible-core 2.13 or newer, you can instead specify
yaml
for the parameterresult_format
in ansible.builtin.default.
See Also
See also
- ansible.builtin.default callback plugin
There is a parameter
result_format
in ansible.builtin.default that allows you to change the output format to YAML.