fortinet.fortimanager.fmgr_user_group_dynamicmapping 模块 – 配置用户组。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_user_group_dynamicmapping。
fortinet.fortimanager 2.1.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括需要在使用前调整为数据源的所有参数和值。
参数
参数 |
注释 |
|---|---|
无需用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
请求 URL 中的参数 (group)。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
设置的顶级参数。 |
|
范围。 |
|
名称。 |
|
Vdom。 |
|
启用/禁用覆盖此用户组的并发身份验证会话的全局数量。 选项
|
|
每个用户的最大并发身份验证连接数 |
|
此用户组的身份验证超时（分钟）。 |
|
设置公司访客用户字段的操作。 选项
|
|
启用/禁用访客用户电子邮件地址字段。 选项
|
|
访客用户帐户过期前的时间（秒）。 |
|
确定过期倒计时何时开始。 选项
|
|
设置组用于防火墙身份验证、FSSO、RSSO 或访客用户。 选项
|
|
访客。 |
|
注释。 |
|
设置公司访客用户字段的操作。 |
|
电子邮件。 |
|
过期时间。 |
|
组。 |
|
访客 ID。 |
|
手机号码。 |
|
访客姓名。 |
|
(列表) 访客密码。 |
|
设置发起人访客用户字段的操作。 |
|
访客 ID。 |
|
MD5-digest 身份验证的 Realm 属性。 |
|
组 ID。 |
|
Ldap 成员。 |
|
逻辑类型。 选项
|
|
匹配。 |
|
GUI 元数据。 |
|
远程身份验证服务器上匹配的用户或组的名称。 |
|
ID。 |
|
远程身份验证服务器的名称。 |
|
可以为此组创建的最大访客帐户数 |
|
(列表或字符串) 要添加到用户组的用户、对等体、LDAP 服务器或 RADIUS 服务器的名称。 |
|
启用/禁用访客用户手机号码字段。 选项
|
|
启用/禁用添加多个访客。 选项
|
|
访客用户密码类型。 选项
|
|
重定向 URL。 |
|
短信服务器。 |
|
通过 FortiGuard 或其他外部服务器发送短信。 选项
|
|
设置发起人访客用户字段的操作。 选项
|
|
(列表或字符串) SSLVPN 书签组。 |
|
SSLVPN 缓存清除器。 选项
|
|
SSLVPN 客户端检查。 选项
|
|
SSLVPN FTP。 选项
|
|
SSLVPN HTTP。 选项
|
|
SSLVPN 操作系统检查。 选项
|
|
SSLVPN 操作系统检查列表。 |
|
操作。 选项
|
|
最新补丁级别。 |
|
名称。 |
|
容差。 |
|
(列表或字符串) SSLVPN 门户。 |
|
SSLVPN 门户标题。 |
|
SSLVPN RDP。 选项
|
|
SSLVPN Samba。 选项
|
|
SSLVPN 分裂隧道。 选项
|
|
SSLVPN SSH。 选项
|
|
SSLVPN Telnet。 选项
|
|
SSLVPN 隧道。 选项
|
|
SSLVPN 隧道结束IP。 |
|
SSLVPN 隧道IP模式。 选项
|
|
SSLVPN 隧道起始IP。 |
|
SSLVPN 虚拟桌面。 选项
|
|
SSLVPN VNC。 选项
|
|
SSLVPN Web 应用。 选项
|
|
此本地用户组代表的 RADIUS 用户组的名称。 |
|
访客用户ID类型。 选项
|
|
启用/禁用访客用户名输入。 选项
|
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是全局和其他值，包括根。 |
|
等待其他用户释放工作区锁的最大时间（秒）。 默认： |
注释
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将参数（例如“var-name”）更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。
示例
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure user groups.
fortinet.fortimanager.fmgr_user_group_dynamicmapping:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
group: <your own value>
state: present # <value in [present, absent]>
user_group_dynamicmapping:
_scope:
-
name: <string>
vdom: <string>
auth_concurrent_override: <value in [disable, enable]>
auth_concurrent_value: <integer>
authtimeout: <integer>
company: <value in [optional, mandatory, disabled]>
email: <value in [disable, enable]>
expire: <integer>
expire_type: <value in [immediately, first-successful-login]>
group_type: <value in [firewall, directory-service, fsso-service, ...]>
guest:
-
comment: <string>
company: <string>
email: <string>
expiration: <string>
group: <string>
id: <integer>
mobile_phone: <string>
name: <string>
password: <list or string>
sponsor: <string>
user_id: <string>
http_digest_realm: <string>
id: <integer>
ldap_memberof: <string>
logic_type: <value in [or, and]>
match:
-
_gui_meta: <string>
group_name: <string>
id: <integer>
server_name: <string>
max_accounts: <integer>
member: <list or string>
mobile_phone: <value in [disable, enable]>
multiple_guest_add: <value in [disable, enable]>
password: <value in [auto-generate, specify, disable]>
redir_url: <string>
sms_custom_server: <string>
sms_server: <value in [fortiguard, custom]>
sponsor: <value in [optional, mandatory, disabled]>
sslvpn_bookmarks_group: <list or string>
sslvpn_cache_cleaner: <value in [disable, enable]>
sslvpn_client_check:
- "forticlient"
- "forticlient-av"
- "forticlient-fw"
- "3rdAV"
- "3rdFW"
sslvpn_ftp: <value in [disable, enable]>
sslvpn_http: <value in [disable, enable]>
sslvpn_os_check: <value in [disable, enable]>
sslvpn_os_check_list:
action: <value in [allow, check-up-to-date, deny]>
latest_patch_level: <string>
name: <string>
tolerance: <integer>
sslvpn_portal: <list or string>
sslvpn_portal_heading: <string>
sslvpn_rdp: <value in [disable, enable]>
sslvpn_samba: <value in [disable, enable]>
sslvpn_split_tunneling: <value in [disable, enable]>
sslvpn_ssh: <value in [disable, enable]>
sslvpn_telnet: <value in [disable, enable]>
sslvpn_tunnel: <value in [disable, enable]>
sslvpn_tunnel_endip: <string>
sslvpn_tunnel_ip_mode: <value in [range, usrgrp]>
sslvpn_tunnel_startip: <string>
sslvpn_virtual_desktop: <value in [disable, enable]>
sslvpn_vnc: <value in [disable, enable]>
sslvpn_webapp: <value in [disable, enable]>
sso_attribute_value: <string>
user_id: <value in [email, auto-generate, specify]>
user_name: <value in [disable, enable]>
返回值
常见的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整 URL。 返回：始终 示例： |
|
API 请求的状态。 返回：始终 示例： |
|
API 响应。 返回：始终 |
|
API 响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂 |