diff --git a/lib/ansible/modules/set_stats.py b/lib/ansible/modules/set_stats.py index 65ae54a7212..95f17c9674e 100644 --- a/lib/ansible/modules/set_stats.py +++ b/lib/ansible/modules/set_stats.py @@ -11,7 +11,7 @@ __metaclass__ = type DOCUMENTATION = r''' --- module: set_stats -short_description: Set stats for the current ansible run +short_description: Define and display stats for the current ansible run description: - This module allows setting/accumulating stats on the current ansible run, either per host or for all hosts in the run. - This module is also supported for Windows targets. @@ -33,29 +33,29 @@ options: type: bool default: yes notes: - - In order for custom stats to be displayed, you must set C(show_custom_stats) in C(ansible.cfg) or C(ANSIBLE_SHOW_CUSTOM_STATS) to C(yes). + - In order for custom stats to be displayed, you must set C(show_custom_stats) in section C([defaults]) in C(ansible.cfg) + or by defining environment variable C(ANSIBLE_SHOW_CUSTOM_STATS) to C(yes). - This module is also supported for Windows targets. version_added: "2.3" ''' EXAMPLES = r''' - name: Aggregating packages_installed stat per host - set_stats: + ansible.builtin.set_stats: data: packages_installed: 31 per_host: yes - name: Aggregating random stats for all hosts using complex arguments - set_stats: + ansible.builtin.set_stats: data: one_stat: 11 other_stat: "{{ local_var * 2 }}" another_stat: "{{ some_registered_var.results | map(attribute='ansible_facts.some_fact') | list }}" per_host: no - - name: Setting stats (not aggregating) - set_stats: + ansible.builtin.set_stats: data: the_answer: 42 aggregate: no