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

• 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 sdwan 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

Notes

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_sdwan:
      vdom:  "{{ vdom }}"
      system_sdwan:
        duplication:
         -
            dstaddr:
             -
                name: "default_name_5 (source firewall.address.name firewall.addrgrp.name)"
            dstaddr6:
             -
                name: "default_name_7 (source firewall.address6.name firewall.addrgrp6.name)"
            dstintf:
             -
                name: "default_name_9 (source system.interface.name system.zone.name system.sdwan.zone.name)"
            id:  "10"
            packet_de_duplication: "enable"
            packet_duplication: "disable"
            service:
             -
                name: "default_name_14 (source firewall.service.custom.name firewall.service.group.name)"
            service_id:
             -
                id:  "16 (source system.sdwan.service.id)"
            srcaddr:
             -
                name: "default_name_18 (source firewall.address.name firewall.addrgrp.name)"
            srcaddr6:
             -
                name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name)"
            srcintf:
             -
                name: "default_name_22 (source system.interface.name system.zone.name system.sdwan.zone.name)"
        duplication_max_num: "23"
        fail_alert_interfaces:
         -
            name: "default_name_25 (source system.interface.name)"
        fail_detect: "enable"
        health_check:
         -
            addr_mode: "ipv4"
            detect_mode: "active"
            diffservcode: "<your_own_value>"
            dns_match_ip: "<your_own_value>"
            dns_request_domain: "<your_own_value>"
            failtime: "33"
            ftp_file: "<your_own_value>"
            ftp_mode: "passive"
            ha_priority: "36"
            http_agent: "<your_own_value>"
            http_get: "<your_own_value>"
            http_match: "<your_own_value>"
            interval: "40"
            members:
             -
                seq_num: "42 (source system.sdwan.members.seq-num)"
            name: "default_name_43"
            packet_size: "44"
            password: "<your_own_value>"
            port: "46"
            probe_count: "47"
            probe_packets: "disable"
            probe_timeout: "49"
            protocol: "ping"
            quality_measured_method: "half-open"
            recoverytime: "52"
            security_mode: "none"
            server: "192.168.100.40"
            sla:
             -
                id:  "56"
                jitter_threshold: "57"
                latency_threshold: "58"
                link_cost_factor: "latency"
                packetloss_threshold: "60"
            sla_fail_log_period: "61"
            sla_pass_log_period: "62"
            system_dns: "disable"
            threshold_alert_jitter: "64"
            threshold_alert_latency: "65"
            threshold_alert_packetloss: "66"
            threshold_warning_jitter: "67"
            threshold_warning_latency: "68"
            threshold_warning_packetloss: "69"
            update_cascade_interface: "enable"
            update_static_route: "enable"
            user: "<your_own_value>"
        load_balance_mode: "source-ip-based"
        members:
         -
            comment: "Comments."
            cost: "76"
            gateway: "<your_own_value>"
            gateway6: "<your_own_value>"
            ingress_spillover_threshold: "79"
            interface: "<your_own_value> (source system.interface.name)"
            priority: "81"
            priority6: "82"
            seq_num: "83"
            source: "<your_own_value>"
            source6: "<your_own_value>"
            spillover_threshold: "86"
            status: "disable"
            volume_ratio: "88"
            weight: "89"
            zone: "<your_own_value> (source system.sdwan.zone.name)"
        neighbor:
         -
            health_check: "<your_own_value> (source system.sdwan.health-check.name)"
            ip: "<your_own_value> (source router.bgp.neighbor.ip)"
            member: "94 (source system.sdwan.members.seq-num)"
            role: "standalone"
            sla_id: "96"
        neighbor_hold_boot_time: "97"
        neighbor_hold_down: "enable"
        neighbor_hold_down_time: "99"
        service:
         -
            addr_mode: "ipv4"
            bandwidth_weight: "102"
            default: "enable"
            dscp_forward: "enable"
            dscp_forward_tag: "<your_own_value>"
            dscp_reverse: "enable"
            dscp_reverse_tag: "<your_own_value>"
            dst:
             -
                name: "default_name_109 (source firewall.address.name firewall.addrgrp.name)"
            dst_negate: "enable"
            dst6:
             -
                name: "default_name_112 (source firewall.address6.name firewall.addrgrp6.name)"
            end_port: "113"
            gateway: "enable"
            groups:
             -
                name: "default_name_116 (source user.group.name)"
            hash_mode: "round-robin"
            health_check:
             -
                name: "default_name_119 (source system.sdwan.health-check.name)"
            hold_down_time: "120"
            id:  "121"
            input_device:
             -
                name: "default_name_123 (source system.interface.name)"
            input_device_negate: "enable"
            internet_service: "enable"
            internet_service_app_ctrl:
             -
                id:  "127"
            internet_service_app_ctrl_group:
             -
                name: "default_name_129 (source application.group.name)"
            internet_service_custom:
             -
                name: "default_name_131 (source firewall.internet-service-custom.name)"
            internet_service_custom_group:
             -
                name: "default_name_133 (source firewall.internet-service-custom-group.name)"
            internet_service_group:
             -
                name: "default_name_135 (source firewall.internet-service-group.name)"
            internet_service_name:
             -
                name: "default_name_137 (source firewall.internet-service-name.name)"
            jitter_weight: "138"
            latency_weight: "139"
            link_cost_factor: "latency"
            link_cost_threshold: "141"
            minimum_sla_meet_members: "142"
            mode: "auto"
            name: "default_name_144"
            packet_loss_weight: "145"
            priority_members:
             -
                seq_num: "147 (source system.sdwan.members.seq-num)"
            protocol: "148"
            quality_link: "149"
            role: "standalone"
            route_tag: "151"
            sla:
             -
                health_check: "<your_own_value> (source system.sdwan.health-check.name)"
                id:  "154"
            sla_compare_method: "order"
            src:
             -
                name: "default_name_157 (source firewall.address.name firewall.addrgrp.name)"
            src_negate: "enable"
            src6:
             -
                name: "default_name_160 (source firewall.address6.name firewall.addrgrp6.name)"
            standalone_action: "enable"
            start_port: "162"
            status: "enable"
            tie_break: "zone"
            tos: "<your_own_value>"
            tos_mask: "<your_own_value>"
            use_shortcut_sla: "enable"
            users:
             -
                name: "default_name_169 (source user.local.name)"
        status: "disable"
        zone:
         -
            name: "default_name_172"
            service_sla_tie_break: "cfg-order"

Return Values

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

Authors

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