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

Note

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

Callback plugin

This plugin is a notification callback. It sends information for a playbook run to other applications, services, or systems. See Callback plugins for more information on callback plugins.

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

Comments

log_folder

string

The folder where log files will be created.

Default: "/var/log/ansible/hosts"

Configuration:

  • INI entry:

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

  • Environment variable: ANSIBLE_LOG_FOLDER

Authors

  • Unknown

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.