fortios_system_virtual_wan_link – Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- system_virtual_wan_link - Configure redundant internet connections using SD-WAN (formerly virtual WAN link). type: dict
- fail_alert_interfaces - Physical interfaces that will be alerted. type: list
- name - Physical interface name. Source system.interface.name. type: str required: True
- fail_detect - Enable/disable SD-WAN Internet connection status checking (failure detection). type: str choices: enable, disable
- health_check - 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. type: list
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
- failtime - Number of failures before server is considered lost (1 - 10). type: int
- http_get - URL used to communicate with the server if the protocol if the protocol is HTTP. type: str
- http_match - Response string expected from the server if the protocol is HTTP. type: str
- interval - Status check interval, or the time between attempting to connect to the server (1 - 3600 sec). type: int
- members - Member sequence number list. type: list
- seq_num - Member sequence number. Source system.virtual-wan-link.members.seq-num. type: int
- name - Status check or health check name. type: str required: True
- packet_size - Packet size of a twamp test session, type: int
- password - Twamp controller password in authentication mode type: str
- port - Port number used to communicate with the server over the selected protocol. type: int
- protocol - Protocol used to determine if the FortiGate can communicate with the server. type: str choices: ping, tcp-echo, udp-echo, http, twamp, ping6
- recoverytime - Number of successful responses received before server is considered recovered (1 - 10). type: int
- security_mode - Twamp controller security mode. type: str choices: none, authentication
- server - IP address or FQDN name of the server. type: str
- sla - Service level agreement (SLA). type: list
- id - SLA ID. type: int required: True
- jitter_threshold - Jitter for SLA to make decision in milliseconds. (0 - 10000000). type: int
- latency_threshold - Latency for SLA to make decision in milliseconds. (0 - 10000000). type: int
- link_cost_factor - Criteria on which to base link selection. type: str choices: latency, jitter, packet-loss
- packetloss_threshold - Packet loss for SLA to make decision in percentage. (0 - 100). type: int
- threshold_alert_jitter - Alert threshold for jitter (ms). type: int
- threshold_alert_latency - Alert threshold for latency (ms). type: int
- threshold_alert_packetloss - Alert threshold for packet loss (percentage). type: int
- threshold_warning_jitter - Warning threshold for jitter (ms). type: int
- threshold_warning_latency - Warning threshold for latency (ms). type: int
- threshold_warning_packetloss - Warning threshold for packet loss (percentage). type: int
- update_cascade_interface - Enable/disable update cascade interface. type: str choices: enable, disable
- update_static_route - Enable/disable updating the static route. type: str choices: enable, disable
- load_balance_mode - Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. type: str choices: source-ip-based, weight-based, usage-based, source-dest-ip-based, measured-volume-based
- members - Physical FortiGate interfaces added to the virtual-wan-link. type: list
- gateway - The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is connected to. type: str
- gateway6 - IPv6 gateway. type: str
- ingress_spillover_threshold - 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. type: int
- interface - Interface name. Source system.interface.name. type: str
- priority - Priority of the interface (0 - 4294967295). Used for SD-WAN rules or priority rules. type: int
- seq_num - Sequence number(1-255). type: int
- source - Source IP address used in the health-check packet to the server. type: str
- source6 - Source IPv6 address used in the health-check packet to the server. type: str
- spillover_threshold - 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. type: int
- status - Enable/disable this interface in the SD-WAN. type: str choices: disable, enable
- volume_ratio - Measured volume ratio (this value / sum of all values = percentage of link volume, 0 - 255). type: int
- weight - Weight of this interface for weighted load balancing. (0 - 255) More traffic is directed to interfaces with higher weights. type: int
- service - Create SD-WAN rules or priority rules (also called services) to control how sessions are distributed to physical interfaces in the SD-WAN. type: list
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
- bandwidth_weight - Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int
- dscp_forward - Enable/disable forward traffic DSCP tag. type: str choices: enable, disable
- dscp_forward_tag - Forward traffic DSCP tag. type: str
- dscp_reverse - Enable/disable reverse traffic DSCP tag. type: str choices: enable, disable
- dscp_reverse_tag - Reverse traffic DSCP tag. type: str
- dst - Destination address name. type: list
- name - Address or address group name. Source firewall.address.name firewall.addrgrp.name. type: str required: True
- dst_negate - Enable/disable negation of destination address match. type: str choices: enable, disable
- dst6 - Destination address6 name. type: list
- name - Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True
- end_port - End destination port number. type: int
- groups - User groups. type: list
- name - Group name. Source user.group.name. type: str required: True
- health_check - Health check. Source system.virtual-wan-link.health-check.name. type: str
- id - Priority rule ID (1 - 4000). type: int required: True
- input_device - Source interface name. type: list
- name - Interface name. Source system.interface.name. type: str required: True
- internet_service - Enable/disable use of Internet service for application-based load balancing. type: str choices: enable, disable
- internet_service_ctrl - Control-based Internet Service ID list. type: list
- id - Control-based Internet Service ID. type: int required: True
- internet_service_ctrl_group - Control-based Internet Service group list. type: list
- name - Control-based Internet Service group name. Source application.group.name. type: str required: True
- internet_service_custom - Custom Internet service name list. type: list
- name - Custom Internet service name. Source firewall.internet-service-custom.name. type: str required: True
- internet_service_custom_group - Custom Internet Service group list. type: list
- name - Custom Internet Service group name. Source firewall.internet-service-custom-group.name. type: str required: True
- internet_service_group - Internet Service group list. type: list
- name - Internet Service group name. Source firewall.internet-service-group.name. type: str required: True
- internet_service_id - Internet service ID list. type: list
- id - Internet service ID. Source firewall.internet-service.id. type: int required: True
- jitter_weight - Coefficient of jitter in the formula of custom-profile-1. type: int
- latency_weight - Coefficient of latency in the formula of custom-profile-1. type: int
- link_cost_factor - Link cost factor. type: str choices: latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1
- link_cost_threshold - Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000). type: int
- member - Member sequence number. type: int
- mode - Control how the priority rule sets the priority of interfaces in the SD-WAN. type: str choices: auto, manual, priority, sla
- name - Priority rule name. type: str
- packet_loss_weight - Coefficient of packet-loss in the formula of custom-profile-1. type: int
- priority_members - Member sequence number list. type: list
- seq_num - Member sequence number. Source system.virtual-wan-link.members.seq-num. type: int
- protocol - Protocol number. type: int
- quality_link - Quality grade. type: int
- route_tag - IPv4 route map route-tag. type: int
- sla - Service level agreement (SLA). type: list
- health_check - Virtual WAN Link health-check. Source system.virtual-wan-link.health-check.name. type: str
- id - SLA ID. type: int
- src - Source address name. type: list
- name - Address or address group name. Source firewall.address.name firewall.addrgrp.name. type: str required: True
- src_negate - Enable/disable negation of source address match. type: str choices: enable, disable
- src6 - Source address6 name. type: list
- name - Address6 or address6 group name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: True
- start_port - Start destination port number. type: int
- status - Enable/disable SD-WAN service. type: str choices: enable, disable
- tos - Type of service bit pattern. type: str
- tos_mask - Type of service evaluated bits. type: str
- users - User name. type: list
- name - User name. Source user.local.name. type: str required: True
- status - Enable/disable SD-WAN. type: str choices: disable, enable
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"
failtime: "8"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "11"
members:
-
seq_num: "13 (source system.virtual-wan-link.members.seq-num)"
name: "default_name_14"
packet_size: "15"
password: "<your_own_value>"
port: "17"
protocol: "ping"
recoverytime: "19"
security_mode: "none"
server: "192.168.100.40"
sla:
-
id: "23"
jitter_threshold: "24"
latency_threshold: "25"
link_cost_factor: "latency"
packetloss_threshold: "27"
threshold_alert_jitter: "28"
threshold_alert_latency: "29"
threshold_alert_packetloss: "30"
threshold_warning_jitter: "31"
threshold_warning_latency: "32"
threshold_warning_packetloss: "33"
update_cascade_interface: "enable"
update_static_route: "enable"
load_balance_mode: "source-ip-based"
members:
-
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress_spillover_threshold: "40"
interface: "<your_own_value> (source system.interface.name)"
priority: "42"
seq_num: "43"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover_threshold: "46"
status: "disable"
volume_ratio: "48"
weight: "49"
service:
-
addr_mode: "ipv4"
bandwidth_weight: "52"
dscp_forward: "enable"
dscp_forward_tag: "<your_own_value>"
dscp_reverse: "enable"
dscp_reverse_tag: "<your_own_value>"
dst:
-
name: "default_name_58 (source firewall.address.name firewall.addrgrp.name)"
dst_negate: "enable"
dst6:
-
name: "default_name_61 (source firewall.address6.name firewall.addrgrp6.name)"
end_port: "62"
groups:
-
name: "default_name_64 (source user.group.name)"
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
id: "66"
input_device:
-
name: "default_name_68 (source system.interface.name)"
internet_service: "enable"
internet_service_ctrl:
-
id: "71"
internet_service_ctrl_group:
-
name: "default_name_73 (source application.group.name)"
internet_service_custom:
-
name: "default_name_75 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_77 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_79 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "81 (source firewall.internet-service.id)"
jitter_weight: "82"
latency_weight: "83"
link_cost_factor: "latency"
link_cost_threshold: "85"
member: "86"
mode: "auto"
name: "default_name_88"
packet_loss_weight: "89"
priority_members:
-
seq_num: "91 (source system.virtual-wan-link.members.seq-num)"
protocol: "92"
quality_link: "93"
route_tag: "94"
sla:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
id: "97"
src:
-
name: "default_name_99 (source firewall.address.name firewall.addrgrp.name)"
src_negate: "enable"
src6:
-
name: "default_name_102 (source firewall.address6.name firewall.addrgrp6.name)"
start_port: "103"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
users:
-
name: "default_name_108 (source user.local.name)"
status: "disable"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3