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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

authentication_rule

字典

配置身份验证规则。

active_auth_method

字符串

选择活动身份验证方法。来源 authentication.scheme.name。

字符串

启用/禁用使用设备证书作为身份验证 Cookie。

选项

  • "enable"

  • "disable"

comments

字符串

注释。

cors_depth

整数

允许 CORS 访问的深度。

cors_stateful

字符串

启用/禁用允许 CORS 访问。

选项

  • "enable"

  • "disable"

dstaddr

列表 / 元素=字典

从可用选项中选择 IPv4 目的地址。Web 代理身份验证需要。

name

字符串 / 必需

地址名称。来源 firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system.external-resource.name。

dstaddr6

列表 / 元素=字典

从可用选项中选择 IPv6 目的地址。Web 代理身份验证需要。

name

字符串 / 必需

地址名称。来源 firewall.address6.name firewall.addrgrp6.name。

ip_based

字符串

启用/禁用基于 IP 的身份验证。启用后，来自同一 IP 地址的先前已通过身份验证的用户将被豁免。

选项

  • "enable"

  • "disable"

name

字符串 / 必需

身份验证规则名称。

protocol

字符串

所选协议需要身份验证。

选项

  • "http"

  • "ftp"

  • "socks"

  • "ssh"

srcaddr

列表 / 元素=字典

所选 IPv4 源地址需要身份验证。

name

字符串 / 必需

地址名称。来源 firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system.external-resource.name。

srcaddr6

列表 / 元素=字典

所选 IPv6 源地址需要身份验证。

name

字符串 / 必需

地址名称。来源 firewall.address6.name firewall.addrgrp6.name。

srcintf

列表 / 元素=字典

传入 (入站) 接口。

name

字符串 / 必需

接口名称。来源 system.interface.name system.zone.name system.sdwan.zone.name。

sso_auth_method

字符串

选择单点登录 (SSO) 身份验证方法。来源 authentication.scheme.name。

status

字符串

启用/禁用此身份验证规则。

选项

  • "enable"

  • "disable"

transaction_based

字符串

启用/禁用基于事务的身份验证。

选项

  • "enable"

  • "disable"

字符串

启用/禁用 Web 身份验证 Cookie。

选项

  • "enable"

  • "disable"

web_portal

字符串

启用/禁用代理透明策略的 Web 门户。

选项

  • "enable"

  • "disable"

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

注释

注意

  • 旧的 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方法。

  • 该模块支持 check_mode。

示例

- name: Configure Authentication Rules.
  fortinet.fortios.fortios_authentication_rule:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      authentication_rule:
          active_auth_method: "<your_own_value> (source authentication.scheme.name)"
          cert_auth_cookie: "enable"
          comments: "<your_own_value>"
          cors_depth: "3"
          cors_stateful: "enable"
          dstaddr:
              -
                  name: "default_name_9 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          dstaddr6:
              -
                  name: "default_name_11 (source firewall.address6.name firewall.addrgrp6.name)"
          ip_based: "enable"
          name: "default_name_13"
          protocol: "http"
          srcaddr:
              -
                  name: "default_name_16 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
                    .external-resource.name)"
          srcaddr6:
              -
                  name: "default_name_18 (source firewall.address6.name firewall.addrgrp6.name)"
          srcintf:
              -
                  name: "default_name_20 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          sso_auth_method: "<your_own_value> (source authentication.scheme.name)"
          status: "enable"
          transaction_based: "enable"
          web_auth_cookie: "enable"
          web_portal: "enable"

返回值

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

键

描述

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"

版本

字符串

FortiGate 版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪滨 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)