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

注意

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

概述

  • 使用事实创建可以稍后在剧本中使用的临时组。

  • 此模块也支持 Windows 目标。

注意

此模块具有相应的 动作插件。

参数

参数

注释

key

字符串 / 必需

将使用其值作为组的变量。

parents

列表 / 元素=字符串

父组的列表。

默认： ["all"]

属性

属性

支持

描述

action

支持：完全支持

表示此模块具有相应的动作插件，因此某些选项部分可以在控制器上执行

async

支持：不支持

支持与 async 关键字一起使用

become

支持：不支持

可与 become 关键字一起使用

bypass_host_loop

支持：不支持

强制执行“全局”任务，该任务不会按主机执行，这将绕过按主机进行模板化和序列化、节流以及其他循环考虑因素

条件将按 run_once 使用的方式工作，使用的变量将来自第一个可用的主机

此操作在非锁步策略之外无法正常工作

bypass_task_loop

支持：不支持

这些任务会忽略 loop 和 with_ 关键字

check_mode

支持：部分支持

虽然这不会对目标系统进行任何更改，但“内存中”的库存仍然会发生变化

可以在 check_mode 中运行并返回更改状态预测，而不会修改目标，如果不支持，则操作将被跳过。

connection

支持：不支持

使用目标的配置连接信息在其上执行代码

core

支持：部分支持

虽然此操作的部分内容是在 core 中实现的，但其他部分仍然作为普通插件可用，并且可以部分覆盖

这是一个“核心引擎”功能，其实现方式不同于大多数任务操作，因此无法通过插件系统以任何方式覆盖。

delegation

支持：不支持

可与 delegate_to 和相关关键字一起使用

diff_mode

支持：不支持

将在差异模式下返回有关已更改内容（或可能需要更改内容（在 check_mode 中））的详细信息

ignore_conditional

支持：不支持

操作不受条件执行的约束，因此它会忽略 when: 关键字

platform

平台： 所有

可以对其执行操作的目标操作系统/系列

tags

支持：完全支持

允许使用“标签”关键字控制此操作的选择以执行

until

支持：完全支持

表示此操作是否遵守 until/retry/poll 关键字

注释

注意

  • 组名中的空格将转换为连字符“-”。

  • 虽然此模块不会更改远程主机，但我们确实提供了“已更改”状态，因为它对于那些试图跟踪库存更改的人来说可能很有用。

另请参阅

另请参阅

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)