fmgd_system_sdwan – Configure redundant Internet connections with multiple outbound links and health-check profiles.
Added in version 1.0.0.
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
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- 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...
- duplication Duplication. type: list
more...
- dstaddr Destination address or address group names. type: list more...
- dstaddr6 Destination address6 or address6 group names. type: list more...
- dstintf Outgoing (egress) interfaces or zones. type: list more...
- id Duplication rule id (1 - 255). type: int more...
- packet_de_duplication (Alias name: packet-de-duplication) Enable/disable discarding of packets that have been duplicated. type: str choices: [disable, enable] more...
- packet_duplication (Alias name: packet-duplication) Configure packet duplication method. type: str choices: [disable, force, on-demand] more...
- service Service and service group name. type: list more...
- service_id (Alias name: service-id) Sd-wan service rule id list. type: list more...
- 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...
- srcaddr Source address or address group names. type: list more...
- srcaddr6 Source address6 or address6 group names. type: list more...
- srcintf Incoming (ingress) interfaces or zones. type: list more...
- 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...
- fail_alert_interfaces (Alias name: fail-alert-interfaces) Support meta variable type: list more...
- fail_detect (Alias name: fail-detect) Enable/disable sd-wan internet connection status checking (failure detection). type: str choices: [disable, enable] more...
- health_check (Alias name: health-check) Health check. type: list
more...
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
- class_id (Alias name: class-id) Traffic class id. type: list more...
- 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...
- diffservcode Differentiated services code point (dscp) in the ip header of the probe packet. type: str more...
- dns_match_ip (Alias name: dns-match-ip) Response ip expected from dns server if the protocol is dns. type: str more...
- dns_request_domain (Alias name: dns-request-domain) Fully qualified domain name to resolve for the dns probe. type: str more...
- embed_measured_health (Alias name: embed-measured-health) Enable/disable embedding measured health information. type: str choices: [disable, enable] more...
- failtime Support meta variable type: int more...
- 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...
- ftp_mode (Alias name: ftp-mode) Ftp mode. type: str choices: [passive, port] more...
- ha_priority (Alias name: ha-priority) Ha election priority (1 - 50). type: int more...
- http_agent (Alias name: http-agent) String in the http-agent field in the http header. type: str more...
- http_get (Alias name: http-get) Url used to communicate with the server if the protocol if the protocol is http. type: str more...
- http_match (Alias name: http-match) Response string expected from the server if the protocol is http. type: str more...
- interval Support meta variable type: int more...
- members Member sequence number list. type: list more...
- mos_codec (Alias name: mos-codec) Codec to use for mos calculation (default = g711). type: str choices: [g711, g722, g729] more...
- name Status check or health check name. type: str more...
- packet_size (Alias name: packet-size) Packet size of a twamp test session. type: int more...
- password Twamp controller password in authentication mode. type: list more...
- port Port number used to communicate with the server over the selected protocol (0 - 65535, default = 0, auto select. type: int more...
- 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...
- probe_packets (Alias name: probe-packets) Enable/disable transmission of probe packets. type: str choices: [disable, enable] more...
- probe_timeout (Alias name: probe-timeout) Support meta variable type: int more...
- 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...
- quality_measured_method (Alias name: quality-measured-method) Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open] more...
- recoverytime Support meta variable type: int more...
- security_mode (Alias name: security-mode) Twamp controller security mode. type: str choices: [none, authentication] more...
- server Support meta variable type: list more...
- sla Sla. type: list
more...
- id Sla id. type: int more...
- jitter_threshold (Alias name: jitter-threshold) Support meta variable type: int more...
- latency_threshold (Alias name: latency-threshold) Support meta variable type: int more...
- 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...
- mos_threshold (Alias name: mos-threshold) Support meta variable type: str more...
- packetloss_threshold (Alias name: packetloss-threshold) Support meta variable type: int more...
- 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...
- 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...
- 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...
- 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...
- sla_id_redistribute (Alias name: sla-id-redistribute) Select the id from the sla sub-table. type: int more...
- 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...
- source Support meta variable type: str more...
- source6 Source ipv6 address used in the health-check packet to server. type: str more...
- system_dns (Alias name: system-dns) Enable/disable system dns as the probe server. type: str choices: [disable, enable] more...
- threshold_alert_jitter (Alias name: threshold-alert-jitter) Alert threshold for jitter (ms, default = 0). type: int more...
- threshold_alert_latency (Alias name: threshold-alert-latency) Alert threshold for latency (ms, default = 0). type: int more...
- threshold_alert_packetloss (Alias name: threshold-alert-packetloss) Alert threshold for packet loss (percentage, default = 0). type: int more...
- threshold_warning_jitter (Alias name: threshold-warning-jitter) Warning threshold for jitter (ms, default = 0). type: int more...
- threshold_warning_latency (Alias name: threshold-warning-latency) Warning threshold for latency (ms, default = 0). type: int more...
- threshold_warning_packetloss (Alias name: threshold-warning-packetloss) Warning threshold for packet loss (percentage, default = 0). type: int more...
- update_cascade_interface (Alias name: update-cascade-interface) Enable/disable update cascade interface. type: str choices: [disable, enable] more...
- update_static_route (Alias name: update-static-route) Enable/disable updating the static route. type: str choices: [disable, enable] more...
- user The user name to access probe server. type: str more...
- vrf Virtual routing forwarding id. type: int more...
- fortiguard Enable/disable use of fortiguard predefined server. type: str choices: [disable, enable] more...
- fortiguard_name (Alias name: fortiguard-name) Predefined health-check target name. type: list more...
- 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...
- 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...
- bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int more...
- jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int more...
- latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int more...
- packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int more...
- update_bgp_route (Alias name: update-bgp-route) Enable/disable updating the bgp route. type: str choices: [disable, enable] more...
- 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...
- members Members. type: list
more...
- comment Comments. type: str more...
- cost Support meta variable type: int more...
- gateway Support meta variable type: str more...
- gateway6 Support meta variable type: str more...
- ingress_spillover_threshold (Alias name: ingress-spillover-threshold) Support meta variable type: int more...
- interface Support meta variable type: list more...
- preferred_source (Alias name: preferred-source) Preferred source of route for this member. type: str more...
- priority Support meta variable type: int more...
- priority6 Support meta variable type: int more...
- seq_num (Alias name: seq-num) Sequence number(1-512). type: int more...
- source Support meta variable type: str more...
- source6 Support meta variable type: str more...
- spillover_threshold (Alias name: spillover-threshold) Support meta variable type: int more...
- status Enable/disable this interface in the sd-wan. type: str choices: [disable, enable] more...
- transport_group (Alias name: transport-group) Measured transport group (0 - 255). type: int more...
- volume_ratio (Alias name: volume-ratio) Support meta variable type: int more...
- weight Support meta variable type: int more...
- zone Zone name. type: list more...
- 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...
- 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...
- neighbor Neighbor. type: list
more...
- health_check (Alias name: health-check) Sd-wan health-check name. type: list more...
- ip Support meta variable type: list more...
- member Member sequence number list. type: list more...
- 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...
- mode What metric to select the neighbor. type: str choices: [sla, speedtest] more...
- role Role of neighbor. type: str choices: [primary, secondary, standalone] more...
- service_id (Alias name: service-id) Sd-wan service id to work with the neighbor. type: list more...
- sla_id (Alias name: sla-id) Sla id. type: int more...
- route_metric (Alias name: route-metric) Route-metric of neighbor. type: str choices: [preferable, priority] more...
- 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...
- 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...
- 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...
- service Service. type: list
more...
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
- agent_exclusive (Alias name: agent-exclusive) Set/unset the service as agent use exclusively. type: str choices: [disable, enable] more...
- bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int more...
- default Enable/disable use of sd-wan as default service. type: str choices: [disable, enable] more...
- dscp_forward (Alias name: dscp-forward) Enable/disable forward traffic dscp tag. type: str choices: [disable, enable] more...
- dscp_forward_tag (Alias name: dscp-forward-tag) Forward traffic dscp tag. type: str more...
- dscp_reverse (Alias name: dscp-reverse) Enable/disable reverse traffic dscp tag. type: str choices: [disable, enable] more...
- dscp_reverse_tag (Alias name: dscp-reverse-tag) Reverse traffic dscp tag. type: str more...
- dst Destination address name. type: list more...
- dst_negate (Alias name: dst-negate) Enable/disable negation of destination address match. type: str choices: [disable, enable] more...
- dst6 Destination address6 name. type: list more...
- end_port (Alias name: end-port) End destination port number. type: int more...
- end_src_port (Alias name: end-src-port) End source port number. type: int more...
- gateway Enable/disable sd-wan service gateway. type: str choices: [disable, enable] more...
- groups User groups. type: list more...
- 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...
- health_check (Alias name: health-check) Health check list. type: list more...
- 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...
- id Sd-wan rule id (1 - 4000). type: int more...
- input_device (Alias name: input-device) Source interface name. type: list more...
- input_device_negate (Alias name: input-device-negate) Enable/disable negation of input device match. type: str choices: [disable, enable] more...
- input_zone (Alias name: input-zone) Source input-zone name. type: list more...
- internet_service (Alias name: internet-service) Enable/disable use of internet service for application-based load balancing. type: str choices: [disable, enable] more...
- internet_service_app_ctrl (Alias name: internet-service-app-ctrl) Application control based internet service id list. type: list more...
- internet_service_app_ctrl_category (Alias name: internet-service-app-ctrl-category) Ids of one or more application control categories. type: list more...
- internet_service_app_ctrl_group (Alias name: internet-service-app-ctrl-group) Application control based internet service group list. type: list more...
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name list. type: list more...
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group list. type: list more...
- internet_service_group (Alias name: internet-service-group) Internet service group list. type: list more...
- internet_service_name (Alias name: internet-service-name) Internet service name list. type: list more...
- jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int more...
- latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int more...
- 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...
- 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...
- load_balance (Alias name: load-balance) Enable/disable load-balance. type: str choices: [disable, enable] more...
- minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla. type: int more...
- 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...
- name Sd-wan rule name. type: str more...
- packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int more...
- passive_measurement (Alias name: passive-measurement) Enable/disable passive measurement based on the service criteria. type: str choices: [disable, enable] more...
- priority_members (Alias name: priority-members) Member sequence number list. type: list more...
- priority_zone (Alias name: priority-zone) Priority zone name list. type: list more...
- protocol Protocol number. type: int more...
- quality_link (Alias name: quality-link) Quality grade. type: int more...
- role Service role to work with neighbor. type: str choices: [primary, secondary, standalone] more...
- shortcut Enable/disable shortcut for this service. type: str choices: [disable, enable] more...
- shortcut_priority (Alias name: shortcut-priority) High priority of advpn shortcut for this service. type: str choices: [disable, enable, auto] more...
- sla Sla. type: list more...
- sla_compare_method (Alias name: sla-compare-method) Method to compare sla value for sla mode. type: str choices: [order, number] more...
- sla_stickiness (Alias name: sla-stickiness) Enable/disable sla stickiness (default = disable). type: str choices: [disable, enable] more...
- src Source address name. type: list more...
- src_negate (Alias name: src-negate) Enable/disable negation of source address match. type: str choices: [disable, enable] more...
- src6 Source address6 name. type: list more...
- 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...
- start_port (Alias name: start-port) Start destination port number. type: int more...
- start_src_port (Alias name: start-src-port) Start source port number. type: int more...
- status Enable/disable sd-wan service. type: str choices: [disable, enable] more...
- 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...
- tos Type of service bit pattern. type: str more...
- tos_mask (Alias name: tos-mask) Type of service evaluated bits. type: str more...
- use_shortcut_sla (Alias name: use-shortcut-sla) Enable/disable use of advpn shortcut for quality comparison. type: str choices: [disable, enable] more...
- users User name. type: list more...
- zone_mode (Alias name: zone-mode) Enable/disable zone mode. type: str choices: [disable, enable] more...
- route_tag (Alias name: route-tag) Ipv4 route map route-tag. type: int more...
- comment Comments. type: str more...
- 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...
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Fortiguard internet service name list. type: list more...
- 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...
- status Enable/disable sd-wan. type: str choices: [disable, enable] more...
- zone Zone. type: list
more...
- advpn_health_check (Alias name: advpn-health-check) Health check for advpn local overlay link quality. type: list more...
- advpn_select (Alias name: advpn-select) Enable/disable selection of advpn based on sdwan information. type: str choices: [disable, enable] more...
- 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...
- name Zone name. type: str more...
- 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...
- health_check_fortiguard (Alias name: health-check-fortiguard) Health check fortiguard. type: list
more...
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
- class_id (Alias name: class-id) Traffic class id. type: list more...
- 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...
- diffservcode Differentiated services code point (dscp) in the ip header of the probe packet. type: str more...
- dns_match_ip (Alias name: dns-match-ip) Response ip expected from dns server if the protocol is dns. type: str more...
- dns_request_domain (Alias name: dns-request-domain) Fully qualified domain name to resolve for the dns probe. type: str more...
- embed_measured_health (Alias name: embed-measured-health) Enable/disable embedding measured health information. type: str choices: [disable, enable] more...
- failtime Number of failures before server is considered lost (1 - 3600, default = 5). type: int more...
- 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...
- ftp_mode (Alias name: ftp-mode) Ftp mode. type: str choices: [passive, port] more...
- ha_priority (Alias name: ha-priority) Ha election priority (1 - 50). type: int more...
- http_agent (Alias name: http-agent) String in the http-agent field in the http header. type: str more...
- http_get (Alias name: http-get) Url used to communicate with the server if the protocol if the protocol is http. type: str more...
- http_match (Alias name: http-match) Response string expected from the server if the protocol is http. type: str more...
- 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...
- members Member sequence number list. type: list more...
- mos_codec (Alias name: mos-codec) Codec to use for mos calculation (default = g711). type: str choices: [g711, g722, g729] more...
- packet_size (Alias name: packet-size) Packet size of a twamp test session. type: int more...
- password Twamp controller password in authentication mode. type: list more...
- port Port number used to communicate with the server over the selected protocol (0 - 65535, default = 0, auto select. type: int more...
- 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...
- probe_packets (Alias name: probe-packets) Enable/disable transmission of probe packets. type: str choices: [disable, enable] more...
- 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...
- 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...
- quality_measured_method (Alias name: quality-measured-method) Method to measure the quality of tcp-connect. type: str choices: [half-close, half-open] more...
- recoverytime Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int more...
- security_mode (Alias name: security-mode) Twamp controller security mode. type: str choices: [none, authentication] more...
- server Predefined ip address or fqdn name from fortiguard. type: list more...
- sla Sla. type: list
more...
- id Sla id. type: int more...
- jitter_threshold (Alias name: jitter-threshold) Jitter for sla to make decision in milliseconds. type: int more...
- latency_threshold (Alias name: latency-threshold) Latency for sla to make decision in milliseconds. type: int more...
- 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...
- mos_threshold (Alias name: mos-threshold) Minimum mean opinion score for sla to be marked as pass. type: str more...
- packetloss_threshold (Alias name: packetloss-threshold) Packet loss for sla to make decision in percentage. type: int more...
- 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...
- 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...
- 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...
- sla_id_redistribute (Alias name: sla-id-redistribute) Select the id from the sla sub-table. type: int more...
- 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...
- source Source ip address used in the health-check packet to the server. type: str more...
- source6 Source ipv6 address used in the health-check packet to server. type: str more...
- system_dns (Alias name: system-dns) Enable/disable system dns as the probe server. type: str choices: [disable, enable] more...
- target_name (Alias name: target-name) Status check or predefined health-check targets name. type: str more...
- threshold_alert_jitter (Alias name: threshold-alert-jitter) Alert threshold for jitter (ms, default = 0). type: int more...
- threshold_alert_latency (Alias name: threshold-alert-latency) Alert threshold for latency (ms, default = 0). type: int more...
- threshold_alert_packetloss (Alias name: threshold-alert-packetloss) Alert threshold for packet loss (percentage, default = 0). type: int more...
- threshold_warning_jitter (Alias name: threshold-warning-jitter) Warning threshold for jitter (ms, default = 0). type: int more...
- threshold_warning_latency (Alias name: threshold-warning-latency) Warning threshold for latency (ms, default = 0). type: int more...
- threshold_warning_packetloss (Alias name: threshold-warning-packetloss) Warning threshold for packet loss (percentage, default = 0). type: int more...
- update_cascade_interface (Alias name: update-cascade-interface) Enable/disable update cascade interface. type: str choices: [disable, enable] more...
- update_static_route (Alias name: update-static-route) Enable/disable updating the static route. type: str choices: [disable, enable] more...
- user The user name to access probe server. type: str more...
- vrf Virtual routing forwarding id. type: int more...
- option Option. type: list choices: [sdwan-overlay, sdwan-manager] more...
- duplication_max_discrepancy (Alias name: duplication-max-discrepancy) Maximum discrepancy between two packets for deduplication in milliseconds (250 - 1000, default = 250). type: int more...
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
- 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: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
system_sdwan:
# app_perf_log_period: <integer>
# duplication:
# - dstaddr: <list or string>
# dstaddr6: <list or string>
# dstintf: <list or string>
# id: <integer>
# packet_de_duplication: <value in [disable, enable]>
# packet_duplication: <value in [disable, force, on-demand]>
# service: <list or string>
# service_id: <list or string>
# sla_match_service: <value in [disable, enable]>
# srcaddr: <list or string>
# srcaddr6: <list or string>
# srcintf: <list or string>
# duplication_max_num: <integer>
# fail_alert_interfaces: <list or string>
# fail_detect: <value in [disable, enable]>
# health_check:
# - addr_mode: <value in [ipv4, ipv6]>
# class_id: <list or string>
# detect_mode: <value in [active, passive, prefer-passive, ...]>
# diffservcode: <string>
# dns_match_ip: <string>
# dns_request_domain: <string>
# embed_measured_health: <value in [disable, enable]>
# failtime: <integer>
# ftp_file: <string>
# ftp_mode: <value in [passive, port]>
# ha_priority: <integer>
# http_agent: <string>
# http_get: <string>
# http_match: <string>
# interval: <integer>
# members: <list or string>
# mos_codec: <value in [g711, g722, g729]>
# name: <string>
# packet_size: <integer>
# password: <list or string>
# port: <integer>
# probe_count: <integer>
# probe_packets: <value in [disable, enable]>
# probe_timeout: <integer>
# protocol: <value in [ping, tcp-echo, udp-echo, ...]>
# quality_measured_method: <value in [half-close, half-open]>
# recoverytime: <integer>
# security_mode: <value in [none, authentication]>
# server: <list or string>
# sla:
# - id: <integer>
# jitter_threshold: <integer>
# latency_threshold: <integer>
# link_cost_factor:
# - "latency"
# - "jitter"
# - "packet-loss"
# - "mos"
# - "remote"
# - "custom-profile-1"
# mos_threshold: <string>
# packetloss_threshold: <integer>
# priority_in_sla: <integer>
# priority_out_sla: <integer>
# custom_profile_threshold: <integer>
# sla_fail_log_period: <integer>
# sla_id_redistribute: <integer>
# sla_pass_log_period: <integer>
# source: <string>
# source6: <string>
# system_dns: <value in [disable, enable]>
# threshold_alert_jitter: <integer>
# threshold_alert_latency: <integer>
# threshold_alert_packetloss: <integer>
# threshold_warning_jitter: <integer>
# threshold_warning_latency: <integer>
# threshold_warning_packetloss: <integer>
# update_cascade_interface: <value in [disable, enable]>
# update_static_route: <value in [disable, enable]>
# user: <string>
# vrf: <integer>
# fortiguard: <value in [disable, enable]>
# fortiguard_name: <list or string>
# agent_probe_timeout: <integer>
# remote_probe_timeout: <integer>
# bandwidth_weight: <integer>
# jitter_weight: <integer>
# latency_weight: <integer>
# packet_loss_weight: <integer>
# update_bgp_route: <value in [disable, enable]>
# load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
# members:
# - comment: <string>
# cost: <integer>
# gateway: <string>
# gateway6: <string>
# ingress_spillover_threshold: <integer>
# interface: <list or string>
# preferred_source: <string>
# priority: <integer>
# priority6: <integer>
# seq_num: <integer>
# source: <string>
# source6: <string>
# spillover_threshold: <integer>
# status: <value in [disable, enable]>
# transport_group: <integer>
# volume_ratio: <integer>
# weight: <integer>
# zone: <list or string>
# priority_in_sla: <integer>
# priority_out_sla: <integer>
# neighbor:
# - health_check: <list or string>
# ip: <list or string>
# member: <list or string>
# minimum_sla_meet_members: <integer>
# mode: <value in [sla, speedtest]>
# role: <value in [primary, secondary, standalone]>
# service_id: <list or string>
# sla_id: <integer>
# route_metric: <value in [preferable, priority]>
# neighbor_hold_boot_time: <integer>
# neighbor_hold_down: <value in [disable, enable]>
# neighbor_hold_down_time: <integer>
# service:
# - addr_mode: <value in [ipv4, ipv6]>
# agent_exclusive: <value in [disable, enable]>
# bandwidth_weight: <integer>
# default: <value in [disable, enable]>
# dscp_forward: <value in [disable, enable]>
# dscp_forward_tag: <string>
# dscp_reverse: <value in [disable, enable]>
# dscp_reverse_tag: <string>
# dst: <list or string>
# dst_negate: <value in [disable, enable]>
# dst6: <list or string>
# end_port: <integer>
# end_src_port: <integer>
# gateway: <value in [disable, enable]>
# groups: <list or string>
# hash_mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
# health_check: <list or string>
# hold_down_time: <integer>
# id: <integer>
# input_device: <list or string>
# input_device_negate: <value in [disable, enable]>
# input_zone: <list or string>
# internet_service: <value in [disable, enable]>
# internet_service_app_ctrl: <list or integer>
# internet_service_app_ctrl_category: <list or integer>
# internet_service_app_ctrl_group: <list or string>
# internet_service_custom: <list or string>
# internet_service_custom_group: <list or string>
# internet_service_group: <list or string>
# internet_service_name: <list or string>
# jitter_weight: <integer>
# latency_weight: <integer>
# link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
# link_cost_threshold: <integer>
# load_balance: <value in [disable, enable]>
# minimum_sla_meet_members: <integer>
# mode: <value in [auto, manual, priority, ...]>
# name: <string>
# packet_loss_weight: <integer>
# passive_measurement: <value in [disable, enable]>
# priority_members: <list or string>
# priority_zone: <list or string>
# protocol: <integer>
# quality_link: <integer>
# role: <value in [primary, secondary, standalone]>
# shortcut: <value in [disable, enable]>
# shortcut_priority: <value in [disable, enable, auto]>
# sla:
# - health_check: <list or string>
# id: <integer>
# sla_compare_method: <value in [order, number]>
# sla_stickiness: <value in [disable, enable]>
# src: <list or string>
# src_negate: <value in [disable, enable]>
# src6: <list or string>
# standalone_action: <value in [disable, enable]>
# start_port: <integer>
# start_src_port: <integer>
# status: <value in [disable, enable]>
# tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
# tos: <string>
# tos_mask: <string>
# use_shortcut_sla: <value in [disable, enable]>
# users: <list or string>
# zone_mode: <value in [disable, enable]>
# route_tag: <integer>
# comment: <string>
# fib_best_match_force: <value in [disable, enable]>
# internet_service_fortiguard: <list or string>
# speedtest_bypass_routing: <value in [disable, enable]>
# status: <value in [disable, enable]>
# zone:
# - advpn_health_check: <list or string>
# advpn_select: <value in [disable, enable]>
# minimum_sla_meet_members: <integer>
# name: <string>
# service_sla_tie_break: <value in [cfg-order, fib-best-match, input-device, ...]>
# health_check_fortiguard:
# - addr_mode: <value in [ipv4, ipv6]>
# class_id: <list or string>
# detect_mode: <value in [active, passive, prefer-passive, ...]>
# diffservcode: <string>
# dns_match_ip: <string>
# dns_request_domain: <string>
# embed_measured_health: <value in [disable, enable]>
# failtime: <integer>
# ftp_file: <string>
# ftp_mode: <value in [passive, port]>
# ha_priority: <integer>
# http_agent: <string>
# http_get: <string>
# http_match: <string>
# interval: <integer>
# members: <list or string>
# mos_codec: <value in [g711, g722, g729]>
# packet_size: <integer>
# password: <list or string>
# port: <integer>
# probe_count: <integer>
# probe_packets: <value in [disable, enable]>
# probe_timeout: <integer>
# protocol: <value in [ping, tcp-echo, udp-echo, ...]>
# quality_measured_method: <value in [half-close, half-open]>
# recoverytime: <integer>
# security_mode: <value in [none, authentication]>
# server: <list or string>
# sla:
# - id: <integer>
# jitter_threshold: <integer>
# latency_threshold: <integer>
# link_cost_factor:
# - "latency"
# - "jitter"
# - "packet-loss"
# - "mos"
# - "remote"
# mos_threshold: <string>
# packetloss_threshold: <integer>
# priority_in_sla: <integer>
# priority_out_sla: <integer>
# sla_fail_log_period: <integer>
# sla_id_redistribute: <integer>
# sla_pass_log_period: <integer>
# source: <string>
# source6: <string>
# system_dns: <value in [disable, enable]>
# target_name: <string>
# threshold_alert_jitter: <integer>
# threshold_alert_latency: <integer>
# threshold_alert_packetloss: <integer>
# threshold_warning_jitter: <integer>
# threshold_warning_latency: <integer>
# threshold_warning_packetloss: <integer>
# update_cascade_interface: <value in [disable, enable]>
# update_static_route: <value in [disable, enable]>
# user: <string>
# vrf: <integer>
# option:
# - "sdwan-overlay"
# - "sdwan-manager"
# duplication_max_discrepancy: <integer>
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:
- 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.