community.general.counter_enabled callback – adds counters to the output items (tasks and hosts/task)

Note

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

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

Synopsis

  • Use this callback when you need a kind of progress bar on a large environments.

  • You will know how many tasks has the playbook to run, and which one is actually running.

  • You will know how many hosts may run a task, and which of them is actually running.

Requirements

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

  • set as stdout callback in ansible.cfg (stdout_callback = counter_enabled)

Parameters

Parameter

Comments

check_mode_markers

boolean

added in 2.9 of ansible.builtin

Toggle to control displaying markers when running in check mode.

The markers are DRY RUN at the beginning and ending of playbook execution (when calling ansible-playbook --check) and CHECK MODE as a suffix at every play and task that is run in check mode.

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [defaults]
check_mode_markers = no

  • Environment variable: ANSIBLE_CHECK_MODE_MARKERS

display_failed_stderr

boolean

added in 2.7 of ansible.builtin

Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT)

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [defaults]
display_failed_stderr = no

  • Environment variable: ANSIBLE_DISPLAY_FAILED_STDERR

display_ok_hosts

boolean

added in 2.7 of ansible.builtin

Toggle to control displaying ‘ok’ task/host results in a task

Choices:

  • no

  • yes ← (default)

Configuration:

  • INI entry:

    [defaults]
display_ok_hosts = yes

  • Environment variable: ANSIBLE_DISPLAY_OK_HOSTS

display_skipped_hosts

boolean

Toggle to control displaying skipped task/host results in a task

Choices:

  • no

  • yes ← (default)

Configuration:

  • INI entry:

    [defaults]
display_skipped_hosts = yes

  • Environment variable: DISPLAY_SKIPPED_HOSTS

    Removed in: version 2.12 of ansible.builtin

    Why: environment variables without ANSIBLE_ prefix are deprecated

    Alternative: the ANSIBLE_DISPLAY_SKIPPED_HOSTS environment variable

  • Environment variable: ANSIBLE_DISPLAY_SKIPPED_HOSTS

show_custom_stats

boolean

This adds the custom stats set via the set_stats plugin to the play recap

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [defaults]
show_custom_stats = no

  • Environment variable: ANSIBLE_SHOW_CUSTOM_STATS

show_per_host_start

boolean

added in 2.9 of ansible.builtin

This adds output that shows when a task is started to execute for each host

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [defaults]
show_per_host_start = no

  • Environment variable: ANSIBLE_SHOW_PER_HOST_START

show_task_path_on_failure

boolean

added in 2.11 of ansible.builtin

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 -vv or greater verbosity.

Choices:

  • no ← (default)

  • yes

Configuration:

  • INI entry:

    [defaults]
show_task_path_on_failure = no

  • Environment variable: ANSIBLE_SHOW_TASK_PATH_ON_FAILURE

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.