a )g@sddlmZmZmZeZdZdZddlZddl m Z ddl m Z mZddlmZddlmZmZdd lmZdd lmZdd lmZdd lmZGd ddeeZdS))absolute_importdivisionprint_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)AnsibleParserErrorAnsibleOptionsError)get_group_vars)BaseInventoryPlugin Constructable) to_native) combine_vars) FactCache)get_vars_from_inventory_sourcescsVeZdZdZdZfddZfddZddZd d Zd d Z dfdd Z Z S)InventoryModulez> constructs groups and vars using Jinja2 template expressions Z constructedcstt|t|_dS)N)superr__init__r _cache)self __class__I/usr/lib/python3.9/site-packages/ansible/plugins/inventory/constructed.pyrbszInventoryModule.__init__cs@d}tt||r= 2.11.strictZcompose)r,groupsF)r,Zfetch_hostvarsZ keyed_groupszfailed to parse %s: %s )Zorig_excN)rrparseZ_read_config_dataZprocessed_sourcesAttributeErrorr)rr hostsr%r Z_set_composite_varsrZ_add_host_to_composed_groupsZ_add_host_to_keyed_groups Exceptionrr ) rZ inventoryr#rr+r$r,Z fact_cacher"Zhostvarserrrr.s.        zInventoryModule.parse)F) __name__ __module__ __qualname____doc__NAMErrr%r r!r. __classcell__rrrrr]s    r)Z __future__rrrtypeZ __metaclass__Z DOCUMENTATIONZEXAMPLESrZansiblerrZansible.errorsrrZansible.inventory.helpersrZansible.plugins.inventoryr r Zansible.module_utils._textr Zansible.utils.varsr Zansible.vars.fact_cacher Zansible.vars.pluginsrrrrrrs,