blob: ef641f2cf82caa146f2fe6698be5ce83c0e8054b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
# -*- mode: python -*-
# Copyright: (c) 2012, Jeroen Hoekx (@jhoekx)
# Copyright: Ansible Team
# 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
DOCUMENTATION = r'''
---
module: group_by
short_description: Create Ansible groups based on facts
extends_documentation_fragment:
- action_common_attributes
- action_common_attributes.conn
- action_common_attributes.flow
- action_core
description:
- Use facts to create ad-hoc groups that can be used later in a playbook.
- This module is also supported for Windows targets.
version_added: "0.9"
options:
key:
description:
- The variables whose values will be used as groups.
type: str
required: true
parents:
description:
- The list of the parent groups.
type: list
elements: str
default: all
version_added: "2.4"
attributes:
action:
support: full
become:
support: none
bypass_host_loop:
support: full
bypass_task_loop:
support: none
check_mode:
details: While this makes no changes to target systems the 'in memory' inventory will still be altered
support: partial
core:
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
connection:
support: none
delegation:
support: none
diff_mode:
support: none
platform:
platforms: all
notes:
- Spaces in group names are converted to dashes '-'.
- Though this module does not change the remote host,
we do provide 'changed' status as it can be useful
for those trying to track inventory changes.
seealso:
- module: ansible.builtin.add_host
author:
- Jeroen Hoekx (@jhoekx)
'''
EXAMPLES = r'''
- name: Create groups based on the machine architecture
ansible.builtin.group_by:
key: machine_{{ ansible_machine }}
- name: Create groups like 'virt_kvm_host'
ansible.builtin.group_by:
key: virt_{{ ansible_virtualization_type }}_{{ ansible_virtualization_role }}
- name: Create nested groups
ansible.builtin.group_by:
key: el{{ ansible_distribution_major_version }}-{{ ansible_architecture }}
parents:
- el{{ ansible_distribution_major_version }}
- name: Add all active hosts to a static group
ansible.builtin.group_by:
key: done
'''
|
