community.general.full_skip – suppresses tasks if all hosts skipped

From Get docs
Ansible/docs/2.10/collections/community/general/full skip callback


community.general.full_skip – suppresses tasks if all hosts skipped

Note

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

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.full_skip.


DEPRECATED

Removed in
version 2.0.0
Why
The ‘default’ callback plugin now supports this functionality
Alternative
‘default’ callback plugin with ‘display_skipped_hosts = no’ option

Synopsis

  • Use this plugin when you do not care about any output for tasks that were completely skipped

Requirements

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

  • set as stdout in configuration

Parameters

Parameter Choices/Defaults Configuration Comments

check_mode_markers

boolean

added in 2.9 of ansible.builtin

  • no

  • yes

ini entries: [defaults]check_mode_markers = no


env:ANSIBLE_CHECK_MODE_MARKERS

Toggle to control displaying markers when running in check mode.

The markers are DRY RUN at the beggining 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.

display_failed_stderr

boolean

added in 2.7 of ansible.builtin

  • 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 of ansible.builtin

  • 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

  • no
  • yes

ini entries: [defaults]display_skipped_hosts = yes


env: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

env:ANSIBLE_DISPLAY_SKIPPED_HOSTS

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

show_custom_stats

boolean

  • 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

show_per_host_start

boolean

added in 2.9 of ansible.builtin

  • no

  • yes

ini entries: [defaults]show_per_host_start = no


env:ANSIBLE_SHOW_PER_HOST_START

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



Status

  • This callback will be removed in version 2.0.0. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Unknown (!UNKNOWN)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/full_skip_callback.html