community.general.utm_aaa_group 模块 – 在 Sophos UTM 中创建、更新或销毁 aaa 组对象

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.utm_aaa_group。

概要 

在 Sophos UTM 中创建、更新或销毁 aaa 组对象。
此模块需要激活 UTM 的 REST 功能。

参数 

参数	注释
adirectory_groups 列表 / 元素=字符串	活动目录组字符串列表。默认值： `[]`
adirectory_groups_sids 字典	组 SID 字典。默认值： `{}`
backend_match 字符串	组的后端。选项 `"none"` ← (默认) `"adirectory"` `"edirectory"` `"radius"` `"tacacs"` `"ldap"`
comment 字符串	描述 AAA 组的注释。默认值： `""`
dynamic 字符串	组类型。如果未选择任何类型，则为静态。选项 `"none"` ← (默认) `"ipsec_dn"` `"directory_groups"`
edirectory_groups 列表 / 元素=字符串	edirectory 组字符串列表。默认值： `[]`
headers 字典	发送到 POST 和 PUT 请求的其他标头字典。某些模块需要此参数。默认值： `{}`
ipsec_dn 字符串	ipsec dn 字符串。默认值： `""`
ldap_attribute 字符串	要检查的 LDAP 属性。默认值： `""`
ldap_attribute_value 字符串	要检查的 LDAP 属性值。默认值： `""`
members 列表 / 元素=字符串	用户引用名称列表 (aaa/user)。默认值： `[]`
name 字符串 / 必需	对象的名称。将用于标识条目。
network 字符串	网络引用名称。对象包含身份验证对象已知的 IP 地址 (network/aaa)。默认值： `""`
radius_groups 列表 / 元素=字符串	radius 组字符串列表。默认值： `[]`
state 字符串	对象的所需状态。 `present` 将创建或更新对象。 `absent` 将删除已存在的对象。选项 `"absent"` `"present"` ← (默认)
tacacs_groups 列表 / 元素=字符串	tacacs 组字符串列表。默认值： `[]`
utm_host 字符串 / 必需	Sophos UTM 的 REST 端点。
utm_port 整数	REST 接口的端口。默认值： `4444`
utm_protocol 字符串	REST 端点的协议。选项 `"http"` `"https"` ← (默认)
utm_token 字符串 / 必需	用于在 REST-API 中进行身份识别的令牌。请参阅 https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en，第 2.4.2 章。
validate_certs 布尔值	是否验证 REST 接口的 ssl 证书。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: Create UTM aaa_group
  community.general.utm_aaa_group:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestAAAGroupEntry
    backend_match: ldap
    dynamic: directory_groups
    ldap_attributes: memberof
    ldap_attributes_value: "cn=groupname,ou=Groups,dc=mydomain,dc=com"
    network: REF_OBJECT_STRING
    state: present

- name: Remove UTM aaa_group
  community.general.utm_aaa_group:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestAAAGroupEntry
    state: absent

返回值 

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

键	描述
result 复杂类型	已创建的 UTM 对象。返回：成功
_locked 布尔值	对象当前是否被锁定。返回：成功
_ref 字符串	对象的引用名称。返回：成功
_type 字符串	对象的类型。返回：成功
adirectory_groups 字符串	活动目录组列表。返回：成功
adirectory_groups_sids 列表 / 元素=字符串	活动目录组 SID 列表。返回：成功
backend_match 字符串	要使用的后端。返回：成功
comment 字符串	注释字符串。返回：成功
dynamic 字符串	组匹配是 ipsec_dn 还是 directory_group。返回：成功
edirectory_groups 字符串	eDirectory 组列表。返回：成功
ipsec_dn 字符串	要匹配的 ipsec_dn 标识符。返回：成功
ldap_attribute 字符串	要匹配的 LDAP 属性。返回：成功
ldap_attribute_value 字符串	要匹配的 LDAP 属性值。返回：成功
members 列表 / 元素=字符串	组的成员标识符列表。返回：成功
name 字符串	对象的名称。返回：成功
network 字符串	网络的标识符 (network/aaa)。返回：成功
radius_group 字符串	radius 组标识符。返回：成功
tacacs_group 字符串	tacacs 组标识符。返回：成功

作者

Johannes Brunswicker (@MatrixCrawler)