fortinet.fortios.fortios_vpn_ocvpn 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置覆盖控制器 VPN 设置。

注意

此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_vpn_ocvpn。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 VPN 功能和 ocvpn 类别来配置 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"

vdom

字符串

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

默认值: "root"

vpn_ocvpn

字典

配置覆盖控制器 VPN 设置。

auto_discovery

字符串

启用/禁用自动发现快捷方式。

选择

  • "enable"

  • "disable"

auto_discovery_shortcut_mode

字符串

控制当父隧道关闭时删除子快捷隧道。

选择

  • "independent"

  • "dependent"

eap

字符串

启用/禁用 EAP 客户端身份验证。

选择

  • "enable"

  • "disable"

eap_users

字符串

EAP 身份验证用户组。源 user.group.name。

forticlient_access

字典

配置 FortiClient 设置。

auth_groups

列表 / 元素=字典

FortiClient 用户身份验证组。

auth_group

字符串

用于 FortiClient 访问的身份验证用户组。源 user.group.name。

name

字符串 / 必需

组名称。

overlays

列表 / 元素=字典

允许访问的 OCVPN 覆盖。

overlay_name

字符串 / 必需

覆盖名称。源 vpn.ocvpn.overlays.overlay-name。

psksecret

字符串

用于 FortiClient PSK 身份验证的预共享密钥（ASCII 字符串或以 0x 开头的十六进制编码）。

status

字符串

启用/禁用 FortiClient 访问 OCVPN 网络。

选择

  • "enable"

  • "disable"

ha_alias

字符串

隐藏 HA 别名。

ip_allocation_block

字符串

为私有 IP 地址分配保留的 B 类子网。

multipath

字符串

启用/禁用多路径冗余。

选择

  • "enable"

  • "disable"

nat

字符串

启用/禁用 NAT 支持。

选择

  • "enable"

  • "disable"

overlays

列表 / 元素=字典

要向覆盖控制器 VPN 服务注册的网络覆盖。

assign_ip

字符串

启用/禁用模式配置地址分配。

选择

  • "enable"

  • "disable"

id

整数

ID。

inter_overlay

字符串

允许或拒绝来自其他覆盖的流量。

选择

  • "allow"

  • "deny"

ipv4_end_ip

字符串

IPv4 范围的结束地址。

ipv4_start_ip

字符串

IPv4 范围的起始地址。

name

字符串

覆盖名称。

overlay_name

字符串 / 必需

覆盖名称。

subnets

列表 / 元素=字典

要向 OCVPN 服务注册的内部子网。

id

整数 / 必需

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

interface

字符串

LAN 接口。源 system.interface.name。

subnet

字符串

IPv4 地址和子网掩码。

type

字符串

子网类型。

选择

  • "subnet"

  • "interface"

poll_interval

整数

覆盖控制器 VPN 轮询间隔。

role

字符串

设置设备角色。

选择

  • "spoke"

  • "primary-hub"

  • "secondary-hub"

sdwan

字符串

启用/禁用将 OCVPN 隧道添加到 SD-WAN。

选择

  • "enable"

  • "disable"

sdwan_zone

字符串

设置 SD-WAN 区域。源 system.sdwan.zone.name。

status

字符串

启用/禁用覆盖控制器云辅助 VPN。

选择

  • "enable"

  • "disable"

subnets

列表 / 元素=字典

要向覆盖控制器 VPN 服务注册的内部子网。

id

整数 / 必需

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

interface

字符串

LAN 接口。源 system.interface.name。

subnet

字符串

IPv4 地址和子网掩码。

type

字符串

子网类型。

选择

  • "subnet"

  • "interface"

wan_interface

列表 / 元素=字典

要与 OCVPN 一起使用的 FortiGate WAN 接口。

name

字符串 / 必需

接口名称。源 system.interface.name。

注释

注意

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

示例

- name: Configure Overlay Controller VPN settings.
  fortinet.fortios.fortios_vpn_ocvpn:
      vdom: "{{ vdom }}"
      vpn_ocvpn:
          auto_discovery: "enable"
          auto_discovery_shortcut_mode: "independent"
          eap: "enable"
          eap_users: "<your_own_value> (source user.group.name)"
          forticlient_access:
              auth_groups:
                  -
                      auth_group: "<your_own_value> (source user.group.name)"
                      name: "default_name_10"
                      overlays:
                          -
                              overlay_name: "<your_own_value> (source vpn.ocvpn.overlays.overlay-name)"
              psksecret: "<your_own_value>"
              status: "enable"
          ha_alias: "<your_own_value>"
          ip_allocation_block: "<your_own_value>"
          multipath: "enable"
          nat: "enable"
          overlays:
              -
                  assign_ip: "enable"
                  id: "21"
                  inter_overlay: "allow"
                  ipv4_end_ip: "<your_own_value>"
                  ipv4_start_ip: "<your_own_value>"
                  name: "default_name_25"
                  overlay_name: "<your_own_value>"
                  subnets:
                      -
                          id: "28"
                          interface: "<your_own_value> (source system.interface.name)"
                          subnet: "<your_own_value>"
                          type: "subnet"
          poll_interval: "30"
          role: "spoke"
          sdwan: "enable"
          sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
          status: "enable"
          subnets:
              -
                  id: "38"
                  interface: "<your_own_value> (source system.interface.name)"
                  subnet: "<your_own_value>"
                  type: "subnet"
          wan_interface:
              -
                  name: "default_name_43 (source system.interface.name)"

返回值

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

键

描述

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"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)