ansible.builtin.tree – Save host events to files

Note

This module is part of ansible-core and included in all Ansible installations. In most cases, you can use the short module name tree even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 2.0: of ansible.builtin

Synopsis

  • This callback is used by the Ansible (adhoc) command line option -t|–tree

  • This produces a JSON dump of events in a directory, a file for each host, the directory used MUST be passed as a command line option.

Requirements

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

  • invoked in the command line

Parameters

Parameter Choices/Defaults Configuration Comments
directory
path
added in 2.11 of ansible.builtin
Default:
"~/.ansible/tree"
ini entries:

[callback_tree]
directory = ~/.ansible/tree

env:ANSIBLE_CALLBACK_TREE_DIR
directory that will contain the per host JSON files. Also set by the ``--tree`` option when using adhoc.