You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_system_virtual_wan_link module – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.1.6).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_system_virtual_wan_link.

New in version 2.0.0: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis 

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and virtual_wan_link category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements 

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

Parameters 

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
system_virtual_wan_link dictionary	Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
fail_alert_interfaces list / elements=dictionary	Physical interfaces that will be alerted.
name string / required	Physical interface name. Source system.interface.name.
fail_detect string	Enable/disable SD-WAN Internet connection status checking (failure detection). Choices: enable disable
health_check list / elements=dictionary	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.
addr_mode string	Address mode (IPv4 or IPv6). Choices: ipv4 ipv6
diffservcode string	Differentiated services code point (DSCP) in the IP header of the probe packet.
failtime integer	Number of failures before server is considered lost (1 - 3600).
ha_priority integer	HA election priority (1 - 50).
http_agent string	String in the http-agent field in the HTTP header.
http_get string	URL used to communicate with the server if the protocol if the protocol is HTTP.
http_match string	Response string expected from the server if the protocol is HTTP.
interval integer	Status check interval in milliseconds, or the time between attempting to connect to the server (500 - 3600*1000 msec).
members list / elements=dictionary	Member sequence number list.
seq_num integer	Member sequence number. Source system.virtual-wan-link.members.seq-num.
name string / required	Status check or health check name.
packet_size integer	Packet size of a twamp test session,
password string	Twamp controller password in authentication mode
port integer	Port number used to communicate with the server over the selected protocol.
probe_packets string	Enable/disable transmission of probe packets. Choices: disable enable
probe_timeout integer	Time to wait before a probe packet is considered lost (500 - 5000 msec).
protocol string	Protocol used to determine if the FortiGate can communicate with the server. Choices: ping tcp-echo udp-echo http twamp ping6
recoverytime integer	Number of successful responses received before server is considered recovered (1 - 3600).
security_mode string	Twamp controller security mode. Choices: none authentication
server string	IP address or FQDN name of the server.
sla list / elements=dictionary	Service level agreement (SLA).
id integer / required	SLA ID.
jitter_threshold integer	Jitter for SLA to make decision in milliseconds. (0 - 10000000).
latency_threshold integer	Latency for SLA to make decision in milliseconds. (0 - 10000000).
link_cost_factor string	Criteria on which to base link selection. Choices: latency jitter packet-loss
packetloss_threshold integer	Packet loss for SLA to make decision in percentage. (0 - 100).
sla_fail_log_period integer	Time interval in seconds that SLA fail log messages will be generated (0 - 3600).
sla_pass_log_period integer	Time interval in seconds that SLA pass log messages will be generated (0 - 3600).
threshold_alert_jitter integer	Alert threshold for jitter (ms).
threshold_alert_latency integer	Alert threshold for latency (ms).
threshold_alert_packetloss integer	Alert threshold for packet loss (percentage).
threshold_warning_jitter integer	Warning threshold for jitter (ms).
threshold_warning_latency integer	Warning threshold for latency (ms).
threshold_warning_packetloss integer	Warning threshold for packet loss (percentage).
update_cascade_interface string	Enable/disable update cascade interface. Choices: enable disable
update_static_route string	Enable/disable updating the static route. Choices: enable disable
load_balance_mode string	Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. Choices: source-ip-based weight-based usage-based source-dest-ip-based measured-volume-based
members list / elements=dictionary	FortiGate interfaces added to the virtual-wan-link.
comment string	Comments.
cost integer	Cost of this interface for services in SLA mode (0 - 4294967295).
gateway string	The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is connected to.
gateway6 string	IPv6 gateway.
ingress_spillover_threshold integer	Ingress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN.
interface string	Interface name. Source system.interface.name.
priority integer	Priority of the interface (0 - 4294967295). Used for SD-WAN rules or priority rules.
seq_num integer	Sequence number(1-255).
source string	Source IP address used in the health-check packet to the server.
source6 string	Source IPv6 address used in the health-check packet to the server.
spillover_threshold integer	Egress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessions spill over to other interfaces in the SD-WAN.
status string	Enable/disable this interface in the SD-WAN. Choices: disable enable
volume_ratio integer	Measured volume ratio (this value / sum of all values = percentage of link volume, 1 - 255).
weight integer	Weight of this interface for weighted load balancing. (1 - 255) More traffic is directed to interfaces with higher weights.
neighbor list / elements=dictionary	Create SD-WAN neighbor from BGP neighbor table to control route advertisements according to SLA status.
health_check string	SD-WAN health-check name. Source system.virtual-wan-link.health-check.name.
ip string / required	IP address of neighbor. Source router.bgp.neighbor.ip.
member integer	Member sequence number. Source system.virtual-wan-link.members.seq-num.
role string	Role of neighbor. Choices: standalone primary secondary
sla_id integer	SLA ID.
neighbor_hold_boot_time integer	Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. (0 - 10000000).
neighbor_hold_down string	Enable/disable hold switching from the secondary neighbor to the primary neighbor. Choices: enable disable
neighbor_hold_down_time integer	Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. (0 - 10000000).
service list / elements=dictionary	Create SD-WAN rules (also called services) to control how sessions are distributed to interfaces in the SD-WAN.
addr_mode string	Address mode (IPv4 or IPv6). Choices: ipv4 ipv6
bandwidth_weight integer	Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1.
default string	Enable/disable use of SD-WAN as default service. Choices: enable disable
dscp_forward string	Enable/disable forward traffic DSCP tag. Choices: enable disable
dscp_forward_tag string	Forward traffic DSCP tag.
dscp_reverse string	Enable/disable reverse traffic DSCP tag. Choices: enable disable
dscp_reverse_tag string	Reverse traffic DSCP tag.
dst list / elements=dictionary	Destination address name.
name string / required	Address or address group name. Source firewall.address.name firewall.addrgrp.name.
dst6 list / elements=dictionary	Destination address6 name.
name string / required	Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name.
dst_negate string	Enable/disable negation of destination address match. Choices: enable disable
end_port integer	End destination port number.
gateway string	Enable/disable SD-WAN service gateway. Choices: enable disable
groups list / elements=dictionary	User groups.
name string / required	Group name. Source user.group.name.
health_check string	Health check. Source system.virtual-wan-link.health-check.name.
hold_down_time integer	Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000).
id integer / required	Priority rule ID (1 - 4000).
input_device list / elements=dictionary	Source interface name.
name string / required	Interface name. Source system.interface.name.
input_device_negate string	Enable/disable negation of input device match. Choices: enable disable
internet_service string	Enable/disable use of Internet service for application-based load balancing. Choices: enable disable
internet_service_app_ctrl list / elements=dictionary	Application control based Internet Service ID list.
id integer / required	Application control based Internet Service ID.
internet_service_app_ctrl_group list / elements=dictionary	Application control based Internet Service group list.
name string / required	Application control based Internet Service group name. Source application.group.name.
internet_service_ctrl list / elements=dictionary	Control-based Internet Service ID list.
id integer / required	Control-based Internet Service ID.
internet_service_ctrl_group list / elements=dictionary	Control-based Internet Service group list.
name string / required	Control-based Internet Service group name. Source application.group.name.
internet_service_custom list / elements=dictionary	Custom Internet service name list.
name string / required	Custom Internet service name. Source firewall.internet-service-custom.name.
internet_service_custom_group list / elements=dictionary	Custom Internet Service group list.
name string / required	Custom Internet Service group name. Source firewall.internet-service-custom-group.name.
internet_service_group list / elements=dictionary	Internet Service group list.
name string / required	Internet Service group name. Source firewall.internet-service-group.name.
internet_service_id list / elements=dictionary	Internet service ID list.
id integer / required	Internet service ID. Source firewall.internet-service.id.
jitter_weight integer	Coefficient of jitter in the formula of custom-profile-1.
latency_weight integer	Coefficient of latency in the formula of custom-profile-1.
link_cost_factor string	Link cost factor. Choices: latency jitter packet-loss inbandwidth outbandwidth bibandwidth custom-profile-1
link_cost_threshold integer	Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000).
member integer	Member sequence number. Source system.virtual-wan-link.members.seq-num.
mode string	Control how the priority rule sets the priority of interfaces in the SD-WAN. Choices: auto manual priority sla load-balance
name string	Priority rule name.
packet_loss_weight integer	Coefficient of packet-loss in the formula of custom-profile-1.
priority_members list / elements=dictionary	Member sequence number list.
seq_num integer	Member sequence number. Source system.virtual-wan-link.members.seq-num.
protocol integer	Protocol number.
quality_link integer	Quality grade.
role string	Service role to work with neighbor. Choices: standalone primary secondary
route_tag integer	IPv4 route map route-tag.
sla list / elements=dictionary	Service level agreement (SLA).
health_check string	Virtual WAN Link health-check. Source system.virtual-wan-link.health-check.name.
id integer	SLA ID.
sla_compare_method string	Method to compare SLA value for sla and load balance mode. Choices: order number
src list / elements=dictionary	Source address name.
name string / required	Address or address group name. Source firewall.address.name firewall.addrgrp.name.
src6 list / elements=dictionary	Source address6 name.
name string / required	Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name.
src_negate string	Enable/disable negation of source address match. Choices: enable disable
standalone_action string	Enable/disable service when selected neighbor role is standalone while service role is not standalone. Choices: enable disable
start_port integer	Start destination port number.
status string	Enable/disable SD-WAN service. Choices: enable disable
tos string	Type of service bit pattern.
tos_mask string	Type of service evaluated bits.
users list / elements=dictionary	User name.
name string / required	User name. Source user.local.name.
status string	Enable/disable SD-WAN. Choices: disable enable
zone list / elements=dictionary	Configure SD-WAN zones.
name string / required	Zone name.
vdom string	Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: “root”

Notes 

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples 

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
    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: "9"
            ha_priority: "10"
            http_agent: "<your_own_value>"
            http_get: "<your_own_value>"
            http_match: "<your_own_value>"
            interval: "14"
            members:
             -
                seq_num: "16 (source system.virtual-wan-link.members.seq-num)"
            name: "default_name_17"
            packet_size: "18"
            password: "<your_own_value>"
            port: "20"
            probe_packets: "disable"
            probe_timeout: "22"
            protocol: "ping"
            recoverytime: "24"
            security_mode: "none"
            server: "192.168.100.40"
            sla:
             -
                id:  "28"
                jitter_threshold: "29"
                latency_threshold: "30"
                link_cost_factor: "latency"
                packetloss_threshold: "32"
            sla_fail_log_period: "33"
            sla_pass_log_period: "34"
            threshold_alert_jitter: "35"
            threshold_alert_latency: "36"
            threshold_alert_packetloss: "37"
            threshold_warning_jitter: "38"
            threshold_warning_latency: "39"
            threshold_warning_packetloss: "40"
            update_cascade_interface: "enable"
            update_static_route: "enable"
        load_balance_mode: "source-ip-based"
        members:
         -
            comment: "Comments."
            cost: "46"
            gateway: "<your_own_value>"
            gateway6: "<your_own_value>"
            ingress_spillover_threshold: "49"
            interface: "<your_own_value> (source system.interface.name)"
            priority: "51"
            seq_num: "52"
            source: "<your_own_value>"
            source6: "<your_own_value>"
            spillover_threshold: "55"
            status: "disable"
            volume_ratio: "57"
            weight: "58"
        neighbor:
         -
            health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
            ip: "<your_own_value> (source router.bgp.neighbor.ip)"
            member: "62 (source system.virtual-wan-link.members.seq-num)"
            role: "standalone"
            sla_id: "64"
        neighbor_hold_boot_time: "65"
        neighbor_hold_down: "enable"
        neighbor_hold_down_time: "67"
        service:
         -
            addr_mode: "ipv4"
            bandwidth_weight: "70"
            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: "81"
            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: "86"
            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: "108"
            latency_weight: "109"
            link_cost_factor: "latency"
            link_cost_threshold: "111"
            member: "112 (source system.virtual-wan-link.members.seq-num)"
            mode: "auto"
            name: "default_name_114"
            packet_loss_weight: "115"
            priority_members:
             -
                seq_num: "117 (source system.virtual-wan-link.members.seq-num)"
            protocol: "118"
            quality_link: "119"
            role: "standalone"
            route_tag: "121"
            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: "132"
            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"

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always Sample: “v5.6.3”

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Collection links

Issue Tracker Homepage Repository (Sources)

fortinet.fortios.fortios_system_virtual_wan_link module – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.

Synopsis

Requirements

Parameters

Notes

Examples

Return Values