fortinet.fortios.fortios_system_virtual_wan_link 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中使用 SD-WAN（以前称为虚拟 WAN 链路）配置冗余 Internet 连接。
注意
此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。
如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_virtual_wan_link。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改系统功能和 virtual_wan_link 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，需要在使用前调整为数据源。使用 FOS v6.0.0 测试。
要求
在执行此模块的主机上需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项
|
|
使用 SD-WAN（以前称为虚拟 WAN 链路）配置冗余 Internet 连接。 |
|
将发出警报的物理接口。 |
|
物理接口名称。源 system.interface.name。 |
|
启用/禁用 SD-WAN Internet 连接状态检查（故障检测）。 选项
|
|
SD-WAN 状态检查或运行状况检查。在 Internet 上识别服务器，并确定 SD-WAN 如何验证 FortiGate 是否可以与之通信。 |
|
地址模式（IPv4 或 IPv6）。 选项
|
|
探测数据包的 IP 标头中的差分服务代码点 (DSCP)。 |
|
服务器被认为丢失之前的失败次数 (1 - 3600)。 |
|
HA 选举优先级 (1 - 50)。 |
|
HTTP 标头的 http-agent 字段中的字符串。 |
|
如果协议为 HTTP，则用于与服务器通信的 URL。 |
|
如果协议为 HTTP，则期望从服务器返回的响应字符串。 |
|
状态检查间隔（以毫秒为单位），或尝试连接到服务器的时间间隔 (500 - 3600*1000 毫秒)。 |
|
成员序列号列表。 |
|
成员序列号。请参阅 <a href=’#notes’>注释</a>。源 system.virtual-wan-link.members.seq-num。 |
|
状态检查或运行状况检查名称。 |
|
twamp 测试会话的数据包大小。 |
|
身份验证模式下的 Twamp 控制器密码 |
|
用于通过所选协议与服务器通信的端口号。 |
|
启用/禁用探测数据包的传输。 选项
|
|
在探测数据包被视为丢失之前等待的时间 (500 - 5000 毫秒)。 |
|
用于确定 FortiGate 是否可以与服务器通信的协议。 选项
|
|
服务器被认为恢复之前的成功响应次数 (1 - 3600)。 |
|
Twamp 控制器安全模式。 选项
|
|
服务器的 IP 地址或 FQDN 名称。 |
|
服务级别协议 (SLA)。 |
|
SLA ID。请参阅 <a href=’#notes’>注释</a>。 |
|
SLA 进行决策的抖动（以毫秒为单位）。(0 - 10000000)。 |
|
SLA 进行决策的延迟（以毫秒为单位）。(0 - 10000000)。 |
|
用于选择链路的标准。 选项
|
|
SLA 进行决策的数据包丢失率（以百分比为单位）。(0 - 100)。 |
|
将生成 SLA 失败日志消息的时间间隔（以秒为单位）(0 - 3600)。 |
|
将生成 SLA 通过日志消息的时间间隔（以秒为单位）(0 - 3600)。 |
|
抖动的警报阈值 (ms)。 |
|
延迟的警报阈值 (ms)。 |
|
数据包丢失的警报阈值（百分比）。 |
|
抖动的警告阈值 (ms)。 |
|
延迟的警告阈值 (ms)。 |
|
数据包丢失的警告阈值（百分比）。 |
|
启用/禁用更新级联接口。 选项
|
|
启用/禁用更新静态路由。 选项
|
|
用于将 Internet 流量负载均衡到 SD-WAN 成员的算法或模式。 选项
|
|
添加到 virtual-wan-link 的 FortiGate 接口。 |
|
注释。 |
|
此接口在 SLA 模式下的服务成本 (0 - 4294967295)。 |
|
此接口的默认网关。通常是此接口连接到的 Internet 服务提供商的默认网关。 |
|
IPv6 网关。 |
|
此接口的入口溢出阈值（0 - 16776000 千比特/秒）。当达到此流量阈值时，新的会话将溢出到 SD-WAN 中的其他接口。 |
|
接口名称。源系统.接口.名称。 |
|
接口的优先级（0 - 4294967295）。用于 SD-WAN 规则或优先级规则。 |
|
序列号（1-255）。请参阅 <a href=’#notes’>备注</a>。 |
|
在发送到服务器的健康检查数据包中使用的源 IP 地址。 |
|
在发送到服务器的健康检查数据包中使用的源 IPv6 地址。 |
|
此接口的出口溢出阈值（0 - 16776000 千比特/秒）。当达到此流量阈值时，新的会话将溢出到 SD-WAN 中的其他接口。 |
|
在 SD-WAN 中启用/禁用此接口。 选项
|
|
测量的流量比率（此值 / 所有值的总和 = 链路流量的百分比，1 - 255）。 |
|
此接口用于加权负载平衡的权重。(1 - 255) 更多的流量将被定向到权重较高的接口。 |
|
从 BGP 邻居表创建 SD-WAN 邻居，以根据 SLA 状态控制路由通告。 |
|
SD-WAN 健康检查名称。源系统.虚拟广域网链路.健康检查.名称。 |
|
邻居的 IP 地址。源路由器.bgp.邻居.ip。 |
|
成员序列号。源系统.虚拟广域网链路.成员.序列号。 |
|
邻居的角色。 选项
|
|
SLA ID。 |
|
从邻居启动时，从主要邻居切换到次要邻居的等待时间（以秒为单位）。（0 - 10000000）。 |
|
启用/禁用从次要邻居切换回主要邻居的保持。 选项
|
|
当禁用保持时，从次要邻居切换到主要邻居的等待时间（以秒为单位）。（0 - 10000000）。 |
|
创建 SD-WAN 规则（也称为服务）以控制会话如何分配到 SD-WAN 中的接口。 |
|
地址模式（IPv4 或 IPv6）。 选项
|
|
自定义配置文件 1 公式中可用双向带宽倒数的系数。 |
|
启用/禁用将 SD-WAN 用作默认服务。 选项
|
|
启用/禁用转发流量 DSCP 标记。 选项
|
|
转发流量 DSCP 标记。 |
|
启用/禁用反向流量 DSCP 标记。 选项
|
|
反向流量 DSCP 标记。 |
|
目标地址名称。 |
|
地址或地址组名称。源防火墙.地址.名称 防火墙.地址组.名称。 |
|
目标地址6名称。 |
|
地址6或地址6组名称。源防火墙.地址6.名称 防火墙.地址组6.名称。 |
|
启用/禁用目标地址匹配的否定。 选项
|
|
目标结束端口号。 |
|
启用/禁用 SD-WAN 服务网关。 选项
|
|
用户组。 |
|
组名称。源用户.组.名称。 |
|
健康检查。源系统.虚拟广域网链路.健康检查.名称。 |
|
从备份成员切换到主要成员的等待时间（以秒为单位）。（0 - 10000000）。 |
|
优先级规则 ID（1 - 4000）。请参阅 <a href=’#notes’>备注</a>。 |
|
源接口名称。 |
|
接口名称。源系统.接口.名称。 |
|
启用/禁用输入设备匹配的否定。 选项
|
|
启用/禁用将 Internet 服务用于基于应用程序的负载平衡。 选项
|
|
基于应用程序控制的 Internet 服务 ID 列表。 |
|
基于应用程序控制的 Internet 服务 ID。请参阅 <a href=’#notes’>备注</a>。 |
|
基于应用程序控制的 Internet 服务组列表。 |
|
基于应用程序控制的 Internet 服务组名称。源应用程序.组.名称。 |
|
基于控制的 Internet 服务 ID 列表。 |
|
基于控制的 Internet 服务 ID。请参阅 <a href=’#notes’>备注</a>。 |
|
基于控制的 Internet 服务组列表。 |
|
基于控制的 Internet 服务组名称。源应用程序.组.名称。 |
|
自定义 Internet 服务名称列表。 |
|
自定义 Internet 服务名称。源防火墙.互联网-服务-自定义.名称。 |
|
自定义 Internet 服务组列表。 |
|
自定义 Internet 服务组名称。源防火墙.互联网-服务-自定义-组.名称。 |
|
Internet 服务组列表。 |
|
Internet 服务组名称。源防火墙.互联网-服务-组.名称。 |
|
Internet 服务 ID 列表。 |
|
Internet 服务 ID。请参阅 <a href=’#notes’>备注</a>。源防火墙.互联网-服务.id。 |
|
自定义配置文件 1 公式中抖动的系数。 |
|
自定义配置文件 1 公式中延迟的系数。 |
|
链路成本因子。 选项
|
|
链路成本值的百分比阈值变化，这将导致策略路由重新生成（0 - 10000000）。 |
|
成员序列号。源系统.虚拟广域网链路.成员.序列号。 |
|
控制优先级规则如何设置 SD-WAN 中接口的优先级。 选项
|
|
优先级规则名称。 |
|
自定义配置文件 1 公式中丢包的系数。 |
|
成员序列号列表。 |
|
成员序列号。请参阅 <a href=’#notes’>注释</a>。源 system.virtual-wan-link.members.seq-num。 |
|
协议号。 |
|
质量等级。 |
|
与邻居一起使用的服务角色。 选项
|
|
IPv4 路由映射路由标签。 |
|
服务级别协议 (SLA)。 |
|
虚拟广域网链路健康检查。源系统.虚拟广域网链路.健康检查.名称。 |
|
SLA ID。 |
|
在 sla 和负载平衡模式下比较 SLA 值的方法。 选项
|
|
源地址名称。 |
|
地址或地址组名称。源防火墙.地址.名称 防火墙.地址组.名称。 |
|
源地址6名称。 |
|
地址6或地址6组名称。源防火墙.地址6.名称 防火墙.地址组6.名称。 |
|
启用/禁用源地址匹配的否定。 选项
|
|
当选择的邻居角色为独立，而服务角色不是独立时，启用/禁用服务。 选项
|
|
目标起始端口号。 |
|
启用/禁用 SD-WAN 服务。 选项
|
|
服务类型位模式。 |
|
服务类型评估位。 |
|
用户名。 |
|
用户名。源用户.本地.名称。 |
|
启用/禁用 SD-WAN。 选项
|
|
配置 SD-WAN 区域。 |
|
区域名称。 |
|
虚拟域，在之前定义的那些中。虚拟域是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： |
备注
注意
传统的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式
示例
- name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
fortinet.fortios.fortios_system_virtual_wan_link:
vdom: "{{ vdom }}"
system_virtual_wan_link:
fail_alert_interfaces:
-
name: "default_name_4 (source system.interface.name)"
fail_detect: "enable"
health_check:
-
addr_mode: "ipv4"
diffservcode: "<your_own_value>"
failtime: "1800"
ha_priority: "25"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "1800000"
members:
-
seq_num: "<you_own_value>"
name: "default_name_17"
packet_size: "512"
password: "<your_own_value>"
port: "32767"
probe_packets: "disable"
probe_timeout: "2500"
protocol: "ping"
recoverytime: "1800"
security_mode: "none"
server: "192.168.100.40"
sla:
-
id: "28"
jitter_threshold: "5000000"
latency_threshold: "5000000"
link_cost_factor: "latency"
packetloss_threshold: "50"
sla_fail_log_period: "1800"
sla_pass_log_period: "1800"
threshold_alert_jitter: "2147483647"
threshold_alert_latency: "2147483647"
threshold_alert_packetloss: "50"
threshold_warning_jitter: "2147483647"
threshold_warning_latency: "2147483647"
threshold_warning_packetloss: "50"
update_cascade_interface: "enable"
update_static_route: "enable"
load_balance_mode: "source-ip-based"
members:
-
comment: "Comments."
cost: "2147483647"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress_spillover_threshold: "8388000"
interface: "<your_own_value> (source system.interface.name)"
priority: "2147483647"
seq_num: "<you_own_value>"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover_threshold: "8388000"
status: "disable"
volume_ratio: "127"
weight: "127"
neighbor:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
ip: "<your_own_value> (source router.bgp.neighbor.ip)"
member: "2147483647"
role: "standalone"
sla_id: "2147483647"
neighbor_hold_boot_time: "5000000"
neighbor_hold_down: "enable"
neighbor_hold_down_time: "5000000"
service:
-
addr_mode: "ipv4"
bandwidth_weight: "5000000"
default: "enable"
dscp_forward: "enable"
dscp_forward_tag: "<your_own_value>"
dscp_reverse: "enable"
dscp_reverse_tag: "<your_own_value>"
dst:
-
name: "default_name_77 (source firewall.address.name firewall.addrgrp.name)"
dst_negate: "enable"
dst6:
-
name: "default_name_80 (source firewall.address6.name firewall.addrgrp6.name)"
end_port: "32767"
gateway: "enable"
groups:
-
name: "default_name_84 (source user.group.name)"
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
hold_down_time: "5000000"
id: "87"
input_device:
-
name: "default_name_89 (source system.interface.name)"
input_device_negate: "enable"
internet_service: "enable"
internet_service_app_ctrl:
-
id: "93"
internet_service_app_ctrl_group:
-
name: "default_name_95 (source application.group.name)"
internet_service_ctrl:
-
id: "97"
internet_service_ctrl_group:
-
name: "default_name_99 (source application.group.name)"
internet_service_custom:
-
name: "default_name_101 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_103 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_105 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "107 (source firewall.internet-service.id)"
jitter_weight: "5000000"
latency_weight: "5000000"
link_cost_factor: "latency"
link_cost_threshold: "5000000"
member: "2147483647"
mode: "auto"
name: "default_name_114"
packet_loss_weight: "5000000"
priority_members:
-
seq_num: "<you_own_value>"
protocol: "127"
quality_link: "127"
role: "standalone"
route_tag: "2147483647"
sla:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
id: "124"
sla_compare_method: "order"
src:
-
name: "default_name_127 (source firewall.address.name firewall.addrgrp.name)"
src_negate: "enable"
src6:
-
name: "default_name_130 (source firewall.address6.name firewall.addrgrp6.name)"
standalone_action: "enable"
start_port: "32767"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
users:
-
name: "default_name_137 (source user.local.name)"
status: "disable"
zone:
-
name: "default_name_140"
返回值
常见返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
Fortigate 镜像的构建号 已返回： 始终 示例： |
|
上次用于将内容配置到 FortiGate 中的方法 已返回： 始终 示例： |
|
上次应用的操作中 FortiGate 给出的最后一个结果 已返回： 始终 示例： |
|
上次调用 FortiGate 时使用的主键（ID） 已返回： 成功 示例： |
|
用于满足请求的表的名称 已返回： 始终 示例： |
|
用于满足请求的表的路径 已返回： 始终 示例： |
|
内部修订号 已返回： 始终 示例： |
|
设备的序列号 已返回： 始终 示例： |
|
指示操作结果 已返回： 始终 示例： |
|
使用的虚拟域 已返回： 始终 示例： |
|
FortiGate 的版本 已返回： 始终 示例： |