theforeman.foreman.usergroup 模块 – 管理用户组

注意

此模块是 theforeman.foreman 集合（版本 4.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：theforeman.foreman.usergroup。

theforeman.foreman 1.0.0 中新增

概要 

创建、更新和删除用户组

别名：foreman_usergroup

要求 

执行此模块的主机上需要以下要求。

requests

参数 

参数	注释
admin 布尔值	此组中的用户是否为管理员选项 `false` ← (默认) `true`
name 字符串 / 必需	组的名称
password 字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
roles 列表 / 元素=字符串	分配给该组的角色列表
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态选项 `"present"` ← (默认) `"absent"`
updated_name 字符串	新的用户组名称。设置此参数后，该模块将不是幂等的。
usergroups 列表 / 元素=字符串	分配给该组的其他组的列表
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
users 列表 / 元素=字符串	分配给该组的用户列表
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全	可以在 check_mode 中运行并返回更改状态预测，而无需修改实体
diff_mode	支持：完全	当处于 diff 模式时，将返回已更改（或可能需要在 check_mode 中进行更改）的详细信息

示例 

- name: Create a user group
  theforeman.foreman.usergroup:
    name: test
    admin: false
    roles:
      - Manager
    users:
      - myuser1
      - myuser2
    usergroups:
      - mynestedgroup
    state: present

返回值 

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

键	描述
实体字典	受影响实体按其类型分组的最终状态。已返回：成功
usergroups 列表 / 元素=字典	用户组列表。已返回：成功

作者

Baptiste Agasse (@bagasse)