theforeman.foreman.external_usergroup 模块 – 管理外部用户组

注意

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

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

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

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

theforeman.foreman 1.0.0 中的新增功能

概要 

创建、更新和删除外部用户组

别名：foreman_external_usergroup

要求 

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

requests

参数 

参数	注释
auth_source 别名：auth_source_ldap 字符串 / 必需	为此组使用的身份验证源的名称
name 字符串 / 必需	组的名称
password 字符串 / 必需	访问 Foreman 服务器的用户密码。如果任务中未指定值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果任务中未指定值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
state 字符串	实体的状态选项 `"present"` ← (默认) `"absent"`
usergroup 字符串 / 必需	链接的用户组的名称
username 字符串 / 必需	访问 Foreman 服务器的用户名。如果任务中未指定值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果任务中未指定值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在 check_mode 下运行并返回更改状态预测，而无需修改实体
diff_mode	支持：完全支持	在差异模式下，将返回有关已更改内容（或在 check_mode 下可能需要更改的内容）的详细信息

示例 

- name: Create an external user group
  theforeman.foreman.external_usergroup:
    name: test
    auth_source: "My LDAP server"
    usergroup: "Internal Usergroup"
    state: present
- name: Link a group from FreeIPA
  theforeman.foreman.external_usergroup:
    name: ipa_users
    auth_source: "External"
    usergroup: "Internal Usergroup"
    state: present

返回值 

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

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

作者

Kirill Shirinkin (@Fodoj)