set_stats.py (ansible-2.14.0) | : | set_stats.py (ansible-2.14.1rc1) | ||
---|---|---|---|---|
skipping to change at line 30 | skipping to change at line 30 | |||
- A dictionary of which each key represents a stat (or variable) you want to keep track of. | - A dictionary of which each key represents a stat (or variable) you want to keep track of. | |||
type: dict | type: dict | |||
required: true | required: true | |||
per_host: | per_host: | |||
description: | description: | |||
- whether the stats are per host or for all hosts in the run. | - whether the stats are per host or for all hosts in the run. | |||
type: bool | type: bool | |||
default: no | default: no | |||
aggregate: | aggregate: | |||
description: | description: | |||
- Whether the provided value is aggregated to the existing stat C(yes) o r will replace it C(no). | - Whether the provided value is aggregated to the existing stat C(true) or will replace it C(false). | |||
type: bool | type: bool | |||
default: yes | default: yes | |||
extends_documentation_fragment: | extends_documentation_fragment: | |||
- action_common_attributes | - action_common_attributes | |||
- action_common_attributes.conn | - action_common_attributes.conn | |||
- action_common_attributes.flow | - action_common_attributes.flow | |||
- action_core | - action_core | |||
attributes: | attributes: | |||
action: | action: | |||
details: While the action plugin does do some of the work it relies on t he core engine to actually create the variables, that part cannot be overridden | details: While the action plugin does do some of the work it relies on t he core engine to actually create the variables, that part cannot be overridden | |||
skipping to change at line 57 | skipping to change at line 57 | |||
details: While parts of this action are implemented in core, other parts are still available as normal plugins and can be partially overridden | details: While parts of this action are implemented in core, other parts are still available as normal plugins and can be partially overridden | |||
support: partial | support: partial | |||
check_mode: | check_mode: | |||
support: full | support: full | |||
delegation: | delegation: | |||
support: none | support: none | |||
diff_mode: | diff_mode: | |||
support: none | support: none | |||
notes: | notes: | |||
- In order for custom stats to be displayed, you must set C(show_custom_stat s) in section C([defaults]) in C(ansible.cfg) | - In order for custom stats to be displayed, you must set C(show_custom_stat s) in section C([defaults]) in C(ansible.cfg) | |||
or by defining environment variable C(ANSIBLE_SHOW_CUSTOM_STATS) to C(yes) . See the C(default) callback plugin for details. | or by defining environment variable C(ANSIBLE_SHOW_CUSTOM_STATS) to C(true ). See the C(default) callback plugin for details. | |||
version_added: "2.3" | version_added: "2.3" | |||
''' | ''' | |||
EXAMPLES = r''' | EXAMPLES = r''' | |||
- name: Aggregating packages_installed stat per host | - name: Aggregating packages_installed stat per host | |||
ansible.builtin.set_stats: | ansible.builtin.set_stats: | |||
data: | data: | |||
packages_installed: 31 | packages_installed: 31 | |||
per_host: yes | per_host: yes | |||
End of changes. 2 change blocks. | ||||
2 lines changed or deleted | 2 lines changed or added |