fortinet.fortimanager.fmgr_wanprof_system_sdwan module – Configure redundant internet connections using SD-WAN
Note
This module is part of the fortinet.fortimanager collection (version 2.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_wanprof_system_sdwan
.
New in fortinet.fortimanager 2.1.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
the parameter (adom) in requested url |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
the parameter (wanprof) in requested url |
|
the top level parameters set |
|
Time interval in seconds that applicationperformance logs are generated |
|
description |
|
Destination address or address group names. |
|
Destination address6 or address6 group names. |
|
Outgoing |
|
Duplication rule ID |
|
Enable/disable discarding of packets that have been duplicated. Choices:
|
|
Configure packet duplication method. Choices:
|
|
Service and service group name. |
|
SD-WAN service rule ID list. |
|
Enable/disable packet duplication matching health-check SLAs in service rule. Choices:
|
|
Source address or address group names. |
|
Source address6 or address6 group names. |
|
Incoming |
|
Maximum number of interface members a packet is duplicated in the SD-WAN zone |
|
description |
|
Enable/disable SD-WAN Internet connection status checking Choices:
|
|
description |
|
no description |
|
Address mode Choices:
|
|
Traffic class ID. |
|
The mode determining how to detect the server. Choices:
|
|
Differentiated services code point |
|
Response IP expected from DNS server if the protocol is DNS. |
|
Fully qualified domain name to resolve for the DNS probe. |
|
Enable/disable embedding measured health information. Choices:
|
|
Number of failures before server is considered lost |
|
Full path and file name on the FTP server to download for FTP health-check to probe. |
|
FTP mode. Choices:
|
|
HA election priority |
|
String in the http-agent field in the HTTP header. |
|
URL used to communicate with the server if the protocol if the protocol is HTTP. |
|
Response string expected from the server if the protocol is HTTP. |
|
Status check interval in milliseconds, or the time between attempting to connect to the server |
|
Member sequence number list. |
|
Codec to use for MOS calculation Choices:
|
|
Status check or health check name. |
|
Packet size of a twamp test session, |
|
description |
|
Port number used to communicate with the server over the selected protocol |
|
Number of most recent probes that should be used to calculate latency and jitter |
|
Enable/disable transmission of probe packets. Choices:
|
|
Time to wait before a probe packet is considered lost |
|
Protocol used to determine if the FortiGate can communicate with the server. Choices:
|
|
Method to measure the quality of tcp-connect. Choices:
|
|
Number of successful responses received before server is considered recovered |
|
Twamp controller security mode. Choices:
|
|
description |
|
description |
|
SLA ID. |
|
Jitter for SLA to make decision in milliseconds. |
|
Latency for SLA to make decision in milliseconds. |
|
description Choices:
|
|
Minimum Mean Opinion Score for SLA to be marked as pass. |
|
Packet loss for SLA to make decision in percentage. |
|
Value to be distributed into routing table when in-sla |
|
Value to be distributed into routing table when out-sla |
|
Time interval in seconds that SLA fail log messages will be generated |
|
Select the ID from the SLA sub-table. |
|
Time interval in seconds that SLA pass log messages will be generated |
|
Source IP address used in the health-check packet to the server. |
|
Source IPv6 addressused in the health-check packet to server. |
|
Enable/disable system DNS as the probe server. Choices:
|
|
Alert threshold for jitter |
|
Alert threshold for latency |
|
Alert threshold for packet loss |
|
Warning threshold for jitter |
|
Warning threshold for latency |
|
Warning threshold for packet loss |
|
Enable/disable update cascade interface. Choices:
|
|
Enable/disable updating the static route. Choices:
|
|
The user name to access probe server. |
|
Virtual Routing Forwarding ID. |
|
Algorithm or mode to use for load balancing Internet traffic to SD-WAN members. Choices:
|
|
description |
|
no description |
|
Comments. |
|
Cost of this interface for services in SLA mode |
|
The default gateway for this interface. |
|
IPv6 gateway. |
|
Ingress spillover threshold for this interface |
|
Interface name. |
|
Preferred source of route for this member. |
|
Priority of the interface |
|
Priority of the interface for IPv6 |
|
Sequence number |
|
Source IP address used in the health-check packet to the server. |
|
Source IPv6 address used in the health-check packet to the server. |
|
Egress spillover threshold for this interface |
|
Enable/disable this interface in the SD-WAN. Choices:
|
|
Measured volume ratio |
|
Weight of this interface for weighted load balancing. |
|
Zone name. |
|
description |
|
SD-WAN health-check name. |
|
IP/IPv6 address of neighbor. |
|
Member sequence number. |
|
Minimum number of members which meet SLA when the neighbor is preferred. |
|
What metric to select the neighbor. Choices:
|
|
Role of neighbor. Choices:
|
|
SLA ID. |
|
Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. |
|
Enable/disable hold switching from the secondary neighbor to the primary neighbor. Choices:
|
|
Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. |
|
description |
|
Address mode Choices:
|
|
Set/unset the service as agent use exclusively. Choices:
|
|
Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. |
|
Enable/disable use of SD-WAN as default service. Choices:
|
|
Enable/disable forward traffic DSCP tag. Choices:
|
|
Forward traffic DSCP tag. |
|
Enable/disable reverse traffic DSCP tag. Choices:
|
|
Reverse traffic DSCP tag. |
|
Destination address name. |
|
Enable/disable negation of destination address match. Choices:
|
|
Destination address6 name. |
|
End destination port number. |
|
Enable/disable SD-WAN service gateway. Choices:
|
|
User groups. |
|
Hash algorithm for selected priority members for load balance mode. Choices:
|
|
Health check list. |
|
Waiting period in seconds when switching from the back-up member to the primary member |
|
SD-WAN rule ID |
|
Source interface name. |
|
Enable/disable negation of input device match. Choices:
|
|
description |
|
Enable/disable use of Internet service for application-based load balancing. Choices:
|
|
description |
|
description |
|
Application control based Internet Service group list. |
|
Custom Internet service name list. |
|
Custom Internet Service group list. |
|
Internet Service group list. |
|
Internet service name list. |
|
Coefficient of jitter in the formula of custom-profile-1. |
|
Coefficient of latency in the formula of custom-profile-1. |
|
Link cost factor. Choices:
|
|
Percentage threshold change of link cost values that will result in policy route regeneration |
|
Minimum number of members which meet SLA. |
|
Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN. Choices:
|
|
SD-WAN rule name. |
|
Coefficient of packet-loss in the formula of custom-profile-1. |
|
Enable/disable passive measurement based on the service criteria. Choices:
|
|
Member sequence number list. |
|
description |
|
Protocol number. |
|
Quality grade. |
|
Service role to work with neighbor. Choices:
|
|
IPv4 route map route-tag. |
|
Enable/disable shortcut for this service. Choices:
|
|
Enable/disable shortcut-stickiness of ADVPN. Choices:
|
|
description |
|
SD-WAN health-check. |
|
SLA ID. |
|
Method to compare SLA value for SLA mode. Choices:
|
|
Source address name. |
|
Enable/disable negation of source address match. Choices:
|
|
Source address6 name. |
|
Enable/disable service when selected neighbor role is standalone while service role is not standalone. Choices:
|
|
Start destination port number. |
|
Enable/disable SD-WAN service. Choices:
|
|
Method of selecting member if more than one meets the SLA. Choices:
|
|
Type of service bit pattern. |
|
Type of service evaluated bits. |
|
Enable/disable use of ADVPN shortcut for quality comparison. Choices:
|
|
User name. |
|
Enable/disable bypass routing when speedtest on a SD-WAN member. Choices:
|
|
Enable/disable SD-WAN. Choices:
|
|
description |
|
Zone name. |
|
Method of selecting member if more than one meets the SLA. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure redundant internet connections using SD-WAN
fmgr_wanprof_system_sdwan:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
wanprof: <your own value>
wanprof_system_sdwan:
duplication:
-
dstaddr: <value of string>
dstaddr6: <value of string>
dstintf: <value of string>
id: <value of integer>
packet-de-duplication: <value in [disable, enable]>
packet-duplication: <value in [disable, force, on-demand]>
service: <value of string>
srcaddr: <value of string>
srcaddr6: <value of string>
srcintf: <value of string>
service-id: <value of string>
sla-match-service: <value in [disable, enable]>
duplication-max-num: <value of integer>
fail-detect: <value in [disable, enable]>
health-check:
-
_dynamic-server: <value of string>
addr-mode: <value in [ipv4, ipv6]>
diffservcode: <value of string>
dns-match-ip: <value of string>
dns-request-domain: <value of string>
failtime: <value of integer>
ftp-file: <value of string>
ftp-mode: <value in [passive, port]>
ha-priority: <value of integer>
http-agent: <value of string>
http-get: <value of string>
http-match: <value of string>
interval: <value of integer>
members: <value of string>
name: <value of string>
packet-size: <value of integer>
password: <value of string>
port: <value of integer>
probe-count: <value of integer>
probe-packets: <value in [disable, enable]>
probe-timeout: <value of integer>
protocol: <value in [ping, tcp-echo, udp-echo, ...]>
quality-measured-method: <value in [half-close, half-open]>
recoverytime: <value of integer>
security-mode: <value in [none, authentication]>
server: <value of string>
sla:
-
id: <value of integer>
jitter-threshold: <value of integer>
latency-threshold: <value of integer>
link-cost-factor:
- latency
- jitter
- packet-loss
- mos
packetloss-threshold: <value of integer>
mos-threshold: <value of string>
priority-in-sla: <value of integer>
priority-out-sla: <value of integer>
sla-fail-log-period: <value of integer>
sla-pass-log-period: <value of integer>
system-dns: <value in [disable, enable]>
threshold-alert-jitter: <value of integer>
threshold-alert-latency: <value of integer>
threshold-alert-packetloss: <value of integer>
threshold-warning-jitter: <value of integer>
threshold-warning-latency: <value of integer>
threshold-warning-packetloss: <value of integer>
update-cascade-interface: <value in [disable, enable]>
update-static-route: <value in [disable, enable]>
user: <value of string>
detect-mode: <value in [active, passive, prefer-passive, ...]>
mos-codec: <value in [g711, g722, g729]>
source: <value of string>
vrf: <value of integer>
embed-measured-health: <value in [disable, enable]>
sla-id-redistribute: <value of integer>
class-id: <value of string>
source6: <value of string>
load-balance-mode: <value in [source-ip-based, weight-based, usage-based, ...]>
members:
-
_dynamic-member: <value of string>
comment: <value of string>
cost: <value of integer>
gateway: <value of string>
gateway6: <value of string>
ingress-spillover-threshold: <value of integer>
interface: <value of string>
priority: <value of integer>
seq-num: <value of integer>
source: <value of string>
source6: <value of string>
spillover-threshold: <value of integer>
status: <value in [disable, enable]>
volume-ratio: <value of integer>
weight: <value of integer>
zone: <value of string>
priority6: <value of integer>
preferred-source: <value of string>
neighbor:
-
health-check: <value of string>
ip: <value of string>
member: <value of string>
role: <value in [primary, secondary, standalone]>
sla-id: <value of integer>
minimum-sla-meet-members: <value of integer>
mode: <value in [sla, speedtest]>
neighbor-hold-boot-time: <value of integer>
neighbor-hold-down: <value in [disable, enable]>
neighbor-hold-down-time: <value of integer>
service:
-
addr-mode: <value in [ipv4, ipv6]>
bandwidth-weight: <value of integer>
default: <value in [disable, enable]>
dscp-forward: <value in [disable, enable]>
dscp-forward-tag: <value of string>
dscp-reverse: <value in [disable, enable]>
dscp-reverse-tag: <value of string>
dst: <value of string>
dst-negate: <value in [disable, enable]>
dst6: <value of string>
end-port: <value of integer>
gateway: <value in [disable, enable]>
groups: <value of string>
hash-mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
health-check: <value of string>
hold-down-time: <value of integer>
id: <value of integer>
input-device: <value of string>
input-device-negate: <value in [disable, enable]>
internet-service: <value in [disable, enable]>
internet-service-app-ctrl: <value of integer>
internet-service-app-ctrl-group: <value of string>
internet-service-custom: <value of string>
internet-service-custom-group: <value of string>
internet-service-group: <value of string>
internet-service-name: <value of string>
jitter-weight: <value of integer>
latency-weight: <value of integer>
link-cost-factor: <value in [latency, jitter, packet-loss, ...]>
link-cost-threshold: <value of integer>
minimum-sla-meet-members: <value of integer>
mode: <value in [auto, manual, priority, ...]>
name: <value of string>
packet-loss-weight: <value of integer>
priority-members: <value of string>
protocol: <value of integer>
quality-link: <value of integer>
role: <value in [primary, secondary, standalone]>
route-tag: <value of integer>
sla:
-
health-check: <value of string>
id: <value of integer>
sla-compare-method: <value in [order, number]>
src: <value of string>
src-negate: <value in [disable, enable]>
src6: <value of string>
standalone-action: <value in [disable, enable]>
start-port: <value of integer>
status: <value in [disable, enable]>
tos: <value of string>
tos-mask: <value of string>
users: <value of string>
tie-break: <value in [zone, cfg-order, fib-best-match, ...]>
use-shortcut-sla: <value in [disable, enable]>
input-zone: <value of string>
internet-service-app-ctrl-category: <value of integer>
passive-measurement: <value in [disable, enable]>
priority-zone: <value of string>
agent-exclusive: <value in [disable, enable]>
shortcut: <value in [disable, enable]>
shortcut-stickiness: <value in [disable, enable]>
status: <value in [disable, enable]>
zone:
-
name: <value of string>
service-sla-tie-break: <value in [cfg-order, fib-best-match, input-device]>
speedtest-bypass-routing: <value in [disable, enable]>
app-perf-log-period: <value of integer>
fail-alert-interfaces: <value of string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |