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
参数
参数 |
注释 |
---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选择
|
|
要操作的成员属性路径。 如果存在多个属性,则用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时,将忽略 state 选项。 选择
|
|
设置用于自编排的 Fabric 自动发现 VPN。 |
|
本地通告的子网。 |
|
访问策略方向。 选择
|
|
底层 BGP 网络。源 router.bgp.network.id。 |
|
底层防火墙地址。源 firewall.address.name。 |
|
ID。请参阅 <a href=’#notes’>注释</a>。 |
|
底层策略。源 firewall.policy.policyid。 |
|
网络前缀。 |
|
BGP 路由器 AS 号,有效值范围为 1 到 4294967295。 |
|
分支名称。 |
|
底层运行状况检查。源 system.sdwan.health-check.name。 |
|
用于中心环回地址的 IPv4 地址和子网掩码,语法:X.X.X.X/24。 |
|
环回通告的子网引用。源 system.fabric-vpn.advertised-subnets.id。 |
|
环回接口。源 system.interface.name。 |
|
本地覆盖接口表。 |
|
底层 BGP 邻居条目。源 router.bgp.neighbor.ip。 |
|
底层 BGP 邻居组条目。源 router.bgp.neighbor-group.name。 |
|
底层 BGP 邻居范围条目。源 router.bgp.neighbor-range.id。 |
|
底层 BGP 网络。源 router.bgp.network.id。 |
|
底层接口名称。源 system.interface.name。 |
|
IPsec 接口。源 vpn.ipsec.phase1-interface.name。 |
|
覆盖名称。 |
|
允许 ADVPN 通过流量的覆盖策略。源 firewall.policy.policyid。 |
|
用于覆盖隧道的 IPv4 地址和子网掩码,语法:X.X.X.X/24。 |
|
中心网关的 IP 地址(由中心设置)。 |
|
底层路由器策略。源 router.policy.seq-num。 |
|
引用 SD-WAN 成员条目。源 system.sdwan.members.seq-num。 |
|
策略创建规则。 选择
|
|
用于 ADVPN 的预共享密钥。 |
|
引用创建的 SD-WAN 区域。源 system.sdwan.zone.name。 |
|
启用/禁用 Fabric VPN。 选择
|
|
设置由 Fabric 同步或手动同步。 选择
|
|
Fabric VPN 角色。 选择
|
|
虚拟域,在之前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置为不同的单元并使用。 默认值: |
注释
注意
旧版 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"
返回值
常见返回值记录在这里,以下是此模块特有的字段
键 |
描述 |
---|---|
FortiGate 镜像的构建版本号 返回值: 总是 示例: |
|
上次用于将内容配置到 FortiGate 的方法 返回值: 总是 示例: |
|
上次操作在 FortiGate 上给出的最后结果 返回值: 总是 示例: |
|
上次调用 FortiGate 时使用的主键 (id) 返回值: 成功 示例: |
|
用于满足请求的表名称 返回值: 总是 示例: |
|
用于满足请求的表的路径 返回值: 总是 示例: |
|
内部修订版本号 返回值: 总是 示例: |
|
设备的序列号 返回值: 总是 示例: |
|
指示操作结果 返回值: 总是 示例: |
|
使用的虚拟域 返回值: 总是 示例: |
|
FortiGate 的版本 返回值: 总是 示例: |