counter_enabled – adds counters to the output items (tasks and hosts/task)

New in version 2.7.

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 master node that executes this callback.

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

Parameters

Parameter Choices/Defaults Configuration Comments
display_failed_stderr
boolean
added in 2.7
    Choices:
  • no
  • yes
ini entries:

[defaults]
display_failed_stderr = no

env:ANSIBLE_DISPLAY_FAILED_STDERR
Toggle to control whether failed and unreachable tasks are displayed to STDERR (vs. STDOUT)
display_ok_hosts
boolean
added in 2.7
    Choices:
  • no
  • yes
ini entries:

[defaults]
display_ok_hosts = yes

env:ANSIBLE_DISPLAY_OK_HOSTS
Toggle to control displaying 'ok' task/host results in a task
display_skipped_hosts
boolean
    Choices:
  • no
  • yes
ini entries:

[defaults]
display_skipped_hosts = yes

env:DISPLAY_SKIPPED_HOSTS
env:ANSIBLE_DISPLAY_SKIPPED_HOSTS
Toggle to control displaying skipped task/host results in a task
show_custom_stats
boolean
    Choices:
  • no
  • yes
ini entries:

[defaults]
show_custom_stats = no

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

Status

Authors

  • UNKNOWN

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

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.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/plugins/callback/counter_enabled.html