community.general.utm_proxy_auth_profile 模块 – 在 Sophos UTM 中创建、更新或删除反向代理 auth_profile 条目

注意

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

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

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

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

概要 

在 SOPHOS UTM 中创建、更新或删除反向代理 auth_profile 条目。
此模块需要激活 UTM 的 REST 功能。

参数 

参数	注释
aaa 列表 / 元素=字符串 / 必需	utm_aaa 对象的引用列表（允许的用户或组）
backend_mode 字符串	指定后端服务器是否需要身份验证 ([Basic\|None]) 选项 `"Basic"` `"None"` ← (默认)
backend_strip_basic_auth 布尔值	将请求代理到后端主机时，是否应删除登录数据选项 `false` `true` ← (默认)
backend_user_prefix 字符串	要在用户名前添加的前缀字符串，用于后端身份验证默认值： `""`
backend_user_suffix 字符串	要追加到用户名后面的后缀字符串，用于后端身份验证默认值： `""`
basic_prompt 字符串 / 必需	基本身份验证提示中的消息
comment 字符串	可选注释字符串默认值： `""`
frontend_cookie 字符串	前端cookie名称
frontend_cookie_secret 字符串	前端cookie密钥
frontend_form 字符串	前端身份验证表单名称
frontend_form_template 字符串	前端身份验证表单模板默认值： `""`
frontend_login 字符串	前端登录名
frontend_logout 字符串	前端注销名
frontend_mode 字符串	前端身份验证模式 (Form\|Basic) 选项 `"Basic"` ← (默认) `"Form"`
frontend_realm 字符串	前端身份验证领域
frontend_session_allow_persistency 布尔值	允许会话持久性选项 `false` ← (默认) `true`
frontend_session_lifetime 整数 / 必需	会话生命周期
frontend_session_lifetime_limited 布尔值	指定会话生命周期的限制是否有效选项 `false` `true` ← (默认)
frontend_session_lifetime_scope 字符串	frontend_session_lifetime 的范围 (days\|hours\|minutes) 选项 `"days"` `"hours"` ← (默认) `"minutes"`
frontend_session_timeout 整数 / 必需	会话超时
frontend_session_timeout_enabled 布尔值	指定会话超时是否有效选项 `false` `true` ← (默认)
frontend_session_timeout_scope 字符串	frontend_session_timeout 的范围 (days\|hours\|minutes) 选项 `"days"` `"hours"` `"minutes"` ← (默认)
headers 字典	要发送到 POST 和 PUT 请求的附加标头的字典。一些模块需要。默认值： `{}`
logout_delegation_urls 列表 / 元素=字符串	注销委托到的注销 URL 列表默认值： `[]`
logout_mode 字符串	注销模式 (None\|Delegation) 选项 `"None"` ← (默认) `"Delegation"`
name 字符串 / 必需	对象的名称。将用于标识条目
redirect_to_requested_url 布尔值	是否应重定向到请求的 URL 选项 `false` ← (默认) `true`
state 字符串	对象的所需状态。 `present` 将创建或更新对象。 `absent` 将删除现有对象。选项 `"absent"` `"present"` ← (默认)
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 proxy_auth_profile
  community.general.utm_proxy_auth_profile:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestAuthProfileEntry
    aaa: [REF_OBJECT_STRING,REF_ANOTHEROBJECT_STRING]
    basic_prompt: "Authentication required: Please login"
    frontend_session_lifetime: 1
    frontend_session_timeout: 1
    state: present

- name: Remove UTM proxy_auth_profile
  community.general.utm_proxy_auth_profile:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestAuthProfileEntry
    state: absent

- name: Read UTM proxy_auth_profile
  community.general.utm_proxy_auth_profile:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestAuthProfileEntry
    state: info

返回值 

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

键	描述
result 复杂	已创建的 UTM 对象返回：成功
_locked 布尔值	对象当前是否被锁定返回：成功
_ref 字符串	对象的引用名称返回：成功
_type 字符串	对象的类型返回：成功
aaa 列表 / 元素=字符串	utm_aaa 对象的引用列表（允许的用户或组）返回：成功
backend_mode 字符串	指定后端服务器是否需要身份验证 ([Basic\|None]) 返回：成功
backend_strip_basic_auth 布尔值	将请求代理到后端主机时，是否应删除登录数据返回：成功
backend_user_prefix 字符串	要在用户名前添加的前缀字符串，用于后端身份验证返回：成功
backend_user_suffix 字符串	要追加到用户名后面的后缀字符串，用于后端身份验证返回：成功
basic_prompt 字符串	基本身份验证提示中的消息返回：成功
comment 字符串	可选注释字符串返回：成功
frontend_cookie 字符串	前端cookie名称返回：成功
frontend_form 字符串	前端身份验证表单名称返回：成功
frontend_form_template 字符串	前端身份验证表单模板返回：成功
frontend_login 字符串	前端登录名返回：成功
frontend_logout 字符串	前端注销名返回：成功
frontend_mode 字符串	前端身份验证模式 (Form\|Basic) 返回：成功
frontend_realm 字符串	前端身份验证领域返回：成功
frontend_session_allow_persistency 布尔值	允许会话持久性返回：成功
frontend_session_lifetime 整数	会话生命周期返回：成功
frontend_session_lifetime_limited 布尔值	指定会话生命周期的限制是否有效返回：成功
frontend_session_lifetime_scope 字符串	frontend_session_lifetime 的范围 (days\|hours\|minutes) 返回：成功
frontend_session_timeout 整数	会话超时返回：成功
frontend_session_timeout_enabled 布尔值	指定会话超时是否有效返回：成功
frontend_session_timeout_scope 字符串	frontend_session_timeout 的范围 (days\|hours\|minutes) 返回：成功
logout_delegation_urls 列表 / 元素=字符串	注销委托到的注销 URL 列表返回：成功
logout_mode 字符串	注销模式 (None\|Delegation) 返回：成功
name 字符串	对象的名称返回：成功
redirect_to_requested_url 布尔值	是否应重定向到请求的 URL 返回：成功

作者

Stephan Schwarz (@stearz)