:source: fortios_system_virtual_wan_link.py :orphan: .. fortios_system_virtual_wan_link: fortios_system_virtual_wan_link -- Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet's FortiOS and FortiGate. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 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.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v6.2.7 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - 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: "" failtime: "1800" ha_priority: "25" http_agent: "" http_get: "" http_match: "" interval: "1800000" members: - seq_num: "" name: "default_name_17" packet_size: "512" password: "" 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: "" gateway6: "" ingress_spillover_threshold: "8388000" interface: " (source system.interface.name)" priority: "2147483647" seq_num: "" source: "" source6: "" spillover_threshold: "8388000" status: "disable" volume_ratio: "127" weight: "127" neighbor: - health_check: " (source system.virtual-wan-link.health-check.name)" ip: " (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: "" dscp_reverse: "enable" dscp_reverse_tag: "" 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: " (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: "" protocol: "127" quality_link: "127" role: "standalone" route_tag: "2147483647" sla: - health_check: " (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: "" tos_mask: "" users: - name: "default_name_137 (source user.local.name)" status: "disable" zone: - name: "default_name_140" 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: .. raw:: html
  • 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
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.