fortinet.fortios.fortios_firewall_auth_portal 模块 – 在 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_firewall_auth_portal

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

firewall_auth_portal

字典

配置防火墙身份验证门户。

groups

列表 / 元素=字典

允许通过此门户进行身份验证的防火墙用户组。用空格分隔组名称。

name

字符串 / 必需

组名称。源 user.group.name。

identity_based_route

字符串

适用于此门户的基于身份的路由的名称。源 firewall.identity-based-route.name。

portal_addr

字符串

身份验证门户的地址(或 FQDN)。

portal_addr6

字符串

身份验证门户的 IPv6 地址(或 FQDN)。

proxy_auth

字符串

启用/禁用代理守护程序进行身份验证。

选择

  • "enable"

  • "disable"

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

当指定 member_state 时,state 选项将被忽略。

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

说明

注意

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

示例

- name: Configure firewall authentication portals.
  fortinet.fortios.fortios_firewall_auth_portal:
      vdom: "{{ vdom }}"
      firewall_auth_portal:
          groups:
              -
                  name: "default_name_4 (source user.group.name)"
          identity_based_route: "<your_own_value> (source firewall.identity-based-route.name)"
          portal_addr: "<your_own_value>"
          portal_addr6: "<your_own_value>"
          proxy_auth: "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"

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)