ansible.builtin.set_stats (v2.16.5) — module

Install Ansible via pip

Install with pip install ansible-core==2.16.5

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Aggregating packages_installed stat per host
  ansible.builtin.set_stats:
    data:
      packages_installed: 31
    per_host: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Aggregating random stats for all hosts using complex arguments
  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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Setting stats (not aggregating)
  ansible.builtin.set_stats:
    data:
      the_answer: 42
    aggregate: no

Inputs

    
data:
    description:
    - A dictionary of which each key represents a stat (or variable) you want to keep
      track of.
    required: true
    type: dict

per_host:
    default: false
    description:
    - whether the stats are per host or for all hosts in the run.
    type: bool

aggregate:
    default: true
    description:
    - Whether the provided value is aggregated to the existing stat V(true) or will replace
      it V(false).
    type: bool