mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-06 09:00:58 +02:00
65 lines
1.9 KiB
Python
65 lines
1.9 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# Copyright 2016 Ansible RedHat, Inc
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
author: "Brian Coca (@bcoca)"
|
|
module: set_stats
|
|
short_description: Set 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.
|
|
options:
|
|
data:
|
|
description:
|
|
- A dictionary of which each key represents a stat (or variable) you want to keep track of
|
|
required: true
|
|
per_host:
|
|
description:
|
|
- boolean that indicates if the stats is per host or for all hosts in the run.
|
|
required: no
|
|
default: no
|
|
aggregate:
|
|
description:
|
|
- boolean that indicates if the provided value is aggregated to the existing stat C(yes) or will replace it C(no)
|
|
required: no
|
|
default: yes
|
|
notes:
|
|
- This module is also supported for Windows targets.
|
|
- 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(true).
|
|
version_added: "2.3"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Aggregating packages_installed stat per host
|
|
- set_stats:
|
|
data:
|
|
packages_installed: 31
|
|
|
|
# Aggregating random stats for all hosts using complex arguments
|
|
- 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
|
|
|
|
|
|
# setting stats (not aggregating)
|
|
- set_stats:
|
|
data:
|
|
the_answer: 42
|
|
aggregate: no
|
|
'''
|