:source: fmgd_system_sdwan.py
:orphan:
.. _fmgd_system_sdwan:
fmgd_system_sdwan -- Configure redundant Internet connections with multiple outbound links and health-check profiles.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- system_sdwan - Configure redundant Internet connections with multiple outbound links and health-check profiles. type: dict
- app_perf_log_period (Alias name: app-perf-log-period) Time interval in seconds that application performance logs are generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- duplication Duplication. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dstaddr Destination address or address group names. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dstaddr6 Destination address6 or address6 group names. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dstintf Outgoing (egress) interfaces or zones. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Duplication rule id (1 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- packet_de_duplication (Alias name: packet-de-duplication) Enable/disable discarding of packets that have been duplicated. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- packet_duplication (Alias name: packet-duplication) Configure packet duplication method. type: str choices: [disable, force, on-demand]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- service Service and service group name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- service_id (Alias name: service-id) Sd-wan service rule id list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sla_match_service (Alias name: sla-match-service) Enable/disable packet duplication matching health-check slas in service rule. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- srcaddr Source address or address group names. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- srcaddr6 Source address6 or address6 group names. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- srcintf Incoming (ingress) interfaces or zones. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- duplication_max_num (Alias name: duplication-max-num) Maximum number of interface members a packet is duplicated in the sd-wan zone (2 - 4, default = 2; if set to 3, the original packet plus 2 more copies are created). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_alert_interfaces (Alias name: fail-alert-interfaces) Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fail_detect (Alias name: fail-detect) Enable/disable sd-wan internet connection status checking (failure detection). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- health_check (Alias name: health-check) Health check. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- class_id (Alias name: class-id) Traffic class id. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- detect_mode (Alias name: detect-mode) The mode determining how to detect the server. type: str choices: [active, passive, prefer-passive, remote, agent-based]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- diffservcode Differentiated services code point (dscp) in the ip header of the probe packet. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_match_ip (Alias name: dns-match-ip) Response ip expected from dns server if the protocol is dns. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dns_request_domain (Alias name: dns-request-domain) Fully qualified domain name to resolve for the dns probe. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- embed_measured_health (Alias name: embed-measured-health) Enable/disable embedding measured health information. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- failtime Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ftp_file (Alias name: ftp-file) Full path and file name on the ftp server to download for ftp health-check to probe. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ftp_mode (Alias name: ftp-mode) Ftp mode. type: str choices: [passive, port]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ha_priority (Alias name: ha-priority) Ha election priority (1 - 50). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- http_agent (Alias name: http-agent) String in the http-agent field in the http header. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- http_get (Alias name: http-get) Url used to communicate with the server if the protocol if the protocol is http. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- http_match (Alias name: http-match) Response string expected from the server if the protocol is http. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interval Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- members Member sequence number list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mos_codec (Alias name: mos-codec) Codec to use for mos calculation (default = g711). type: str choices: [g711, g722, g729]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Status check or health check name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- packet_size (Alias name: packet-size) Packet size of a twamp test session. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- password Twamp controller password in authentication mode. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- port Port number used to communicate with the server over the selected protocol (0 - 65535, default = 0, auto select. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- probe_count (Alias name: probe-count) Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- probe_packets (Alias name: probe-packets) Enable/disable transmission of probe packets. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- probe_timeout (Alias name: probe-timeout) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- protocol Protocol used to determine if the fortigate can communicate with the server. type: str choices: [ping, tcp-echo, udp-echo, http, twamp, ping6, dns, tcp-connect, ftp, https]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- quality_measured_method (Alias name: quality-measured-method) Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- recoverytime Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- security_mode (Alias name: security-mode) Twamp controller security mode. type: str choices: [none, authentication]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- server Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sla Sla. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Sla id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- jitter_threshold (Alias name: jitter-threshold) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- latency_threshold (Alias name: latency-threshold) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- link_cost_factor (Alias name: link-cost-factor) Criteria on which to base link selection. type: list choices: [latency, jitter, packet-loss, mos, remote, custom-profile-1]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mos_threshold (Alias name: mos-threshold) Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- packetloss_threshold (Alias name: packetloss-threshold) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority_in_sla (Alias name: priority-in-sla) Value to be distributed into routing table when in-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority_out_sla (Alias name: priority-out-sla) Value to be distributed into routing table when out-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- custom_profile_threshold (Alias name: custom-profile-threshold) Custom profile threshold for sla to be marked as pass(0 - 10000000, default = 0). type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- sla_fail_log_period (Alias name: sla-fail-log-period) Time interval in seconds that sla fail log messages will be generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sla_id_redistribute (Alias name: sla-id-redistribute) Select the id from the sla sub-table. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sla_pass_log_period (Alias name: sla-pass-log-period) Time interval in seconds that sla pass log messages will be generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- source Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- source6 Source ipv6 address used in the health-check packet to server. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- system_dns (Alias name: system-dns) Enable/disable system dns as the probe server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- threshold_alert_jitter (Alias name: threshold-alert-jitter) Alert threshold for jitter (ms, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- threshold_alert_latency (Alias name: threshold-alert-latency) Alert threshold for latency (ms, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- threshold_alert_packetloss (Alias name: threshold-alert-packetloss) Alert threshold for packet loss (percentage, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- threshold_warning_jitter (Alias name: threshold-warning-jitter) Warning threshold for jitter (ms, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- threshold_warning_latency (Alias name: threshold-warning-latency) Warning threshold for latency (ms, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- threshold_warning_packetloss (Alias name: threshold-warning-packetloss) Warning threshold for packet loss (percentage, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- update_cascade_interface (Alias name: update-cascade-interface) Enable/disable update cascade interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- update_static_route (Alias name: update-static-route) Enable/disable updating the static route. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- user The user name to access probe server. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- vrf Virtual routing forwarding id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fortiguard Enable/disable use of fortiguard predefined server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.2 -> latest
- fortiguard_name (Alias name: fortiguard-name) Predefined health-check target name. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- agent_probe_timeout (Alias name: agent-probe-timeout) Time to wait before a probe packet is considered lost when detect-mode is agent (5000 - 3600*1000 msec, default = 60000). type: int
more...
Supported Version Ranges: v7.6.3 -> latest
- remote_probe_timeout (Alias name: remote-probe-timeout) Time to wait before a probe packet is considered lost when detect-mode is remote (20 - 3600*1000 msec, default = 5000). type: int
more...
Supported Version Ranges: v7.6.3 -> latest
- bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.6.4 -> latest
- update_bgp_route (Alias name: update-bgp-route) Enable/disable updating the bgp route. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.5 -> latest
- load_balance_mode (Alias name: 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]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- members Members. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- comment Comments. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- cost Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- gateway Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- gateway6 Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ingress_spillover_threshold (Alias name: ingress-spillover-threshold) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- interface Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- preferred_source (Alias name: preferred-source) Preferred source of route for this member. type: str
more...
Supported Version Ranges: v7.4.3 -> latest
- priority Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority6 Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- seq_num (Alias name: seq-num) Sequence number(1-512). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- source Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- source6 Support meta variable type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- spillover_threshold (Alias name: spillover-threshold) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Enable/disable this interface in the sd-wan. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- transport_group (Alias name: transport-group) Measured transport group (0 - 255). type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- volume_ratio (Alias name: volume-ratio) Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- weight Support meta variable type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- zone Zone name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority_in_sla (Alias name: priority-in-sla) Preferred priority of routes to this member when this member is in-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- priority_out_sla (Alias name: priority-out-sla) Preferred priority of routes to this member when this member is out-of-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- neighbor Neighbor. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- health_check (Alias name: health-check) Sd-wan health-check name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip Support meta variable type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- member Member sequence number list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla when the neighbor is preferred. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode What metric to select the neighbor. type: str choices: [sla, speedtest]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- role Role of neighbor. type: str choices: [primary, secondary, standalone]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- service_id (Alias name: service-id) Sd-wan service id to work with the neighbor. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- sla_id (Alias name: sla-id) Sla id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- route_metric (Alias name: route-metric) Route-metric of neighbor. type: str choices: [preferable, priority]
more...
Supported Version Ranges: v7.6.2 -> latest
- neighbor_hold_boot_time (Alias name: neighbor-hold-boot-time) Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- neighbor_hold_down (Alias name: neighbor-hold-down) Enable/disable hold switching from the secondary neighbor to the primary neighbor. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- neighbor_hold_down_time (Alias name: neighbor-hold-down-time) Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- service Service. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- agent_exclusive (Alias name: agent-exclusive) Set/unset the service as agent use exclusively. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- default Enable/disable use of sd-wan as default service. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dscp_forward (Alias name: dscp-forward) Enable/disable forward traffic dscp tag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dscp_forward_tag (Alias name: dscp-forward-tag) Forward traffic dscp tag. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dscp_reverse (Alias name: dscp-reverse) Enable/disable reverse traffic dscp tag. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dscp_reverse_tag (Alias name: dscp-reverse-tag) Reverse traffic dscp tag. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dst Destination address name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dst_negate (Alias name: dst-negate) Enable/disable negation of destination address match. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dst6 Destination address6 name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- end_port (Alias name: end-port) End destination port number. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- end_src_port (Alias name: end-src-port) End source port number. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- gateway Enable/disable sd-wan service gateway. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- groups User groups. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hash_mode (Alias name: hash-mode) Hash algorithm for selected priority members for load balance mode. type: str choices: [round-robin, source-ip-based, source-dest-ip-based, inbandwidth, outbandwidth, bibandwidth]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- health_check (Alias name: health-check) Health check list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hold_down_time (Alias name: hold-down-time) Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Sd-wan rule id (1 - 4000). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- input_device (Alias name: input-device) Source interface name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- input_device_negate (Alias name: input-device-negate) Enable/disable negation of input device match. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- input_zone (Alias name: input-zone) Source input-zone name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service (Alias name: internet-service) Enable/disable use of internet service for application-based load balancing. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_app_ctrl (Alias name: internet-service-app-ctrl) Application control based internet service id list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_app_ctrl_category (Alias name: internet-service-app-ctrl-category) Ids of one or more application control categories. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_app_ctrl_group (Alias name: internet-service-app-ctrl-group) Application control based internet service group list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_group (Alias name: internet-service-group) Internet service group list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- internet_service_name (Alias name: internet-service-name) Internet service name list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- link_cost_factor (Alias name: link-cost-factor) Link cost factor. type: str choices: [latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- link_cost_threshold (Alias name: link-cost-threshold) Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default = 10). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- load_balance (Alias name: load-balance) Enable/disable load-balance. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Control how the sd-wan rule sets the priority of interfaces in the sd-wan. type: str choices: [auto, manual, priority, sla, load-balance]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Sd-wan rule name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- passive_measurement (Alias name: passive-measurement) Enable/disable passive measurement based on the service criteria. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority_members (Alias name: priority-members) Member sequence number list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- priority_zone (Alias name: priority-zone) Priority zone name list. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- protocol Protocol number. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- quality_link (Alias name: quality-link) Quality grade. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- role Service role to work with neighbor. type: str choices: [primary, secondary, standalone]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- shortcut Enable/disable shortcut for this service. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- shortcut_priority (Alias name: shortcut-priority) High priority of advpn shortcut for this service. type: str choices: [disable, enable, auto]
more...
Supported Version Ranges: v7.4.3 -> latest
- sla Sla. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- health_check (Alias name: health-check) Sd-wan health-check. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Sla id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sla_compare_method (Alias name: sla-compare-method) Method to compare sla value for sla mode. type: str choices: [order, number]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sla_stickiness (Alias name: sla-stickiness) Enable/disable sla stickiness (default = disable). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- src Source address name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- src_negate (Alias name: src-negate) Enable/disable negation of source address match. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- src6 Source address6 name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- standalone_action (Alias name: standalone-action) Enable/disable service when selected neighbor role is standalone while service role is not standalone. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- start_port (Alias name: start-port) Start destination port number. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- start_src_port (Alias name: start-src-port) Start source port number. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- status Enable/disable sd-wan service. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tie_break (Alias name: tie-break) Method of selecting member if more than one meets the sla. type: str choices: [zone, cfg-order, fib-best-match, input-device, priority]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tos Type of service bit pattern. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tos_mask (Alias name: tos-mask) Type of service evaluated bits. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- use_shortcut_sla (Alias name: use-shortcut-sla) Enable/disable use of advpn shortcut for quality comparison. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- users User name. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- zone_mode (Alias name: zone-mode) Enable/disable zone mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- route_tag (Alias name: route-tag) Ipv4 route map route-tag. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- comment Comments. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- fib_best_match_force (Alias name: fib-best-match-force) Enable/disable force using fib-best-match oif as outgoing interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.9 -> v7.4.10, v7.6.3 -> latest
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Fortiguard internet service name list. type: list
more...
Supported Version Ranges: v7.6.4 -> latest
- speedtest_bypass_routing (Alias name: speedtest-bypass-routing) Enable/disable bypass routing when speedtest on a sd-wan member. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- status Enable/disable sd-wan. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- zone Zone. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- advpn_health_check (Alias name: advpn-health-check) Health check for advpn local overlay link quality. type: list
more...
Supported Version Ranges: v7.4.3 -> latest
- advpn_select (Alias name: advpn-select) Enable/disable selection of advpn based on sdwan information. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.3 -> latest
- minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla when the neighbor is preferred. type: int
more...
Supported Version Ranges: v7.4.3 -> latest
- name Zone name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- service_sla_tie_break (Alias name: service-sla-tie-break) Method of selecting member if more than one meets the sla. type: str choices: [cfg-order, fib-best-match, input-device, priority]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- health_check_fortiguard (Alias name: health-check-fortiguard) Health check fortiguard. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6]
more...
Supported Version Ranges: v7.6.0 -> latest
- class_id (Alias name: class-id) Traffic class id. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- detect_mode (Alias name: detect-mode) The mode determining how to detect the server. type: str choices: [active, passive, prefer-passive, remote, agent-based]
more...
Supported Version Ranges: v7.6.0 -> latest
- diffservcode Differentiated services code point (dscp) in the ip header of the probe packet. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- dns_match_ip (Alias name: dns-match-ip) Response ip expected from dns server if the protocol is dns. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- dns_request_domain (Alias name: dns-request-domain) Fully qualified domain name to resolve for the dns probe. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- embed_measured_health (Alias name: embed-measured-health) Enable/disable embedding measured health information. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- failtime Number of failures before server is considered lost (1 - 3600, default = 5). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- ftp_file (Alias name: ftp-file) Full path and file name on the ftp server to download for ftp health-check to probe. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- ftp_mode (Alias name: ftp-mode) Ftp mode. type: str choices: [passive, port]
more...
Supported Version Ranges: v7.6.0 -> latest
- ha_priority (Alias name: ha-priority) Ha election priority (1 - 50). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- http_agent (Alias name: http-agent) String in the http-agent field in the http header. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- http_get (Alias name: http-get) Url used to communicate with the server if the protocol if the protocol is http. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- http_match (Alias name: http-match) Response string expected from the server if the protocol is http. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- interval Status check interval in milliseconds, or the time between attempting to connect to the server (20 - 3600*1000 msec, default = 500). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- members Member sequence number list. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- mos_codec (Alias name: mos-codec) Codec to use for mos calculation (default = g711). type: str choices: [g711, g722, g729]
more...
Supported Version Ranges: v7.6.0 -> latest
- packet_size (Alias name: packet-size) Packet size of a twamp test session. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- password Twamp controller password in authentication mode. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- port Port number used to communicate with the server over the selected protocol (0 - 65535, default = 0, auto select. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- probe_count (Alias name: probe-count) Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- probe_packets (Alias name: probe-packets) Enable/disable transmission of probe packets. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- probe_timeout (Alias name: probe-timeout) Time to wait before a probe packet is considered lost (20 - 3600*1000 msec, default = 500). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- protocol Protocol used to determine if the fortigate can communicate with the server. type: str choices: [ping, tcp-echo, udp-echo, http, twamp, dns, tcp-connect, ftp, https]
more...
Supported Version Ranges: v7.6.0 -> latest
- quality_measured_method (Alias name: quality-measured-method) Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open]
more...
Supported Version Ranges: v7.6.0 -> latest
- recoverytime Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- security_mode (Alias name: security-mode) Twamp controller security mode. type: str choices: [none, authentication]
more...
Supported Version Ranges: v7.6.0 -> latest
- server Predefined ip address or fqdn name from fortiguard. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- sla Sla. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- id Sla id. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- jitter_threshold (Alias name: jitter-threshold) Jitter for sla to make decision in milliseconds. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- latency_threshold (Alias name: latency-threshold) Latency for sla to make decision in milliseconds. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- link_cost_factor (Alias name: link-cost-factor) Criteria on which to base link selection. type: list choices: [latency, jitter, packet-loss, mos, remote]
more...
Supported Version Ranges: v7.6.0 -> latest
- mos_threshold (Alias name: mos-threshold) Minimum mean opinion score for sla to be marked as pass. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- packetloss_threshold (Alias name: packetloss-threshold) Packet loss for sla to make decision in percentage. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- priority_in_sla (Alias name: priority-in-sla) Value to be distributed into routing table when in-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- priority_out_sla (Alias name: priority-out-sla) Value to be distributed into routing table when out-sla (0 - 65535, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- sla_fail_log_period (Alias name: sla-fail-log-period) Time interval in seconds that sla fail log messages will be generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- sla_id_redistribute (Alias name: sla-id-redistribute) Select the id from the sla sub-table. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- sla_pass_log_period (Alias name: sla-pass-log-period) Time interval in seconds that sla pass log messages will be generated (0 - 3600, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- source Source ip address used in the health-check packet to the server. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- source6 Source ipv6 address used in the health-check packet to server. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- system_dns (Alias name: system-dns) Enable/disable system dns as the probe server. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- target_name (Alias name: target-name) Status check or predefined health-check targets name. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- threshold_alert_jitter (Alias name: threshold-alert-jitter) Alert threshold for jitter (ms, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- threshold_alert_latency (Alias name: threshold-alert-latency) Alert threshold for latency (ms, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- threshold_alert_packetloss (Alias name: threshold-alert-packetloss) Alert threshold for packet loss (percentage, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- threshold_warning_jitter (Alias name: threshold-warning-jitter) Warning threshold for jitter (ms, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- threshold_warning_latency (Alias name: threshold-warning-latency) Warning threshold for latency (ms, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- threshold_warning_packetloss (Alias name: threshold-warning-packetloss) Warning threshold for packet loss (percentage, default = 0). type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- update_cascade_interface (Alias name: update-cascade-interface) Enable/disable update cascade interface. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- update_static_route (Alias name: update-static-route) Enable/disable updating the static route. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.0 -> latest
- user The user name to access probe server. type: str
more...
Supported Version Ranges: v7.6.0 -> latest
- vrf Virtual routing forwarding id. type: int
more...
Supported Version Ranges: v7.6.0 -> latest
- option Option. type: list choices: [sdwan-overlay, sdwan-manager]
more...
Supported Version Ranges: v7.6.0 -> latest
- duplication_max_discrepancy (Alias name: duplication-max-discrepancy) Maximum discrepancy between two packets for deduplication in milliseconds (250 - 1000, default = 250). type: int
more...
Supported Version Ranges: v7.6.2 -> latest
Notes
-----
.. note::
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure redundant Internet connections with multiple outbound links and health-check profiles.
fortinet.fmgdevice.fmgd_system_sdwan:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
system_sdwan:
# app_perf_log_period:
# duplication:
# - dstaddr:
# dstaddr6:
# dstintf:
# id:
# packet_de_duplication:
# packet_duplication:
# service:
# service_id:
# sla_match_service:
# srcaddr:
# srcaddr6:
# srcintf:
# duplication_max_num:
# fail_alert_interfaces:
# fail_detect:
# health_check:
# - addr_mode:
# class_id:
# detect_mode:
# diffservcode:
# dns_match_ip:
# dns_request_domain:
# embed_measured_health:
# failtime:
# ftp_file:
# ftp_mode:
# ha_priority:
# http_agent:
# http_get:
# http_match:
# interval:
# members:
# mos_codec:
# name:
# packet_size:
# password:
# port:
# probe_count:
# probe_packets:
# probe_timeout:
# protocol:
# quality_measured_method:
# recoverytime:
# security_mode:
# server:
# sla:
# - id:
# jitter_threshold:
# latency_threshold:
# link_cost_factor:
# - "latency"
# - "jitter"
# - "packet-loss"
# - "mos"
# - "remote"
# - "custom-profile-1"
# mos_threshold:
# packetloss_threshold:
# priority_in_sla:
# priority_out_sla:
# custom_profile_threshold:
# sla_fail_log_period:
# sla_id_redistribute:
# sla_pass_log_period:
# source:
# source6:
# system_dns:
# threshold_alert_jitter:
# threshold_alert_latency:
# threshold_alert_packetloss:
# threshold_warning_jitter:
# threshold_warning_latency:
# threshold_warning_packetloss:
# update_cascade_interface:
# update_static_route:
# user:
# vrf:
# fortiguard:
# fortiguard_name:
# agent_probe_timeout:
# remote_probe_timeout:
# bandwidth_weight:
# jitter_weight:
# latency_weight:
# packet_loss_weight:
# update_bgp_route:
# load_balance_mode:
# members:
# - comment:
# cost:
# gateway:
# gateway6:
# ingress_spillover_threshold:
# interface:
# preferred_source:
# priority:
# priority6:
# seq_num:
# source:
# source6:
# spillover_threshold:
# status:
# transport_group:
# volume_ratio:
# weight:
# zone:
# priority_in_sla:
# priority_out_sla:
# neighbor:
# - health_check:
# ip:
# member:
# minimum_sla_meet_members:
# mode:
# role:
# service_id:
# sla_id:
# route_metric:
# neighbor_hold_boot_time:
# neighbor_hold_down:
# neighbor_hold_down_time:
# service:
# - addr_mode:
# agent_exclusive:
# bandwidth_weight:
# default:
# dscp_forward:
# dscp_forward_tag:
# dscp_reverse:
# dscp_reverse_tag:
# dst:
# dst_negate:
# dst6:
# end_port:
# end_src_port:
# gateway:
# groups:
# hash_mode:
# health_check:
# hold_down_time:
# id:
# input_device:
# input_device_negate:
# input_zone:
# internet_service:
# internet_service_app_ctrl:
# internet_service_app_ctrl_category:
# internet_service_app_ctrl_group:
# internet_service_custom:
# internet_service_custom_group:
# internet_service_group:
# internet_service_name:
# jitter_weight:
# latency_weight:
# link_cost_factor:
# link_cost_threshold:
# load_balance:
# minimum_sla_meet_members:
# mode:
# name:
# packet_loss_weight:
# passive_measurement:
# priority_members:
# priority_zone:
# protocol:
# quality_link:
# role:
# shortcut:
# shortcut_priority:
# sla:
# - health_check:
# id:
# sla_compare_method:
# sla_stickiness:
# src:
# src_negate:
# src6:
# standalone_action:
# start_port:
# start_src_port:
# status:
# tie_break:
# tos:
# tos_mask:
# use_shortcut_sla:
# users:
# zone_mode:
# route_tag:
# comment:
# fib_best_match_force:
# internet_service_fortiguard:
# speedtest_bypass_routing:
# status:
# zone:
# - advpn_health_check:
# advpn_select:
# minimum_sla_meet_members:
# name:
# service_sla_tie_break:
# health_check_fortiguard:
# - addr_mode:
# class_id:
# detect_mode:
# diffservcode:
# dns_match_ip:
# dns_request_domain:
# embed_measured_health:
# failtime:
# ftp_file:
# ftp_mode:
# ha_priority:
# http_agent:
# http_get:
# http_match:
# interval:
# members:
# mos_codec:
# packet_size:
# password:
# port:
# probe_count:
# probe_packets:
# probe_timeout:
# protocol:
# quality_measured_method:
# recoverytime:
# security_mode:
# server:
# sla:
# - id:
# jitter_threshold:
# latency_threshold:
# link_cost_factor:
# - "latency"
# - "jitter"
# - "packet-loss"
# - "mos"
# - "remote"
# mos_threshold:
# packetloss_threshold:
# priority_in_sla:
# priority_out_sla:
# sla_fail_log_period:
# sla_id_redistribute:
# sla_pass_log_period:
# source:
# source6:
# system_dns:
# target_name:
# threshold_alert_jitter:
# threshold_alert_latency:
# threshold_alert_packetloss:
# threshold_warning_jitter:
# threshold_warning_latency:
# threshold_warning_packetloss:
# update_cascade_interface:
# update_static_route:
# user:
# vrf:
# option:
# - "sdwan-overlay"
# - "sdwan-manager"
# duplication_max_discrepancy:
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
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)