fortinet.fortios.fortios_user_local 模块 – 配置 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_local。

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_local

字典

配置本地用户。

auth_concurrent_override

字符串

启用/禁用覆盖 config system global 下的 policy-auth-concurrent。

选项

  • "enable"

  • "disable"

auth_concurrent_value

整数

允许来自同一用户的最大并发登录数。

authtimeout

整数

用户身份验证超时之前的时间（分钟）。

email_to

字符串

双因素验证收件人的电子邮件地址。

fortitoken

字符串

双因素验证收件人的 FortiToken 序列号。来源 user.fortitoken.serial-number。

id

整数

用户 ID。

ldap_server

字符串

用户必须对其进行身份验证的 LDAP 服务器的名称。来源 user.ldap.name。

name

字符串 / 必需

本地用户名。

passwd

字符串

用户的密码。

passwd_policy

字符串

要应用于此用户的密码策略，在 config user password-policy 中定义。来源 user.password-policy.name。

passwd_time

字符串

上次密码更新的时间。

ppk_identity

字符串

IKEv2 后量子预共享密钥标识。

ppk_secret

字符串

IKEv2 后量子预共享密钥（ASCII 字符串或以 0x 开头的十六进制编码）。

qkd_profile

字符串

量子密钥分发 (QKD) 配置文件。来源 vpn.qkd.name。

radius_server

字符串

用户必须对其进行身份验证的 RADIUS 服务器的名称。来源 user.radius.name。

sms_custom_server

字符串

双因素验证收件人的 SMS 服务器。来源 system.sms-server.name。

sms_phone

字符串

双因素验证收件人的手机号码。

sms_server

字符串

通过 FortiGuard 或其他外部服务器发送短信。

选项

  • "fortiguard"

  • "custom"

status

字符串

启用/禁用允许本地用户使用 FortiGate 设备进行身份验证。

选项

  • "enable"

  • "disable"

tacacs_plus_server

字符串

用户必须对其进行身份验证的 TACACS+ 服务器的名称。来源 user.tacacs+.name。

two_factor

字符串

启用/禁用双因素身份验证。

选项

  • "disable"

  • "fortitoken"

  • "fortitoken-cloud"

  • "email"

  • "sms"

two_factor_authentication

字符串

FortiToken Cloud 的身份验证方法。

选项

  • "fortitoken"

  • "email"

  • "sms"

two_factor_notification

字符串

FortiToken Cloud 用户激活的通知方法。

选项

  • "email"

  • "sms"

type

字符串

身份验证方法。

选项

  • "password"

  • "radius"

  • "tacacs+"

  • "ldap"

username_case_sensitivity

字符串

启用/禁用执行用户名匹配时的区分大小写 (大写和小写字母被视为不同或相同)。

选项

  • "disable"

  • "enable"

username_sensitivity

字符串

启用/禁用执行用户名匹配时的区分大小写和重音符号 (禁用时，将去除重音符号并忽略大小写)。

选项

  • "disable"

  • "enable"

workstation

字符串

远程用户工作站的名称，如果您想限制用户只能从特定工作站进行身份验证。

vdom

字符串

虚拟域，在之前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

备注

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure local users.
  fortinet.fortios.fortios_user_local:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_local:
          auth_concurrent_override: "enable"
          auth_concurrent_value: "0"
          authtimeout: "0"
          email_to: "<your_own_value>"
          fortitoken: "<your_own_value> (source user.fortitoken.serial-number)"
          id: "8"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          name: "default_name_10"
          passwd: "<your_own_value>"
          passwd_policy: "<your_own_value> (source user.password-policy.name)"
          passwd_time: "<your_own_value>"
          ppk_identity: "<your_own_value>"
          ppk_secret: "<your_own_value>"
          qkd_profile: "<your_own_value> (source vpn.qkd.name)"
          radius_server: "<your_own_value> (source user.radius.name)"
          sms_custom_server: "<your_own_value> (source system.sms-server.name)"
          sms_phone: "<your_own_value>"
          sms_server: "fortiguard"
          status: "enable"
          tacacs_plus_server: "<your_own_value> (source user.tacacs+.name)"
          two_factor: "disable"
          two_factor_authentication: "fortitoken"
          two_factor_notification: "email"
          type: "password"
          username_case_sensitivity: "disable"
          username_sensitivity: "disable"
          workstation: "<your_own_value>"

返回值

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

键

描述

build

字符串

FortiGate 映像的内部版本号

返回： 始终

示例： "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回： 成功

示例： "id"

name

字符串

用于满足请求的表名

返回： 始终

示例： "urlfilter"

路径

字符串

用于满足请求的表路径

返回： 始终

示例： "webfilter"

版本号

字符串

内部版本号

返回： 始终

示例： "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate的版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪宾 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)