fortinet.fortios.fortios_user_peer 模块 – 在 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_peer。

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_peer

字典

配置对等用户。

ca

字符串

CA 证书的名称。源 vpn.certificate.ca.name。

cn

字符串

对等证书公用名。

cn_type

字符串

对等证书公用名类型。

选项

  • "string"

  • "email"

  • "FQDN"

  • "ipv4"

  • "ipv6"

ldap_mode

字符串

LDAP 对等身份验证的模式。

选项

  • "password"

  • "principal-name"

ldap_password

字符串

用于 LDAP 服务器绑定的密码。

ldap_server

字符串

在用户 ldap 命令下定义的 LDAP 服务器的名称。执行客户端访问权限检查。源 user.ldap.name。

ldap_username

字符串

用于 LDAP 服务器绑定的用户名。

mandatory_ca_verify

字符串

确定如果未安装 CA 证书，对等方会发生什么情况。禁用可自动将对等证书视为有效。

选项

  • "enable"

  • "disable"

mfa_mode

字符串

用于远程对等身份验证/授权的 MFA 模式。

选项

  • "none"

  • "password"

  • "subject-identity"

mfa_password

字符串

用于远程身份验证的统一密码。当使用 RADIUS 身份验证时，此字段可以留空，在这种情况下，FortiGate 将使用 RADIUS 用户名作为密码。

mfa_server

字符串

远程身份验证器的名称。执行客户端访问权限检查。源 user.radius.name user.ldap.name。

mfa_username

字符串

用于远程身份验证的统一用户名。

name

字符串 / 必需

对等名称。

ocsp_override_server

字符串

用于证书检索的在线证书状态协议 (OCSP) 服务器。源 vpn.certificate.ocsp-server.name。

passwd

字符串

对等方用于双因素身份验证的密码。

subject

字符串

对等证书名称约束。

two_factor

字符串

启用/禁用双因素身份验证，应用基于证书和密码的身份验证。

选项

  • "enable"

  • "disable"

vdom

字符串

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

默认值： "root"

说明

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure peer users.
  fortinet.fortios.fortios_user_peer:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_peer:
          ca: "<your_own_value> (source vpn.certificate.ca.name)"
          cn: "<your_own_value>"
          cn_type: "string"
          ldap_mode: "password"
          ldap_password: "<your_own_value>"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          ldap_username: "<your_own_value>"
          mandatory_ca_verify: "enable"
          mfa_mode: "none"
          mfa_password: "<your_own_value>"
          mfa_server: "<your_own_value> (source user.radius.name user.ldap.name)"
          mfa_username: "<your_own_value>"
          name: "default_name_15"
          ocsp_override_server: "<your_own_value> (source vpn.certificate.ocsp-server.name)"
          passwd: "<your_own_value>"
          subject: "<your_own_value>"
          two_factor: "enable"

返回值

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

键

描述

build

字符串

FortiGate 映像的版本号

已返回： 始终

示例： "1547"

http_method

字符串

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

已返回： 始终

示例： "PUT"

http_status

字符串

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

已返回： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥（id）

已返回： 成功

示例： "id"

name

字符串

用于满足请求的表名称

已返回： 始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

已返回： 始终

示例: "webfilter"

修订版本

字符串

内部修订号

已返回： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

已返回： 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

已返回： 始终

示例: "success"

vdom

字符串

使用的虚拟域

已返回： 始终

示例: "root"

版本

字符串

FortiGate的版本

已返回： 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)