config system sdwan
Configure redundant Internet connections with multiple outbound links and health-check profiles.
config system sdwan
Description: Configure redundant Internet connections with multiple outbound links and health-check profiles.
set status [disable|enable]
set load-balance-mode [source-ip-based|weight-based|...]
set duplication-max-num {integer}
set neighbor-hold-down [enable|disable]
set neighbor-hold-down-time {integer}
set neighbor-hold-boot-time {integer}
set fail-detect [enable|disable]
set fail-alert-interfaces <name1>, <name2>, ...
config zone
Description: Configure SD-WAN zones.
edit <name>
set service-sla-tie-break [cfg-order|fib-best-match]
next
end
config members
Description: FortiGate interfaces added to the SD-WAN.
edit <seq-num>
set interface {string}
set zone {string}
set gateway {ipv4-address}
set source {ipv4-address}
set gateway6 {ipv6-address}
set source6 {ipv6-address}
set cost {integer}
set weight {integer}
set priority {integer}
set spillover-threshold {integer}
set ingress-spillover-threshold {integer}
set volume-ratio {integer}
set status [disable|enable]
set comment {var-string}
next
end
config health-check
Description: SD-WAN status checking or health checking. Identify a server on the Internet and determine how SD-WAN verifies that the FortiGate can communicate with it.
edit <name>
set probe-packets [disable|enable]
set addr-mode [ipv4|ipv6]
set system-dns [disable|enable]
set server {string}
set protocol [ping|tcp-echo|...]
set port {integer}
set quality-measured-method [half-open|half-close]
set security-mode [none|authentication]
set user {string}
set password {password}
set packet-size {integer}
set ha-priority {integer}
set ftp-mode [passive|port]
set ftp-file {string}
set http-get {string}
set http-agent {string}
set http-match {string}
set dns-request-domain {string}
set dns-match-ip {ipv4-address}
set interval {integer}
set probe-timeout {integer}
set failtime {integer}
set recoverytime {integer}
set probe-count {integer}
set diffservcode {user}
set update-cascade-interface [enable|disable]
set update-static-route [enable|disable]
set sla-fail-log-period {integer}
set sla-pass-log-period {integer}
set threshold-warning-packetloss {integer}
set threshold-alert-packetloss {integer}
set threshold-warning-latency {integer}
set threshold-alert-latency {integer}
set threshold-warning-jitter {integer}
set threshold-alert-jitter {integer}
set members <seq-num1>, <seq-num2>, ...
config sla
Description: Service level agreement (SLA).
edit <id>
set link-cost-factor {option1}, {option2}, ...
set latency-threshold {integer}
set jitter-threshold {integer}
set packetloss-threshold {integer}
next
end
next
end
config neighbor
Description: Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status.
edit <ip>
set member {integer}
set role [standalone|primary|...]
set health-check {string}
set sla-id {integer}
next
end
config service
Description: Create SD-WAN rules (also called services) to control how sessions are distributed to interfaces in the SD-WAN.
edit <id>
set name {string}
set addr-mode [ipv4|ipv6]
set input-device <name1>, <name2>, ...
set input-device-negate [enable|disable]
set mode [auto|manual|...]
set minimum-sla-meet-members {integer}
set hash-mode [round-robin|source-ip-based|...]
set role [standalone|primary|...]
set standalone-action [enable|disable]
set quality-link {integer}
set tos {user}
set tos-mask {user}
set protocol {integer}
set start-port {integer}
set end-port {integer}
set route-tag {integer}
set dst <name1>, <name2>, ...
set dst-negate [enable|disable]
set src <name1>, <name2>, ...
set dst6 <name1>, <name2>, ...
set src6 <name1>, <name2>, ...
set src-negate [enable|disable]
set users <name1>, <name2>, ...
set groups <name1>, <name2>, ...
set internet-service [enable|disable]
set internet-service-custom <name1>, <name2>, ...
set internet-service-custom-group <name1>, <name2>, ...
set internet-service-name <name1>, <name2>, ...
set internet-service-group <name1>, <name2>, ...
set internet-service-app-ctrl <id1>, <id2>, ...
set internet-service-app-ctrl-group <name1>, <name2>, ...
set health-check <name1>, <name2>, ...
set link-cost-factor [latency|jitter|...]
set packet-loss-weight {integer}
set latency-weight {integer}
set jitter-weight {integer}
set bandwidth-weight {integer}
set link-cost-threshold {integer}
set hold-down-time {integer}
set dscp-forward [enable|disable]
set dscp-reverse [enable|disable]
set dscp-forward-tag {user}
set dscp-reverse-tag {user}
config sla
Description: Service level agreement (SLA).
edit <health-check>
set id {integer}
next
end
set priority-members <seq-num1>, <seq-num2>, ...
set status [enable|disable]
set gateway [enable|disable]
set default [enable|disable]
set sla-compare-method [order|number]
set tie-break [zone|cfg-order|...]
set use-shortcut-sla [enable|disable]
next
end
config duplication
Description: Create SD-WAN duplication rule.
edit <id>
set service-id <id1>, <id2>, ...
set srcaddr <name1>, <name2>, ...
set dstaddr <name1>, <name2>, ...
set srcaddr6 <name1>, <name2>, ...
set dstaddr6 <name1>, <name2>, ...
set srcintf <name1>, <name2>, ...
set dstintf <name1>, <name2>, ...
set service <name1>, <name2>, ...
set packet-duplication [disable|force|...]
set packet-de-duplication [enable|disable]
next
end
end
config system sdwan
Parameter |
Description |
Type |
Size |
Default |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status |
Enable/disable SD-WAN. |
option |
- |
disable |
||||||||||||
|
|
|||||||||||||||
load-balance-mode |
Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. |
option |
- |
source-ip-based |
||||||||||||
|
|
|||||||||||||||
duplication-max-num |
Maximum number of interface members a packet is duplicated in the SD-WAN zone . |
integer |
Minimum value: 2 Maximum value: 4 |
2 |
||||||||||||
neighbor-hold-down |
Enable/disable hold switching from the secondary neighbor to the primary neighbor. |
option |
- |
disable |
||||||||||||
|
|
|||||||||||||||
neighbor-hold-down-time |
Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. . |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||
neighbor-hold-boot-time |
Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. . |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||
fail-detect |
Enable/disable SD-WAN Internet connection status checking (failure detection). |
option |
- |
disable |
||||||||||||
|
|
|||||||||||||||
fail-alert-interfaces |
Physical interfaces that will be alerted. Physical interface name. |
string |
Maximum length: 79 |
|
config zone
Parameter |
Description |
Type |
Size |
Default |
||||||
---|---|---|---|---|---|---|---|---|---|---|
service-sla-tie-break |
Method of selecting member if more than one meets the SLA. |
option |
- |
cfg-order |
||||||
|
|
config members
Parameter |
Description |
Type |
Size |
Default |
||||||
---|---|---|---|---|---|---|---|---|---|---|
interface |
Interface name. |
string |
Maximum length: 15 |
|
||||||
zone |
Zone name. |
string |
Maximum length: 35 |
virtual-wan-link |
||||||
gateway |
The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is connected to. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||
source |
Source IP address used in the health-check packet to the server. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||
gateway6 |
IPv6 gateway. |
ipv6-address |
Not Specified |
:: |
||||||
source6 |
Source IPv6 address used in the health-check packet to the server. |
ipv6-address |
Not Specified |
:: |
||||||
cost |
Cost of this interface for services in SLA mode . |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||
weight |
Weight of this interface for weighted load balancing. More traffic is directed to interfaces with higher weights. |
integer |
Minimum value: 1 Maximum value: 255 |
1 |
||||||
priority |
Priority of the interface . Used for SD-WAN rules or priority rules. |
integer |
Minimum value: 0 Maximum value: 65535 |
0 |
||||||
spillover-threshold |
Egress spillover threshold for this interface . When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. |
integer |
Minimum value: 0 Maximum value: 16776000 |
0 |
||||||
ingress-spillover-threshold |
Ingress spillover threshold for this interface . When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN. |
integer |
Minimum value: 0 Maximum value: 16776000 |
0 |
||||||
volume-ratio |
Measured volume ratio . |
integer |
Minimum value: 1 Maximum value: 255 |
1 |
||||||
status |
Enable/disable this interface in the SD-WAN. |
option |
- |
enable |
||||||
|
|
|||||||||
comment |
Comments. |
var-string |
Maximum length: 255 |
|
config health-check
Parameter |
Description |
Type |
Size |
Default |
||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
probe-packets |
Enable/disable transmission of probe packets. |
option |
- |
enable |
||||||||||||||||||
|
|
|||||||||||||||||||||
addr-mode |
Address mode (IPv4 or IPv6). |
option |
- |
ipv4 |
||||||||||||||||||
|
|
|||||||||||||||||||||
system-dns |
Enable/disable system DNS as the probe server. |
option |
- |
disable |
||||||||||||||||||
|
|
|||||||||||||||||||||
server |
IP address or FQDN name of the server. |
string |
Maximum length: 79 |
|
||||||||||||||||||
protocol |
Protocol used to determine if the FortiGate can communicate with the server. |
option |
- |
ping |
||||||||||||||||||
|
|
|||||||||||||||||||||
port |
Port number used to communicate with the server over the selected protocol . |
integer |
Minimum value: 0 Maximum value: 65535 |
0 |
||||||||||||||||||
quality-measured-method |
Method to measure the quality of tcp-connect. |
option |
- |
half-open |
||||||||||||||||||
|
|
|||||||||||||||||||||
security-mode |
Twamp controller security mode. |
option |
- |
none |
||||||||||||||||||
|
|
|||||||||||||||||||||
user |
The user name to access probe server. |
string |
Maximum length: 64 |
|
||||||||||||||||||
password |
Twamp controller password in authentication mode |
password |
Not Specified |
|
||||||||||||||||||
packet-size |
Packet size of a twamp test session, |
integer |
Minimum value: 64 Maximum value: 1024 |
64 |
||||||||||||||||||
ha-priority |
HA election priority . |
integer |
Minimum value: 1 Maximum value: 50 |
1 |
||||||||||||||||||
ftp-mode |
FTP mode. |
option |
- |
passive |
||||||||||||||||||
|
|
|||||||||||||||||||||
ftp-file |
Full path and file name on the FTP server to download for FTP health-check to probe. |
string |
Maximum length: 254 |
|
||||||||||||||||||
http-get |
URL used to communicate with the server if the protocol if the protocol is HTTP. |
string |
Maximum length: 1024 |
/ |
||||||||||||||||||
http-agent |
String in the http-agent field in the HTTP header. |
string |
Maximum length: 1024 |
Chrome/ Safari/ |
||||||||||||||||||
http-match |
Response string expected from the server if the protocol is HTTP. |
string |
Maximum length: 1024 |
|
||||||||||||||||||
dns-request-domain |
Fully qualified domain name to resolve for the DNS probe. |
string |
Maximum length: 255 |
www.example.com |
||||||||||||||||||
dns-match-ip |
Response IP expected from DNS server if the protocol is DNS. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||||||||||||
interval |
Status check interval in milliseconds, or the time between attempting to connect to the server . |
integer |
Minimum value: 500 Maximum value: 3600000 |
500 |
||||||||||||||||||
probe-timeout |
Time to wait before a probe packet is considered lost . |
integer |
Minimum value: 500 Maximum value: 3600000 |
500 |
||||||||||||||||||
failtime |
Number of failures before server is considered lost . |
integer |
Minimum value: 1 Maximum value: 3600 |
5 |
||||||||||||||||||
recoverytime |
Number of successful responses received before server is considered recovered . |
integer |
Minimum value: 1 Maximum value: 3600 |
5 |
||||||||||||||||||
probe-count |
Number of most recent probes that should be used to calculate latency and jitter . |
integer |
Minimum value: 5 Maximum value: 30 |
30 |
||||||||||||||||||
diffservcode |
Differentiated services code point (DSCP) in the IP header of the probe packet. |
user |
Not Specified |
|
||||||||||||||||||
update-cascade-interface |
Enable/disable update cascade interface. |
option |
- |
enable |
||||||||||||||||||
|
|
|||||||||||||||||||||
update-static-route |
Enable/disable updating the static route. |
option |
- |
enable |
||||||||||||||||||
|
|
|||||||||||||||||||||
sla-fail-log-period |
Time interval in seconds that SLA fail log messages will be generated . |
integer |
Minimum value: 0 Maximum value: 3600 |
0 |
||||||||||||||||||
sla-pass-log-period |
Time interval in seconds that SLA pass log messages will be generated . |
integer |
Minimum value: 0 Maximum value: 3600 |
0 |
||||||||||||||||||
threshold-warning-packetloss |
Warning threshold for packet loss . |
integer |
Minimum value: 0 Maximum value: 100 |
0 |
||||||||||||||||||
threshold-alert-packetloss |
Alert threshold for packet loss . |
integer |
Minimum value: 0 Maximum value: 100 |
0 |
||||||||||||||||||
threshold-warning-latency |
Warning threshold for latency . |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||
threshold-alert-latency |
Alert threshold for latency . |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||
threshold-warning-jitter |
Warning threshold for jitter . |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||
threshold-alert-jitter |
Alert threshold for jitter . |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||||
members |
Member sequence number list. Member sequence number. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
|
config sla
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
id |
SLA ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
config neighbor
Parameter |
Description |
Type |
Size |
Default |
||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
member |
Member sequence number. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||
role |
Role of neighbor. |
option |
- |
standalone |
||||||||
|
|
|||||||||||
health-check |
SD-WAN health-check name. |
string |
Maximum length: 35 |
|
||||||||
sla-id |
SLA ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
config service
Parameter |
Description |
Type |
Size |
Default |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
SD-WAN rule name. |
string |
Maximum length: 35 |
|
||||||||||||||||
addr-mode |
Address mode (IPv4 or IPv6). |
option |
- |
ipv4 |
||||||||||||||||
|
|
|||||||||||||||||||
input-device |
Source interface name. Interface name. |
string |
Maximum length: 79 |
|
||||||||||||||||
input-device-negate |
Enable/disable negation of input device match. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
mode |
Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN. |
option |
- |
manual |
||||||||||||||||
|
|
|||||||||||||||||||
minimum-sla-meet-members |
Minimum number of members which meet SLA. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||
hash-mode |
Hash algorithm for selected priority members for load balance mode. |
option |
- |
round-robin |
||||||||||||||||
|
|
|||||||||||||||||||
role |
Service role to work with neighbor. |
option |
- |
standalone |
||||||||||||||||
|
|
|||||||||||||||||||
standalone-action |
Enable/disable service when selected neighbor role is standalone while service role is not standalone. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
quality-link |
Quality grade. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||
tos |
Type of service bit pattern. |
user |
Not Specified |
|
||||||||||||||||
tos-mask |
Type of service evaluated bits. |
user |
Not Specified |
|
||||||||||||||||
protocol |
Protocol number. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||||||||
start-port |
Start destination port number. |
integer |
Minimum value: 0 Maximum value: 65535 |
1 |
||||||||||||||||
end-port |
End destination port number. |
integer |
Minimum value: 0 Maximum value: 65535 |
65535 |
||||||||||||||||
route-tag |
IPv4 route map route-tag. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||||||||
dst |
Destination address name. Address or address group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
dst-negate |
Enable/disable negation of destination address match. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
src |
Source address name. Address or address group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
dst6 |
Destination address6 name. Address6 or address6 group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
src6 |
Source address6 name. Address6 or address6 group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
src-negate |
Enable/disable negation of source address match. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
users |
User name. User name. |
string |
Maximum length: 79 |
|
||||||||||||||||
groups |
User groups. Group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
internet-service |
Enable/disable use of Internet service for application-based load balancing. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
internet-service-custom |
Custom Internet service name list. Custom Internet service name. |
string |
Maximum length: 79 |
|
||||||||||||||||
internet-service-custom-group |
Custom Internet Service group list. Custom Internet Service group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
internet-service-name |
Internet service name list. Internet service name. |
string |
Maximum length: 79 |
|
||||||||||||||||
internet-service-group |
Internet Service group list. Internet Service group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
internet-service-app-ctrl |
Application control based Internet Service ID list. Application control based Internet Service ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
|
||||||||||||||||
internet-service-app-ctrl-group |
Application control based Internet Service group list. Application control based Internet Service group name. |
string |
Maximum length: 79 |
|
||||||||||||||||
health-check |
Health check list. Health check name. |
string |
Maximum length: 79 |
|
||||||||||||||||
link-cost-factor |
Link cost factor. |
option |
- |
latency |
||||||||||||||||
|
|
|||||||||||||||||||
packet-loss-weight |
Coefficient of packet-loss in the formula of custom-profile-1. |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||||||
latency-weight |
Coefficient of latency in the formula of custom-profile-1. |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||||||
jitter-weight |
Coefficient of jitter in the formula of custom-profile-1. |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||||||
bandwidth-weight |
Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||||||
link-cost-threshold |
Percentage threshold change of link cost values that will result in policy route regeneration . |
integer |
Minimum value: 0 Maximum value: 10000000 |
10 |
||||||||||||||||
hold-down-time |
Waiting period in seconds when switching from the back-up member to the primary member . |
integer |
Minimum value: 0 Maximum value: 10000000 |
0 |
||||||||||||||||
dscp-forward |
Enable/disable forward traffic DSCP tag. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
dscp-reverse |
Enable/disable reverse traffic DSCP tag. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
dscp-forward-tag |
Forward traffic DSCP tag. |
user |
Not Specified |
|
||||||||||||||||
dscp-reverse-tag |
Reverse traffic DSCP tag. |
user |
Not Specified |
|
||||||||||||||||
priority-members |
Member sequence number list. Member sequence number. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
|
||||||||||||||||
status |
Enable/disable SD-WAN service. |
option |
- |
enable |
||||||||||||||||
|
|
|||||||||||||||||||
gateway |
Enable/disable SD-WAN service gateway. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
default |
Enable/disable use of SD-WAN as default service. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
sla-compare-method |
Method to compare SLA value for SLA mode. |
option |
- |
order |
||||||||||||||||
|
|
|||||||||||||||||||
tie-break |
Method of selecting member if more than one meets the SLA. |
option |
- |
zone |
||||||||||||||||
|
|
|||||||||||||||||||
use-shortcut-sla |
Enable/disable use of ADVPN shortcut for quality comparison. |
option |
- |
enable |
||||||||||||||||
|
|
config sla
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
id |
SLA ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
config duplication
Parameter |
Description |
Type |
Size |
Default |
||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
service-id |
SD-WAN service rule ID list. SD-WAN service rule ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
|
||||||||
srcaddr |
Source address or address group names. Address or address group name. |
string |
Maximum length: 79 |
|
||||||||
dstaddr |
Destination address or address group names. Address or address group name. |
string |
Maximum length: 79 |
|
||||||||
srcaddr6 |
Source address6 or address6 group names. Address6 or address6 group name. |
string |
Maximum length: 79 |
|
||||||||
dstaddr6 |
Destination address6 or address6 group names. Address6 or address6 group name. |
string |
Maximum length: 79 |
|
||||||||
srcintf |
Incoming (ingress) interfaces or zones. Interface, zone or SDWAN zone name. |
string |
Maximum length: 79 |
|
||||||||
dstintf |
Outgoing (egress) interfaces or zones. Interface, zone or SDWAN zone name. |
string |
Maximum length: 79 |
|
||||||||
service |
Service and service group name. Service and service group name. |
string |
Maximum length: 79 |
|
||||||||
packet-duplication |
Configure packet duplication method. |
option |
- |
disable |
||||||||
|
|
|||||||||||
packet-de-duplication |
Enable/disable discarding of packets that have been duplicated. |
option |
- |
disable |
||||||||
|
|