fortinet.fortimanager.fmgr_user_group 模块 – 配置用户组。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

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

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

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_user_group。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包含所有参数和值，在使用前需要将其调整为数据源。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
user_group 字典	设置的顶级参数。
auth_concurrent_override 别名：auth-concurrent-override 字符串	启用/禁用覆盖此用户组的全局并发身份验证会话数。 选项 "disable" "enable"
auth_concurrent_value 别名：auth-concurrent-value 整数	每个用户的最大并发身份验证连接数
authtimeout 整数	此用户组的身份验证超时时间（分钟）。
company 字符串	设置公司访客用户字段的操作。 选项 "optional" "mandatory" "disabled"
dynamic_mapping 列表 / 元素=字典	动态映射。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
auth_concurrent_override 别名：auth-concurrent-override 字符串	启用/禁用覆盖此用户组的全局并发身份验证会话数。 选项 "disable" "enable"
auth_concurrent_value 别名：auth-concurrent-value 整数	每个用户的最大并发身份验证连接数
authtimeout 整数	此用户组的身份验证超时时间（分钟）。
company 字符串	设置公司访客用户字段的操作。 选项 "optional" "mandatory" "disabled"
email 字符串	启用/禁用访客用户电子邮件地址字段。 选项 "disable" "enable"
expire 整数	访客用户帐户过期前的时间（秒）。
expire_type 别名：expire-type 字符串	确定过期倒计时何时开始。 选项 "immediately" "first-successful-login"
group_type 别名：group-type 字符串	将组设置为用于防火墙身份验证、FSSO、RSSO 或访客用户。 选项 "firewall" "directory-service" "fsso-service" "guest" "rsso"
guest 列表 / 元素=字典	访客。
comment 字符串	注释。
company 字符串	设置公司访客用户字段的操作。
email 字符串	Email。
expiration 字符串	过期时间。
group 字符串	组。
id 整数	访客 ID。
mobile_phone 别名：mobile-phone 字符串	手机。
name 字符串	访客姓名。
password 任意	(列表) 访客密码。
sponsor 字符串	设置赞助商访客用户字段的操作。
user_id 别名：user-id 字符串	访客 ID。
http_digest_realm 别名：http-digest-realm 字符串	MD5-digest 身份验证的 Realm 属性。
id 整数	组 ID。
ldap_memberof 别名：ldap-memberof 字符串	Ldap 成员。
logic_type 别名：logic-type 字符串	逻辑类型。 选项 "or" "and"
match 列表 / 元素=字典	匹配。
_gui_meta 字符串	Gui 元数据。
group_name 别名：group-name 字符串	远程身份验证服务器上匹配的用户或组的名称。
id 整数	ID。
server_name 别名：server-name 字符串	远程身份验证服务器的名称。
max_accounts 别名：max-accounts 整数	可以为此组创建的访客帐户的最大数量
member 任意	(列表或字符串) 要添加到用户组的用户、对等体、LDAP 服务器或 RADIUS 服务器的名称。
mobile_phone 别名：mobile-phone 字符串	启用/禁用访客用户手机号码字段。 选项 "disable" "enable"
multiple_guest_add 别名：multiple-guest-add 字符串	启用/禁用添加多个访客。 选项 "disable" "enable"
password 字符串	访客用户密码类型。 选项 "auto-generate" "specify" "disable"
redir_url 别名：redir-url 字符串	重定向 URL。
sms_custom_server 别名：sms-custom-server 字符串	短信服务器。
sms_server 别名：sms-server 字符串	通过 FortiGuard 或其他外部服务器发送短信。 选项 "fortiguard" "custom"
sponsor 字符串	设置赞助商访客用户字段的操作。 选项 "optional" "mandatory" "disabled"
sslvpn_bookmarks_group 别名：sslvpn-bookmarks-group 任意	(列表或字符串) Sslvpn 书签组。
sslvpn_cache_cleaner 别名：sslvpn-cache-cleaner 字符串	Sslvpn 缓存清理器。 选项 "disable" "enable"
sslvpn_client_check 别名: sslvpn-client-check 列表 / 元素=字符串	SSL VPN 客户端检查。 选项 "forticlient" "forticlient-av" "forticlient-fw" "3rdAV" "3rdFW"
sslvpn_ftp 别名: sslvpn-ftp 字符串	SSL VPN FTP。 选项 "disable" "enable"
sslvpn_http 别名: sslvpn-http 字符串	SSL VPN HTTP。 选项 "disable" "enable"
sslvpn_os_check 别名: sslvpn-os-check 字符串	SSL VPN 操作系统检查。 选项 "disable" "enable"
sslvpn_os_check_list 别名: sslvpn-os-check-list 字典	SSL VPN 操作系统检查列表。
action 字符串	操作。 选项 "允许" "检查最新版本" "拒绝"
latest_patch_level 别名: latest-patch-level 字符串	最新补丁级别。
name 字符串	名称。
tolerance 整数	容差。
sslvpn_portal 别名: sslvpn-portal 任意	(列表或字符串) SSL VPN 端口。
sslvpn_portal_heading 别名: sslvpn-portal-heading 字符串	SSL VPN 端口标题。
sslvpn_rdp 别名: sslvpn-rdp 字符串	SSL VPN RDP。 选项 "disable" "enable"
sslvpn_samba 别名: sslvpn-samba 字符串	SSL VPN Samba。 选项 "disable" "enable"
sslvpn_split_tunneling 别名: sslvpn-split-tunneling 字符串	SSL VPN 分裂隧道。 选项 "disable" "enable"
sslvpn_ssh 别名: sslvpn-ssh 字符串	SSL VPN SSH。 选项 "disable" "enable"
sslvpn_telnet 别名: sslvpn-telnet 字符串	SSL VPN Telnet。 选项 "disable" "enable"
sslvpn_tunnel 别名: sslvpn-tunnel 字符串	SSL VPN 隧道。 选项 "disable" "enable"
sslvpn_tunnel_endip 别名: sslvpn-tunnel-endip 字符串	SSL VPN 隧道结束IP。
sslvpn_tunnel_ip_mode 别名: sslvpn-tunnel-ip-mode 字符串	SSL VPN 隧道IP模式。 选项 "范围" "用户组"
sslvpn_tunnel_startip 别名: sslvpn-tunnel-startip 字符串	SSL VPN 隧道起始IP。
sslvpn_virtual_desktop 别名: sslvpn-virtual-desktop 字符串	SSL VPN 虚拟桌面。 选项 "disable" "enable"
sslvpn_vnc 别名: sslvpn-vnc 字符串	SSL VPN VNC。 选项 "disable" "enable"
sslvpn_webapp 别名: sslvpn-webapp 字符串	SSL VPN Web 应用。 选项 "disable" "enable"
sso_attribute_value 别名: sso-attribute-value 字符串	此本地用户组代表的 RADIUS 用户组名称。
user_id 别名：user-id 字符串	访客用户ID类型。 选项 "邮箱" "auto-generate" "specify"
user_name 别名: user-name 字符串	启用/禁用访客用户名输入。 选项 "disable" "enable"
email 字符串	启用/禁用访客用户电子邮件地址字段。 选项 "disable" "enable"
expire 整数	访客用户帐户过期前的时间（秒）。
expire_type 别名：expire-type 字符串	确定过期倒计时何时开始。 选项 "immediately" "first-successful-login"
group_type 别名：group-type 字符串	将组设置为用于防火墙身份验证、FSSO、RSSO 或访客用户。 选项 "firewall" "directory-service" "fsso-service" "guest" "rsso"
guest 列表 / 元素=字典	访客。
comment 字符串	注释。
company 字符串	设置公司访客用户字段的操作。
email 字符串	Email。
expiration 字符串	过期时间。
group 字符串	访客姓名。
id 整数	访客 ID。
mobile_phone 别名：mobile-phone 字符串	手机。
name 字符串	访客姓名。
password 任意	(列表) 访客密码。
sponsor 字符串	设置赞助商访客用户字段的操作。
user_id 别名：user-id 字符串	访客 ID。
http_digest_realm 别名：http-digest-realm 字符串	MD5-digest 身份验证的 Realm 属性。
id 整数	组 ID。
match 列表 / 元素=字典	匹配。
_gui_meta 字符串	Gui 元数据。
group_name 别名：group-name 字符串	远程认证服务器上匹配组的名称。
id 整数	ID。
server_name 别名：server-name 字符串	远程身份验证服务器的名称。
max_accounts 别名：max-accounts 整数	可以为此组创建的访客帐户的最大数量
member 列表 / 元素=字符串	要添加到用户组的用户、对等体、LDAP 服务器或 RADIUS 服务器的名称。
mobile_phone 别名：mobile-phone 字符串	启用/禁用访客用户手机号码字段。 选项 "disable" "enable"
multiple_guest_add 别名：multiple-guest-add 字符串	启用/禁用添加多个访客。 选项 "disable" "enable"
name 字符串 / 必需	组名。
password 字符串	访客用户密码类型。 选项 "auto-generate" "specify" "disable"
sms_custom_server 别名：sms-custom-server 字符串	短信服务器。
sms_server 别名：sms-server 字符串	通过 FortiGuard 或其他外部服务器发送短信。 选项 "fortiguard" "custom"
sponsor 字符串	设置赞助商访客用户字段的操作。 选项 "optional" "mandatory" "disabled"
sso_attribute_value 别名: sso-attribute-value 字符串	此本地用户组代表的 RADIUS 用户组名称。
user_id 别名：user-id 字符串	访客用户ID类型。 选项 "邮箱" "auto-generate" "specify"
user_name 别名: user-name 字符串	启用/禁用访客用户名输入。 选项 "disable" "enable"
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是 global 和其他值，包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最长时间（秒）。 默认值: 300

注释

注意

• 从 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
  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:
        bypass_validation: false
        adom: FortiCarrier
        state: present
        user_group:
          id: 1
          name: ansible-test-group
          password: specify # <value in [auto-generate, specify, disable]>
          user-id: email # <value in [email, auto-generate, specify]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the user groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_group"
          params:
            adom: "ansible"
            group: "your_value"

返回值

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

键	描述
meta 字典	请求的结果。 返回值: 始终
request_url 字符串	请求的完整 URL。 返回值: 始终 示例: "/sys/login/user"
response_code 整数	API 请求的状态。 返回值: 始终 示例: 0
response_data 列表 / 元素=字符串	API 响应。 返回值: 始终
response_message 字符串	API 响应的描述性消息。 返回值: 始终 示例: "OK."
system_information 字典	目标系统的信息。 返回值: 始终
rc 整数	请求的状态。 返回值: 始终 示例: 0
version_check_warning 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值: 复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑凌 (@chillancezen)

• 沈峰 (@fshen01)

• 卢宏斌 (@fgtdev-hblu)

资源链接

• 问题跟踪器
• 主页
• 代码仓库