fortinet.fortios.fortios_system_fabric_vpn 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中设置自编排的 Fabric 自动发现 VPN。

注意

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

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortios。您需要满足其他要求才能使用此模块,有关详细信息,请参阅要求

要在 playbook 中使用它,请指定: fortinet.fortios.fortios_system_fabric_vpn

fortinet.fortios 2.0.0 中的新增功能

概要

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

system_fabric_vpn

字典

设置用于自编排的 Fabric 自动发现 VPN。

advertised_subnets

列表 / 元素=字典

本地通告的子网。

access

字符串

访问策略方向。

选择

  • "inbound"

  • "bidirectional"

bgp_network

整数

底层 BGP 网络。源 router.bgp.network.id。

firewall_address

字符串

底层防火墙地址。源 firewall.address.name。

id

整数 / 必需

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

policies

列表 / 元素=整数

底层策略。源 firewall.policy.policyid。

prefix

字符串

网络前缀。

bgp_as

整数

BGP 路由器 AS 号,有效值范围为 1 到 4294967295。

branch_name

字符串

分支名称。

health_checks

列表 / 元素=字符串

底层运行状况检查。源 system.sdwan.health-check.name。

loopback_address_block

字符串

用于中心环回地址的 IPv4 地址和子网掩码,语法:X.X.X.X/24。

loopback_advertised_subnet

整数

环回通告的子网引用。源 system.fabric-vpn.advertised-subnets.id。

loopback_interface

字符串

环回接口。源 system.interface.name。

overlays

列表 / 元素=字典

本地覆盖接口表。

bgp_neighbor

字符串

底层 BGP 邻居条目。源 router.bgp.neighbor.ip。

bgp_neighbor_group

字符串

底层 BGP 邻居组条目。源 router.bgp.neighbor-group.name。

bgp_neighbor_range

整数

底层 BGP 邻居范围条目。源 router.bgp.neighbor-range.id。

bgp_network

整数

底层 BGP 网络。源 router.bgp.network.id。

interface

字符串

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

ipsec_phase1

字符串

IPsec 接口。源 vpn.ipsec.phase1-interface.name。

name

字符串 / 必需

覆盖名称。

overlay_policy

整数

允许 ADVPN 通过流量的覆盖策略。源 firewall.policy.policyid。

overlay_tunnel_block

字符串

用于覆盖隧道的 IPv4 地址和子网掩码,语法:X.X.X.X/24。

remote_gw

字符串

中心网关的 IP 地址(由中心设置)。

route_policy

整数

底层路由器策略。源 router.policy.seq-num。

sdwan_member

整数

引用 SD-WAN 成员条目。源 system.sdwan.members.seq-num。

policy_rule

字符串

策略创建规则。

选择

  • "health-check"

  • "manual"

  • "auto"

psksecret

字符串

用于 ADVPN 的预共享密钥。

sdwan_zone

字符串

引用创建的 SD-WAN 区域。源 system.sdwan.zone.name。

status

字符串

启用/禁用 Fabric VPN。

选择

  • "enable"

  • "disable"

sync_mode

字符串

设置由 Fabric 同步或手动同步。

选择

  • "enable"

  • "disable"

vpn_role

字符串

Fabric VPN 角色。

选择

  • "hub"

  • "spoke"

vdom

字符串

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

默认值: "root"

注释

注意

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

示例

- name: Setup for self orchestrated fabric auto discovery VPN.
  fortinet.fortios.fortios_system_fabric_vpn:
      vdom: "{{ vdom }}"
      system_fabric_vpn:
          advertised_subnets:
              -
                  access: "inbound"
                  bgp_network: "0"
                  firewall_address: "<your_own_value> (source firewall.address.name)"
                  id: "7"
                  policies: "<your_own_value> (source firewall.policy.policyid)"
                  prefix: "<your_own_value>"
          bgp_as: "0"
          branch_name: "<your_own_value>"
          health_checks: "<your_own_value> (source system.sdwan.health-check.name)"
          loopback_address_block: "<your_own_value>"
          loopback_advertised_subnet: "0"
          loopback_interface: "<your_own_value> (source system.interface.name)"
          overlays:
              -
                  bgp_neighbor: "<your_own_value> (source router.bgp.neighbor.ip)"
                  bgp_neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
                  bgp_neighbor_range: "0"
                  bgp_network: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  ipsec_phase1: "<your_own_value> (source vpn.ipsec.phase1-interface.name)"
                  name: "default_name_23"
                  overlay_policy: "0"
                  overlay_tunnel_block: "<your_own_value>"
                  remote_gw: "<your_own_value>"
                  route_policy: "0"
                  sdwan_member: "0"
          policy_rule: "health-check"
          psksecret: "<your_own_value>"
          sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
          status: "enable"
          sync_mode: "enable"
          vpn_role: "hub"

返回值

常见返回值记录在这里,以下是此模块特有的字段

描述

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)