summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBaptiste Mille-Mathias <baptiste.millemathias@gmail.com>2021-03-25 20:26:48 +0100
committerGitHub <noreply@github.com>2021-03-25 15:26:48 -0400
commit584432be265d655785c2ad0b54a3f8d31cd37e83 (patch)
tree5034c2fe4e2053b54190cca7c1b63446fc0f7acf
parent73c08df2db91c7d7cbf09ab211a837878c84c7b9 (diff)
downloadansible-584432be265d655785c2ad0b54a3f8d31cd37e83.tar.gz
Use FQCN for module set_stats (#74028)
-rw-r--r--lib/ansible/modules/set_stats.py12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/ansible/modules/set_stats.py b/lib/ansible/modules/set_stats.py
index 65ae54a721..95f17c9674 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