ansible.builtin.group_by 模块 – 基于事实创建 Ansible 组

注意

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

概要 

使用事实创建临时组，以便稍后在 playbook 中使用。
此模块也支持 Windows 目标。

注意

此模块具有相应的 action 插件。

参数 

参数	注释
key 字符串 / 必需	其值将用作组的变量。
parents 列表 / elements=字符串	父组的列表。默认: `["all"]`

属性 

属性	支持	描述
action	支持: 完全	表示它有一个相应的 action 插件，因此部分选项可以在控制器上执行
async	支持: 无	支持与 `async` 关键字一起使用
become	支持: 无	可与 become 关键字一起使用
bypass_host_loop	支持: 无	强制执行不按主机执行的“全局”任务，这会绕过每个主机的模板和串行、节流以及其他循环考虑条件将像使用 `run_once` 一样工作，使用的变量将来自第一个可用的主机此操作在锁步策略之外通常不起作用
bypass_task_loop	支持: 无	这些任务将忽略 `loop` 和 `with_` 关键字
check_mode	支持: 部分虽然这不会对目标系统进行任何更改，“内存中”的清单仍然会更改	可以在 check_mode 中运行，并返回更改的状态预测，而无需修改目标，如果不支持，则将跳过该操作。
connection	支持: 无	使用目标配置的连接信息在其上执行代码
core	支持: 部分虽然此操作的部分内容在核心中实现，但其他部分仍然作为普通插件可用，并且可以部分覆盖	这是一个“核心引擎”功能，其实现方式与大多数任务操作不同，因此无法通过插件系统以任何方式覆盖。
delegation	支持: 无	可以与 delegate_to 和相关关键字结合使用
diff_mode	支持: 无	在 diff 模式下，将返回有关已更改内容（或在 check_mode 中可能需要更改的内容）的详细信息
ignore_conditional	支持: 无	该操作不受条件执行的约束，因此它将忽略 `when:` 关键字
platform	平台: 全部	可以针对的目标操作系统/系列
tags	支持: 完全	允许使用 'tags' 关键字来控制选择此操作以执行
until	支持: 完全	表示此操作是否遵守 until/retry/poll 关键字

备注 

注意

组名称中的空格将转换为破折号 “-”。
尽管此模块不更改远程主机，但我们仍会提供“changed”状态，因为它对于那些尝试跟踪清单更改的人很有用。

另请参阅 

另请参阅

ansible.builtin.add_host: 向 ansible-playbook 内存中的清单添加主机（以及可选的组）。

示例 

- 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

作者

Jeroen Hoekx (@jhoekx)