fortinet.fortios.fortios_user_group 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置用户组。

注意

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

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

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

要在剧本中使用它，请指定： fortinet.fortios.fortios_user_group。

fortinet.fortios 2.0.0 中的新增功能

概要

• 此模块能够通过允许用户设置和修改用户功能和组类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。在 FOS v6.0.0 上测试。

需求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
member_path 字符串	要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
state 字符串 / 必需	指示是创建还是删除对象。 选项 "present" "absent"
user_group 字典	配置用户组。
auth_concurrent_override 字符串	启用/禁用为该用户组覆盖全局并发身份验证会话数。 选项 "enable" "disable"
auth_concurrent_value 整数	每个用户的最大并发身份验证连接数 (0 - 100)。
authtimeout 整数	此用户组的身份验证超时时间（分钟）。0 表示使用全局用户设置 auth-timeout。
company 字符串	设置公司访客用户字段的操作。 选项 "optional" "mandatory" "disabled"
email 字符串	启用/禁用访客用户电子邮件地址字段。 选项 "disable" "enable"
expire 整数	访客用户帐户过期前的时间（秒）（1 - 31536000）。
expire_type 字符串	确定过期倒计时何时开始。 选项 "immediately" "first-successful-login"
group_type 字符串	将组设置为用于防火墙身份验证、FSSO、RSSO 或访客用户。 选项 "firewall" "fsso-service" "rsso" "guest"
guest 列表 / 元素=字典	访客用户。
comment 字符串	注释。
company 字符串	设置公司访客用户字段的操作。
email 字符串	Email。
expiration 字符串	过期时间。
id 整数 / 必需	访客 ID。请参阅 备注。
mobile_phone 字符串	手机。
name 字符串	访客姓名。
password 字符串	访客密码。
sponsor 字符串	设置赞助商访客用户字段的操作。
user_id 字符串	访客 ID。
http_digest_realm 字符串	MD5-digest 身份验证的 Realm 属性。
id 整数	组 ID。
match 列表 / 元素=字典	组匹配项。
group_name 字符串	远程身份验证服务器或 SCIM 上匹配的用户或组的名称。
id 整数 / 必需	ID。请参阅 备注。
server_name 字符串	远程身份验证服务器的名称。来源 user.radius.name user.ldap.name user.tacacs+.name user.saml.name user .external-identity-provider.name。
max_accounts 整数	可以为此组创建的最大访客帐户数（0 表示无限）。
member 列表 / 元素=字典	要添加到用户组的用户、对等体、LDAP 服务器、RADIUS 服务器或外部 IDP 服务器的名称。
name 字符串 / 必需	组成员名称。来源 user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.saml.name user .external-identity-provider.name user.adgrp.name user.pop3.name user.certificate.name。
mobile_phone 字符串	启用/禁用访客用户的手机号码字段。 选项 "disable" "enable"
multiple_guest_add 字符串	启用/禁用添加多个访客。 选项 "disable" "enable"
name 字符串 / 必需	组名称。
password 字符串	访客用户密码类型。 选项 "auto-generate" "specify" "disable"
sms_custom_server 字符串	短信服务器。来源 system.sms-server.name。
sms_server 字符串	通过 FortiGuard 或其他外部服务器发送短信。 选项 "fortiguard" "custom"
sponsor 字符串	设置赞助商访客用户字段的操作。 选项 "optional" "mandatory" "disabled"
sso_attribute_value 字符串	此本地用户组代表的 RADIUS 用户组的名称。
user_id 字符串	访客用户 ID 类型。 选项 "email" "auto-generate" "specify"
user_name 字符串	启用/禁用访客用户名输入。 选项 "disable" "enable"
vdom 字符串	虚拟域，属于先前定义的那些虚拟域。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： "root"

备注

注意

• 旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。

• 该模块支持 check_mode。

示例

- name: Configure user groups.
  fortinet.fortios.fortios_user_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_group:
          auth_concurrent_override: "enable"
          auth_concurrent_value: "0"
          authtimeout: "0"
          company: "optional"
          email: "disable"
          expire: "14400"
          expire_type: "immediately"
          group_type: "firewall"
          guest:
              -
                  comment: "Comment."
                  company: "<your_own_value>"
                  email: "<your_own_value>"
                  expiration: "<your_own_value>"
                  id: "16"
                  mobile_phone: "<your_own_value>"
                  name: "default_name_18"
                  password: "<your_own_value>"
                  sponsor: "<your_own_value>"
                  user_id: "<your_own_value>"
          http_digest_realm: "<your_own_value>"
          id: "23"
          match:
              -
                  group_name: "<your_own_value>"
                  id: "26"
                  server_name: "<your_own_value> (source user.radius.name user.ldap.name user.tacacs+.name user.saml.name user.external-identity-provider
                    .name)"
          max_accounts: "0"
          member:
              -
                  name: "default_name_30 (source user.peer.name user.local.name user.radius.name user.tacacs+.name user.ldap.name user.saml.name user
                    .external-identity-provider.name user.adgrp.name user.pop3.name user.certificate.name)"
          mobile_phone: "disable"
          multiple_guest_add: "disable"
          name: "default_name_33"
          password: "auto-generate"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_server: "fortiguard"
          sponsor: "optional"
          sso_attribute_value: "<your_own_value>"
          user_id: "email"
          user_name: "disable"

返回值

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

键	描述
build 字符串	FortiGate 镜像的版本号 返回：始终 示例： "1547"
http_method 字符串	最后用于将内容置备到 FortiGate 的方法 返回：始终 示例： "PUT"
http_status 字符串	FortiGate 在最后一次操作中给出的最终结果 返回：始终 示例： "200"
mkey 字符串	最后一次调用 FortiGate 时使用的主密钥 (ID) 返回：成功 示例： "id"
name 字符串	用于完成请求的表名称 返回：始终 示例： "urlfilter"
path 字符串	用于完成请求的表路径 返回：始终 示例： "webfilter"
revision 字符串	内部修订号 返回：始终 示例： "17.0.2.10658"
serial 字符串	设备的序列号 返回：始终 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果指示 返回：始终 示例： "success"
vdom 字符串	使用的虚拟域 返回：始终 示例： "root"
version 字符串	FortiGate 的版本 返回：始终 示例： "v5.6.3"

作者

• 郑 link (@chillancezen)

• 薛杰 (@JieX19)

• 陆宏斌 (@fgtdev-hblu)

• 沈弗兰克 (@frankshen01)

• 米格尔·安赫尔·穆诺兹 (@mamunozgonzalez)

• 尼古拉斯·托马斯 (@thomnico)

资源链接

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