Ansible 社区文档

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。
local 布尔值	强制在实现它的平台上使用“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	支持：不支持	在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 下更改的内容）的详细信息
platform	平台： posix	可以对其进行操作的目标操作系统/系列

另请参阅 

另请参阅

ansible.builtin.user: 管理用户帐户。
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)

集合链接