community.general.selective callback – only print certain tasks

Note

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

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.selective.

Synopsis

  • This callback only prints tasks that have been tagged with print_action or that have failed. This allows operators to focus on the tasks that provide value only.

  • Tasks that are not printed are placed with a ..

  • If you increase verbosity all tasks are printed.

Requirements

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

  • set as main display callback

Parameters

Parameter

Comments

nocolor

boolean

This setting allows suppressing colorizing output.

Choices:

  • false ← (default)

  • true

Configuration:

  • INI entry:

    [defaults]
    nocolor = false
    
  • Environment variable: ANSIBLE_NOCOLOR

  • Environment variable: ANSIBLE_SELECTIVE_DONT_COLORIZE

Examples

- ansible.builtin.debug: msg="This will not be printed"
- ansible.builtin.debug: msg="But this will"
  tags: [print_action]

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.