File: //lib/python3.9/site-packages/ansible/plugins/inventory/__pycache__/constructed.cpython-39.pyc
a
�)g� � @ s� d dl mZmZmZ eZdZdZd dlZd dl m
Z d dl m
Z
mZ d dlmZ d dlmZmZ d d lmZ d d
lmZ d d lmZ d d lmZ G d
d� dee�Z dS )� )�absolute_import�division�print_functiona�
name: constructed
version_added: "2.4"
short_description: Uses Jinja2 to construct vars and groups based on existing inventory.
description:
- Uses a YAML configuration file with a valid YAML or C(.config) extension to define var expressions and group conditionals
- The Jinja2 conditionals that qualify a host for membership.
- The Jinja2 expressions are calculated and assigned to the variables
- Only variables already available from previous inventories or the fact cache can be used for templating.
- When I(strict) is False, failed expressions will be ignored (assumes vars were missing).
options:
plugin:
description: token that ensures this is a source file for the 'constructed' plugin.
required: True
choices: ['ansible.builtin.constructed', 'constructed']
use_vars_plugins:
description:
- Normally, for performance reasons, vars plugins get executed after the inventory sources complete the base inventory,
this option allows for getting vars related to hosts/groups from those plugins.
- The host_group_vars (enabled by default) 'vars plugin' is the one responsible for reading host_vars/ and group_vars/ directories.
- This will execute all vars plugins, even those that are not supposed to execute at the 'inventory' stage.
See vars plugins docs for details on 'stage'.
required: false
default: false
type: boolean
version_added: '2.11'
extends_documentation_fragment:
- constructed
a�
# inventory.config file in YAML format
plugin: ansible.builtin.constructed
strict: False
compose:
var_sum: var1 + var2
# this variable will only be set if I have a persistent fact cache enabled (and have non expired facts)
# `strict: False` will skip this instead of producing an error if it is missing facts.
server_type: "ansible_hostname | regex_replace ('(.{6})(.{2}).*', '\\2')"
groups:
# simple name matching
webservers: inventory_hostname.startswith('web')
# using ec2 'tags' (assumes aws inventory)
development: "'devel' in (ec2_tags|list)"
# using other host properties populated in inventory
private_only: not (public_dns_name is defined or ip_address is defined)
# complex group membership
multi_group: (group_names | intersect(['alpha', 'beta', 'omega'])) | length >= 2
keyed_groups:
# this creates a group per distro (distro_CentOS, distro_Debian) and assigns the hosts that have matching values to it,
# using the default separator "_"
- prefix: distro
key: ansible_distribution
# the following examples assume the first inventory is from the `aws_ec2` plugin
# this creates a group per ec2 architecture and assign hosts to the matching ones (arch_x86_64, arch_sparc, etc)
- prefix: arch
key: architecture
# this creates a group per ec2 region like "us_west_1"
- prefix: ""
separator: ""
key: placement.region
# this creates a common parent group for all ec2 availability zones
- key: placement.availability_zone
parent_group: all_ec2_zones
N)� constants)�AnsibleParserError�AnsibleOptionsError)�get_group_vars)�BaseInventoryPlugin�
Constructable)� to_native)� combine_vars)� FactCache)� get_vars_from_inventory_sourcesc sV e Zd ZdZdZ� fdd�Z� fdd�Zdd� Zd d
� Zd d � Z d� fdd� Z
� Z S )�InventoryModulez> constructs groups and vars using Jinja2 template expressions Z constructedc s t t| ��� t� | _d S )N)�superr �__init__r
�_cache)�self�� __class__� �I/usr/lib/python3.9/site-packages/ansible/plugins/inventory/constructed.pyr b s zInventoryModule.__init__c s@ d}t t| ��|�r<tj�|�\}}|r8|dgtj v r<d}|S )NFz.configT)r r � verify_file�os�path�splitext�CZYAML_FILENAME_EXTENSIONS)r r Zvalid� file_name�extr r r r h s zInventoryModule.verify_filec C s t | �|||�| �|||��S )� requires host object )r �host_groupvars� host_vars)r �host�loader�sourcesr r r �get_all_host_varss s z!InventoryModule.get_all_host_varsc C s2 t |�� �}| �d�r.t|t|||�� d��}|S �r �use_vars_plugins�all)r Z
get_groups�
get_optionr r )r r" r# r$ �gvarsr r r r w s
z InventoryModule.host_groupvarsc C s, |� � }| �d�r(t|t|||gd��}|S r& )Zget_varsr) r r )r r" r# r$ Zhvarsr r r r! � s
zInventoryModule.host_varsFc
sb t t| �j||||d� | �|� g }z
|j}W n$ tyT | �d�rPtd��Y n0 | �d�}t� }z�|j D ]�}| �
|j | ||�} ||v r�t | || �} | j | �d�| ||d� | �
|j | ||�} || j
v r�t | | j
| �} | j| �d�| ||dd � | j| �d
�| ||dd � qnW nB t�y\ }
z(td t|�t|
�f |
d ��W Y d
}
~
n
d
}
~
0 0 d
S )z parses the inventory file )�cacher' z5The option use_vars_plugins requires ansible >= 2.11.�strictZcompose)r, �groupsF)r, Zfetch_hostvarsZ keyed_groupszfailed to parse %s: %s )Zorig_excN)r r �parseZ_read_config_dataZprocessed_sources�AttributeErrorr) r r
�hostsr% r Z_set_composite_varsr Z _add_host_to_composed_groupsZ_add_host_to_keyed_groups� Exceptionr r ) r Z inventoryr# r r+ r$ r, Z
fact_cacher" Zhostvars�er r r r. � s.
zInventoryModule.parse)F) �__name__�
__module__� __qualname__�__doc__�NAMEr r r% r r! r. �
__classcell__r r r r r ] s r ) Z
__future__r r r �typeZ
__metaclass__Z
DOCUMENTATIONZEXAMPLESr Zansibler r Zansible.errorsr r Zansible.inventory.helpersr Zansible.plugins.inventoryr r
Zansible.module_utils._textr Zansible.utils.varsr Zansible.vars.fact_cacher
Zansible.vars.pluginsr r r r r r �<module> s ,