Ansible 核心文档

ansible.builtin.constructed inventory – 使用 Jinja2 基于现有清单构建变量和组。

注意

此清单插件是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您可以使用简短的插件名称 constructed。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.constructed，以便轻松链接到插件文档并避免与可能具有相同清单插件名称的其他集合发生冲突。

概要 

使用具有有效 YAML 或 .config 扩展名的 YAML 配置文件来定义变量表达式和组条件。
使主机符合成员资格的 Jinja2 条件。
计算 Jinja2 表达式并将它们分配给变量。
仅可将来自先前清单或事实缓存的现有变量用于模板化。
当 strict 为 False 时，将忽略失败的表达式（假设缺少变量）。

参数 

参数	注释
compose 字典	从 Jinja2 表达式创建变量。默认值： `{}`
groups 字典	基于 Jinja2 条件将主机添加到组。默认值： `{}`
keyed_groups 列表 / 元素=字典	基于变量的值将主机添加到组。默认值： `[]`
default_value 字符串在 ansible-core 2.12 中添加	主机变量的值为空字符串时的默认值。此选项与 `keyed_groups[].trailing_separator` 互斥。
key 字符串	用于生成组的输入字典中的键。
parent_group 字符串	键控组的父组。
prefix 字符串	键控组名称将以该前缀开头。默认值： `""`
separator 字符串	用于构建键控组名称的分隔符。默认值： `"_"`
trailing_separator 布尔值在 ansible-core 2.12 中添加	将此选项设置为 `false` 以省略主机变量值为空字符串时 `keyed_groups[].separator` 之后的 `keyed_groups[].separator`。此选项与 `keyed_groups[].default_value` 互斥。选项 `false` `true` ← (默认)
leading_separator 布尔值在 ansible-core 2.11 中添加	与 `keyed_groups` 结合使用。默认情况下，未提供前缀或分隔符的键控组的名称将以下划线开头。这是因为默认前缀为 `""`，默认分隔符为 `"_"`。将此选项设置为 `false` 以省略在未给出前缀的情况下开头的下划线（或其他分隔符）。如果组名称派生自映射，则分隔符仍用于连接项目。要完全不在组名称中使用分隔符，请将键控组的分隔符设置为空字符串。选项 `false` `true` ← (默认)
plugin 字符串 / 必需	确保这是“constructed”插件的源文件的令牌。选项 `"ansible.builtin.constructed"` `"constructed"`
strict 布尔值	如果 `yes` 使无效条目成为致命错误，否则跳过并继续。由于可以在表达式中使用事实，因此它们可能并不总是可用，并且默认情况下我们忽略这些错误。选项 `false` ← (默认) `true`
use_extra_vars 布尔值在 ansible-core 2.11 中添加	将额外变量合并到可用于组合的变量中（最高优先级）。选项 `false` ← (默认) `true` 配置 INI 条目 [inventory_plugins] use_extra_vars = false 环境变量：`ANSIBLE_INVENTORY_USE_EXTRA_VARS`
use_vars_plugins 布尔值在 ansible-core 2.11 中添加	通常，出于性能原因，vars 插件会在清单源完成基本清单后执行，此选项允许从这些插件获取与主机/组相关的变量。 host_group_vars（默认启用）“vars 插件”负责读取 host_vars/ 和 group_vars/ 目录。这将执行所有 vars 插件，即使那些不应该在“清单”阶段执行的插件也是如此。有关“阶段”的详细信息，请参阅 vars 插件文档。隐式组（如“all”或“ungrouped”）需要在任何先前的清单中明确定义，以便应用相应的 group_vars。选项 `false` ← (默认) `true`

示例 

# 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

提示

每个条目类型的配置条目具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。

集合链接