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。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 Playbook 中使用它，请指定：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

列表 / elements=dictionary

访客用户。

comment

字符串

注释。

company

字符串

设置公司访客用户字段的操作。

email

字符串

电子邮件。

expiration

字符串

过期时间。

id

整数 / 必需

访客 ID。请参阅 <a href=’#notes’>注释</a>。

mobile_phone

字符串

手机号码。

name

字符串

访客姓名。

password

字符串

访客密码。

sponsor

字符串

设置赞助商访客用户字段的操作。

user_id

字符串

访客 ID。

http_digest_realm

字符串

用于 MD5-摘要身份验证的 Realm 属性。

id

整数

组 ID。

match

列表 / elements=dictionary

组匹配。

group_name

字符串

远程身份验证服务器或 SCIM 上匹配用户或组的名称。

id

整数 / 必需

ID。请参阅 <a href=’#notes’>注释</a>。

server_name

字符串

远程身份验证服务器的名称。来源 user.radius.name user.ldap.name user.tacacs+.name user.saml.name user .external-identity-provider.name。

max_accounts

整数

可以为此组创建的最大访客帐户数（0 表示无限制）。

member

列表 / elements=dictionary

要添加到用户组的用户、对等方、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 是运行 playbook 的首选方式。

  • 该模块支持 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"

返回值

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

键

描述

构建

字符串

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 Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)