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
|
# -*- coding: utf-8 -*-
# Copyright: (c) 2017, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import annotations
class ModuleDocFragment(object):
DOCUMENTATION = r"""
options:
strict:
description:
- If V(yes) make invalid entries a fatal error, otherwise skip and continue.
- Since it is possible to use facts in the expressions they might not always be available
and we ignore those errors by default.
type: bool
default: no
compose:
description: Create vars from jinja2 expressions.
type: dict
default: {}
groups:
description: Add hosts to group based on Jinja2 conditionals.
type: dict
default: {}
keyed_groups:
description: Add hosts to group based on the values of a variable.
type: list
default: []
elements: dict
suboptions:
parent_group:
type: str
description: parent group for keyed group.
prefix:
type: str
description: A keyed group name will start with this prefix.
default: ''
separator:
type: str
description: separator used to build the keyed group name.
default: "_"
key:
type: str
description:
- The key from input dictionary used to generate groups.
default_value:
description:
- The default value when the host variable's value is V(None) or an empty string.
- This option is mutually exclusive with O(keyed_groups[].trailing_separator).
type: str
version_added: '2.12'
trailing_separator:
description:
- Set this option to V(false) to omit the O(keyed_groups[].separator) after the host variable when the value is V(None) or an empty string.
- This option is mutually exclusive with O(keyed_groups[].default_value).
type: bool
default: true
version_added: '2.12'
use_extra_vars:
version_added: '2.11'
description: Merge extra vars into the available variables for composition (highest precedence).
type: bool
default: false
ini:
- section: inventory_plugins
key: use_extra_vars
env:
- name: ANSIBLE_INVENTORY_USE_EXTRA_VARS
leading_separator:
description:
- Use in conjunction with O(keyed_groups).
- By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore.
- This is because the default prefix is V("") and the default separator is V("_").
- Set this option to V(false) to omit the leading underscore (or other separator) if no prefix is given.
- If the group name is derived from a mapping the separator is still used to concatenate the items.
- To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead.
type: boolean
default: True
version_added: '2.11'
notes:
- Inventories are not finalized at this stage, so the auto populated C(all) and C(ungrouped) groups will
only reflect what previous inventory sources explicitly added to them.
- Runtime 'magic variables' are not available during inventory construction. For example, C(groups) and C(hostvars) do not exist yet.
"""
|
