Ansible Core 文档

ansible.builtin.group 模块 – 添加或删除组

注意

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

摘要 

管理主机上组的存在。
对于 Windows 目标，请改用 ansible.windows.win_group 模块。

需求 

以下需求是在执行此模块的主机上所需的。

groupadd
groupdel
groupmod

参数 

参数	注释
force 布尔值在 ansible-core 2.15 中添加	是否即使组是用户的初级组也要删除该组。仅适用于在组删除命令上实现 `--force` 标志的平台。选项 `false` ← (默认) `true`
gid 整数	要为组设置的可选 GID。
gid_max 整数在 ansible-core 2.18 中添加	设置组创建的 GID_MAX 值。覆盖 /etc/login.defs 的默认值。目前在 Linux 上受支持。在与其他平台一起使用时不执行任何操作。需要 `local` 被省略或 `False`。
gid_min 整数在 ansible-core 2.18 中添加	设置组创建的 GID_MIN 值。覆盖 /etc/login.defs 的默认值。目前在 Linux 上受支持。在与其他平台一起使用时不执行任何操作。需要 `local` 被省略或 `False`。
local 布尔值	强制在实现它的平台上使用“本地”命令替代方案。这在使用集中式身份验证的环境中很有用，您希望在其中操作本地组。（例如，它使用 `lgroupadd` 而不是 `groupadd`）。这要求这些命令存在于目标主机上，否则将是致命错误。选项 `false` ← (默认) `true`
name 字符串 / 必需	要管理的组的名称。
non_unique 布尔值在 Ansible 2.8 中添加	此选项允许将组 ID 更改为非唯一值。需要 `gid`。在 macOS 或 BusyBox 发行版上不受支持。选项 `false` ← (默认) `true`
state 字符串	组是否应该存在于远程主机上。选项 `"absent"` `"present"` ← (默认)
system 布尔值	如果 `yes`，则表示创建的组是系统组。选项 `false` ← (默认) `true`

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标，如果不支持，则将跳过该操作。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息
platform	平台： posix	可以对其进行操作的目标操作系统/系列

另请参阅 

另请参阅

ansible.builtin.user: 管理用户帐户。
ansible.windows.win_group: 有关 ansible.windows.win_group 模块的官方文档。

示例 

- name: Ensure group "somegroup" exists
  ansible.builtin.group:
    name: somegroup
    state: present

- name: Ensure group "docker" exists with correct gid
  ansible.builtin.group:
    name: docker
    state: present
    gid: 1750

返回值 

常见的返回值在此处有记录，以下是此模块特有的字段

键	描述
gid 整数	组的组 ID。返回：当 `state` 为 `present` 时示例： `1001`
name 字符串	组名称。返回：始终示例： `"users"`
state 字符串	组是否存在。返回：始终示例： `"absent"`
system 布尔值	组是否为系统组。返回：当 `state` 为 `present` 时示例： `false`

作者

Stephen Fromm (@sfromm)

集合链接