community.general.log_plays – write playbook output to log file

Note

This plugin is part of the community.general collection (version 4.2.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.

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

Synopsis

  • This callback writes playbook output to a file per host in the /var/log/ansible/hosts directory

Requirements

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

  • Whitelist in configuration

  • A writeable /var/log/ansible/hosts directory by the user executing Ansible on the controller

Parameters

Parameter Choices/Defaults Configuration Comments
log_folder
string
Default:
"/var/log/ansible/hosts"
ini entries:

[callback_log_plays]
log_folder = /var/log/ansible/hosts

env:ANSIBLE_LOG_FOLDER
The folder where log files will be created.

Authors

  • Unknown (!UNKNOWN)