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.8.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

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

wanprof

string / required

The parameter (wanprof) in requested url.

wanprof_system_sdwan

dictionary

The top level parameters set.

app_perf_log_period

integer

Time interval in seconds that applicationperformance logs are generated

duplication

list / elements=dictionary

Duplication.

dstaddr

any

(list or str) Destination address or address group names.

dstaddr6

any

(list or str) Destination address6 or address6 group names.

dstintf

any

(list or str) Outgoing

id

integer

Duplication rule ID

packet_de_duplication

string

Enable/disable discarding of packets that have been duplicated.

Choices:

  • "disable"

  • "enable"

packet_duplication

string

Configure packet duplication method.

Choices:

  • "disable"

  • "force"

  • "on-demand"

service

any

(list or str) Service and service group name.

service_id

any

(list or str) SD-WAN service rule ID list.

sla_match_service

string

Enable/disable packet duplication matching health-check SLAs in service rule.

Choices:

  • "disable"

  • "enable"

srcaddr

any

(list or str) Source address or address group names.

srcaddr6

any

(list or str) Source address6 or address6 group names.

srcintf

any

(list or str) Incoming

duplication_max_num

integer

Maximum number of interface members a packet is duplicated in the SD-WAN zone

fail_alert_interfaces

any

(list) Physical interfaces that will be alerted.

fail_detect

string

Enable/disable SD-WAN Internet connection status checking

Choices:

  • "disable"

  • "enable"

health_check

list / elements=dictionary

Health check.

_dynamic_server

string

Dynamic server.

addr_mode

string

Address mode

Choices:

  • "ipv4"

  • "ipv6"

class_id

string

Traffic class ID.

detect_mode

string

The mode determining how to detect the server.

Choices:

  • "active"

  • "passive"

  • "prefer-passive"

  • "remote"

  • "agent-based"

diffservcode

string

Differentiated services code point

dns_match_ip

string

Response IP expected from DNS server if the protocol is DNS.

dns_request_domain

string

Fully qualified domain name to resolve for the DNS probe.

embed_measured_health

string

Enable/disable embedding measured health information.

Choices:

  • "disable"

  • "enable"

failtime

integer

Number of failures before server is considered lost

ftp_file

string

Full path and file name on the FTP server to download for FTP health-check to probe.

ftp_mode

string

FTP mode.

Choices:

  • "passive"

  • "port"

ha_priority

integer

HA election priority

http_agent

string

String in the http-agent field in the HTTP header.

http_get

string

URL used to communicate with the server if the protocol if the protocol is HTTP.

http_match

string

Response string expected from the server if the protocol is HTTP.

interval

integer

Status check interval in milliseconds, or the time between attempting to connect to the server

members

any

(list or str) Member sequence number list.

mos_codec

string

Codec to use for MOS calculation

Choices:

  • "g711"

  • "g722"

  • "g729"

name

string

Status check or health check name.

packet_size

integer

Packet size of a twamp test session,

password

any

(list) Twamp controller password in authentication mode

port

integer

Port number used to communicate with the server over the selected protocol

probe_count

integer

Number of most recent probes that should be used to calculate latency and jitter

probe_packets

string

Enable/disable transmission of probe packets.

Choices:

  • "disable"

  • "enable"

probe_timeout

integer

Time to wait before a probe packet is considered lost

protocol

string

Protocol used to determine if the FortiGate can communicate with the server.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

  • "twamp"

  • "ping6"

  • "dns"

  • "tcp-connect"

  • "ftp"

  • "https"

quality_measured_method

string

Method to measure the quality of tcp-connect.

Choices:

  • "half-close"

  • "half-open"

recoverytime

integer

Number of successful responses received before server is considered recovered

security_mode

string

Twamp controller security mode.

Choices:

  • "none"

  • "authentication"

server

any

(list) IP address or FQDN name of the server.

sla

list / elements=dictionary

Sla.

id

integer

SLA ID.

jitter_threshold

integer

Jitter for SLA to make decision in milliseconds.

latency_threshold

integer

Latency for SLA to make decision in milliseconds.

list / elements=string

Criteria on which to base link selection.

Choices:

  • "latency"

  • "jitter"

  • "packet-loss"

  • "mos"

  • "remote"

mos_threshold

string

Minimum Mean Opinion Score for SLA to be marked as pass.

packetloss_threshold

integer

Packet loss for SLA to make decision in percentage.

priority_in_sla

integer

Value to be distributed into routing table when in-sla

priority_out_sla

integer

Value to be distributed into routing table when out-sla

sla_fail_log_period

integer

Time interval in seconds that SLA fail log messages will be generated

sla_id_redistribute

integer

Select the ID from the SLA sub-table.

sla_pass_log_period

integer

Time interval in seconds that SLA pass log messages will be generated

source

string

Source IP address used in the health-check packet to the server.

source6

string

Source IPv6 addressused in the health-check packet to server.

system_dns

string

Enable/disable system DNS as the probe server.

Choices:

  • "disable"

  • "enable"

threshold_alert_jitter

integer

Alert threshold for jitter

threshold_alert_latency

integer

Alert threshold for latency

threshold_alert_packetloss

integer

Alert threshold for packet loss

threshold_warning_jitter

integer

Warning threshold for jitter

threshold_warning_latency

integer

Warning threshold for latency

threshold_warning_packetloss

integer

Warning threshold for packet loss

update_cascade_interface

string

Enable/disable update cascade interface.

Choices:

  • "disable"

  • "enable"

update_static_route

string

Enable/disable updating the static route.

Choices:

  • "disable"

  • "enable"

user

string

The user name to access probe server.

vrf

integer

Virtual Routing Forwarding ID.

health_check_fortiguard

list / elements=dictionary

Health check fortiguard.

addr_mode

string

Address mode

Choices:

  • "ipv4"

  • "ipv6"

class_id

any

(list) Traffic class ID.

detect_mode

string

The mode determining how to detect the server.

Choices:

  • "active"

  • "passive"

  • "prefer-passive"

  • "remote"

  • "agent-based"

diffservcode

string

Differentiated services code point

dns_match_ip

string

Response IP expected from DNS server if the protocol is DNS.

dns_request_domain

string

Fully qualified domain name to resolve for the DNS probe.

embed_measured_health

string

Enable/disable embedding measured health information.

Choices:

  • "disable"

  • "enable"

failtime

integer

Number of failures before server is considered lost

ftp_file

string

Full path and file name on the FTP server to download for FTP health-check to probe.

ftp_mode

string

FTP mode.

Choices:

  • "passive"

  • "port"

ha_priority

integer

HA election priority

http_agent

string

String in the http-agent field in the HTTP header.

http_get

string

URL used to communicate with the server if the protocol if the protocol is HTTP.

http_match

string

Response string expected from the server if the protocol is HTTP.

interval

integer

Status check interval in milliseconds, or the time between attempting to connect to the server

members

any

(list) Member sequence number list.

mos_codec

string

Codec to use for MOS calculation

Choices:

  • "g711"

  • "g722"

  • "g729"

packet_size

integer

Packet size of a TWAMP test session.

password

any

(list) TWAMP controller password in authentication mode.

port

integer

Port number used to communicate with the server over the selected protocol

probe_count

integer

Number of most recent probes that should be used to calculate latency and jitter

probe_packets

string

Enable/disable transmission of probe packets.

Choices:

  • "disable"

  • "enable"

probe_timeout

integer

Time to wait before a probe packet is considered lost

protocol

string

Protocol used to determine if the FortiGate can communicate with the server.

Choices:

  • "ping"

  • "tcp-echo"

  • "udp-echo"

  • "http"

  • "twamp"

  • "dns"

  • "tcp-connect"

  • "ftp"

  • "https"

quality_measured_method

string

Method to measure the quality of tcp-connect.

Choices:

  • "half-close"

  • "half-open"

recoverytime

integer

Number of successful responses received before server is considered recovered

security_mode

string

Twamp controller security mode.

Choices:

  • "none"

  • "authentication"

server

any

(list) Predefined IP address or FQDN name from FortiGuard.

sla

list / elements=dictionary

Sla.

id

integer

SLA ID.

jitter_threshold

integer

Jitter for SLA to make decision in milliseconds.

latency_threshold

integer

Latency for SLA to make decision in milliseconds.

list / elements=string

Criteria on which to base link selection.

Choices:

  • "latency"

  • "jitter"

  • "packet-loss"

  • "mos"

  • "remote"

mos_threshold

string

Minimum Mean Opinion Score for SLA to be marked as pass.

packetloss_threshold

integer

Packet loss for SLA to make decision in percentage.

priority_in_sla

integer

Value to be distributed into routing table when in-sla

priority_out_sla

integer

Value to be distributed into routing table when out-sla

sla_fail_log_period

integer

Time interval in seconds that SLA fail log messages will be generated

sla_id_redistribute

integer

Select the ID from the SLA sub-table.

sla_pass_log_period

integer

Time interval in seconds that SLA pass log messages will be generated

source

string

Source IP address used in the health-check packet to the server.

source6

string

Source IPv6 address used in the health-check packet to server.

system_dns

string

Enable/disable system DNS as the probe server.

Choices:

  • "disable"

  • "enable"

target_name

string

Status check or predefined health-check targets name.

threshold_alert_jitter

integer

Alert threshold for jitter

threshold_alert_latency

integer

Alert threshold for latency

threshold_alert_packetloss

integer

Alert threshold for packet loss

threshold_warning_jitter

integer

Warning threshold for jitter

threshold_warning_latency

integer

Warning threshold for latency

threshold_warning_packetloss

integer

Warning threshold for packet loss

update_cascade_interface

string

Enable/disable update cascade interface.

Choices:

  • "disable"

  • "enable"

update_static_route

string

Enable/disable updating the static route.

Choices:

  • "disable"

  • "enable"

user

string

The user name to access probe server.

vrf

integer

Virtual Routing Forwarding ID.

load_balance_mode

string

Algorithm or mode to use for load balancing Internet traffic to SD-WAN members.

Choices:

  • "source-ip-based"

  • "weight-based"

  • "usage-based"

  • "source-dest-ip-based"

  • "measured-volume-based"

members

list / elements=dictionary

Members.

_dynamic_member

string

Dynamic member.

comment

string

Comments.

cost

integer

Cost of this interface for services in SLA mode

gateway

string

The default gateway for this interface.

gateway6

string

IPv6 gateway.

ingress_spillover_threshold

integer

Ingress spillover threshold for this interface

interface

string

Interface name.

preferred_source

string

Preferred source of route for this member.

priority

integer

Priority of the interface

priority6

integer

Priority of the interface for IPv6

priority_in_sla

integer

Preferred priority of routes to this member when this member is in-sla

priority_out_sla

integer

Preferred priority of routes to this member when this member is out-of-sla

seq_num

integer

Sequence number

source

string

Source IP address used in the health-check packet to the server.

source6

string

Source IPv6 address used in the health-check packet to the server.

spillover_threshold

integer

Egress spillover threshold for this interface

status

string

Enable/disable this interface in the SD-WAN.

Choices:

  • "disable"

  • "enable"

transport_group

integer

Measured transport group

volume_ratio

integer

Measured volume ratio

weight

integer

Weight of this interface for weighted load balancing.

zone

string

Zone name.

neighbor

list / elements=dictionary

Neighbor.

health_check

string

SD-WAN health-check name.

ip

string

IP/IPv6 address of neighbor.

member

any

(list or str) Member sequence number.

minimum_sla_meet_members

integer

Minimum number of members which meet SLA when the neighbor is preferred.

mode

string

What metric to select the neighbor.

Choices:

  • "sla"

  • "speedtest"

role

string

Role of neighbor.

Choices:

  • "primary"

  • "secondary"

  • "standalone"

service_id

string

SD-WAN service ID to work with the neighbor.

sla_id

integer

SLA ID.

neighbor_hold_boot_time

integer

Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start.

neighbor_hold_down

string

Enable/disable hold switching from the secondary neighbor to the primary neighbor.

Choices:

  • "disable"

  • "enable"

neighbor_hold_down_time

integer

Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled.

option

list / elements=string

Option.

Choices:

  • "sdwan-overlay"

  • "sdwan-manager"

service

list / elements=dictionary

Service.

addr_mode

string

Address mode

Choices:

  • "ipv4"

  • "ipv6"

agent_exclusive

string

Set/unset the service as agent use exclusively.

Choices:

  • "disable"

  • "enable"

bandwidth_weight

integer

Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1.

comment

string

Comments.

default

string

Enable/disable use of SD-WAN as default service.

Choices:

  • "disable"

  • "enable"

dscp_forward

string

Enable/disable forward traffic DSCP tag.

Choices:

  • "disable"

  • "enable"

dscp_forward_tag

string

Forward traffic DSCP tag.

dscp_reverse

string

Enable/disable reverse traffic DSCP tag.

Choices:

  • "disable"

  • "enable"

dscp_reverse_tag

string

Reverse traffic DSCP tag.

dst

any

(list or str) Destination address name.

dst6

any

(list or str) Destination address6 name.

dst_negate

string

Enable/disable negation of destination address match.

Choices:

  • "disable"

  • "enable"

end_port

integer

End destination port number.

end_src_port

integer

End source port number.

gateway

string

Enable/disable SD-WAN service gateway.

Choices:

  • "disable"

  • "enable"

groups

any

(list or str) User groups.

hash_mode

string

Hash algorithm for selected priority members for load balance mode.

Choices:

  • "round-robin"

  • "source-ip-based"

  • "source-dest-ip-based"

  • "inbandwidth"

  • "outbandwidth"

  • "bibandwidth"

health_check

any

(list or str) Health check list.

hold_down_time

integer

Waiting period in seconds when switching from the back-up member to the primary member

id

integer

SD-WAN rule ID

input_device

any

(list or str) Source interface name.

input_device_negate

string

Enable/disable negation of input device match.

Choices:

  • "disable"

  • "enable"

input_zone

any

(list) Source input-zone name.

internet_service

string

Enable/disable use of Internet service for application-based load balancing.

Choices:

  • "disable"

  • "enable"

internet_service_app_ctrl

any

(list) Application control based Internet Service ID list.

internet_service_app_ctrl_category

any

(list) IDs of one or more application control categories.

internet_service_app_ctrl_group

any

(list or str) Application control based Internet Service group list.

internet_service_custom

any

(list or str) Custom Internet service name list.

internet_service_custom_group

any

(list or str) Custom Internet Service group list.

internet_service_group

any

(list or str) Internet Service group list.

internet_service_name

any

(list or str) Internet service name list.

jitter_weight

integer

Coefficient of jitter in the formula of custom-profile-1.

latency_weight

integer

Coefficient of latency in the formula of custom-profile-1.

string

Link cost factor.

Choices:

  • "latency"

  • "jitter"

  • "packet-loss"

  • "inbandwidth"

  • "outbandwidth"

  • "bibandwidth"

  • "custom-profile-1"

integer

Percentage threshold change of link cost values that will result in policy route regeneration

load_balance

string

Enable/disable load-balance.

Choices:

  • "disable"

  • "enable"

minimum_sla_meet_members

integer

Minimum number of members which meet SLA.

mode

string

Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN.

Choices:

  • "auto"

  • "manual"

  • "priority"

  • "sla"

  • "load-balance"

name

string

SD-WAN rule name.

packet_loss_weight

integer

Coefficient of packet-loss in the formula of custom-profile-1.

passive_measurement

string

Enable/disable passive measurement based on the service criteria.

Choices:

  • "disable"

  • "enable"

priority_members

any

(list or str) Member sequence number list.

priority_zone

any

(list or str) Priority zone name list.

protocol

integer

Protocol number.

integer

Quality grade.

role

string

Service role to work with neighbor.

Choices:

  • "primary"

  • "secondary"

  • "standalone"

route_tag

integer

IPv4 route map route-tag.

shortcut

string

Enable/disable shortcut for this service.

Choices:

  • "disable"

  • "enable"

shortcut_priority

string

High priority of ADVPN shortcut for this service.

Choices:

  • "disable"

  • "enable"

  • "auto"

shortcut_stickiness

string

Enable/disable shortcut-stickiness of ADVPN.

Choices:

  • "disable"

  • "enable"

sla

list / elements=dictionary

Sla.

health_check

string

SD-WAN health-check.

id

integer

SLA ID.

sla_compare_method

string

Method to compare SLA value for SLA mode.

Choices:

  • "order"

  • "number"

sla_stickiness

string

Enable/disable SLA stickiness

Choices:

  • "disable"

  • "enable"

src

any

(list or str) Source address name.

src6

any

(list or str) Source address6 name.

src_negate

string

Enable/disable negation of source address match.

Choices:

  • "disable"

  • "enable"

standalone_action

string

Enable/disable service when selected neighbor role is standalone while service role is not standalone.

Choices:

  • "disable"

  • "enable"

start_port

integer

Start destination port number.

start_src_port

integer

Start source port number.

status

string

Enable/disable SD-WAN service.

Choices:

  • "disable"

  • "enable"

tie_break

string

Method of selecting member if more than one meets the SLA.

Choices:

  • "zone"

  • "cfg-order"

  • "fib-best-match"

  • "input-device"

tos

string

Type of service bit pattern.

tos_mask

string

Type of service evaluated bits.

use_shortcut_sla

string

Enable/disable use of ADVPN shortcut for quality comparison.

Choices:

  • "disable"

  • "enable"

users

any

(list or str) User name.

zone_mode

string

Enable/disable zone mode.

Choices:

  • "disable"

  • "enable"

speedtest_bypass_routing

string

Enable/disable bypass routing when speedtest on a SD-WAN member.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable SD-WAN.

Choices:

  • "disable"

  • "enable"

zone

list / elements=dictionary

Zone.

advpn_health_check

string

Health check for ADVPN local overlay link quality.

advpn_select

string

Enable/disable selection of ADVPN based on SDWAN information.

Choices:

  • "disable"

  • "enable"

minimum_sla_meet_members

integer

Minimum number of members which meet SLA when the neighbor is preferred.

name

string

Zone name.

service_sla_tie_break

string

Method of selecting member if more than one meets the SLA.

Choices:

  • "cfg-order"

  • "fib-best-match"

  • "input-device"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

  • 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure redundant internet connections using SD-WAN
      fortinet.fortimanager.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: <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>
              srcaddr: <list or string>
              srcaddr6: <list or string>
              srcintf: <list or string>
              service_id: <list or string>
              sla_match_service: <value in [disable, enable]>
          duplication_max_num: <integer>
          fail_detect: <value in [disable, enable]>
          health_check:
            -
              _dynamic_server: <string>
              addr_mode: <value in [ipv4, ipv6]>
              diffservcode: <string>
              dns_match_ip: <string>
              dns_request_domain: <string>
              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>
              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"
                  packetloss_threshold: <integer>
                  mos_threshold: <string>
                  priority_in_sla: <integer>
                  priority_out_sla: <integer>
              sla_fail_log_period: <integer>
              sla_pass_log_period: <integer>
              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>
              detect_mode: <value in [active, passive, prefer-passive, ...]>
              mos_codec: <value in [g711, g722, g729]>
              source: <string>
              vrf: <integer>
              embed_measured_health: <value in [disable, enable]>
              sla_id_redistribute: <integer>
              class_id: <string>
              source6: <string>
          load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
          members:
            -
              _dynamic_member: <string>
              comment: <string>
              cost: <integer>
              gateway: <string>
              gateway6: <string>
              ingress_spillover_threshold: <integer>
              interface: <string>
              priority: <integer>
              seq_num: <integer>
              source: <string>
              source6: <string>
              spillover_threshold: <integer>
              status: <value in [disable, enable]>
              volume_ratio: <integer>
              weight: <integer>
              zone: <string>
              priority6: <integer>
              preferred_source: <string>
              transport_group: <integer>
              priority_in_sla: <integer>
              priority_out_sla: <integer>
          neighbor:
            -
              health_check: <string>
              ip: <string>
              member: <list or string>
              role: <value in [primary, secondary, standalone]>
              sla_id: <integer>
              minimum_sla_meet_members: <integer>
              mode: <value in [sla, speedtest]>
              service_id: <string>
          neighbor_hold_boot_time: <integer>
          neighbor_hold_down: <value in [disable, enable]>
          neighbor_hold_down_time: <integer>
          service:
            -
              addr_mode: <value in [ipv4, ipv6]>
              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>
              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]>
              internet_service: <value in [disable, enable]>
              internet_service_app_ctrl: <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>
              minimum_sla_meet_members: <integer>
              mode: <value in [auto, manual, priority, ...]>
              name: <string>
              packet_loss_weight: <integer>
              priority_members: <list or string>
              protocol: <integer>
              quality_link: <integer>
              role: <value in [primary, secondary, standalone]>
              route_tag: <integer>
              sla:
                -
                  health_check: <string>
                  id: <integer>
              sla_compare_method: <value in [order, number]>
              src: <list or string>
              src_negate: <value in [disable, enable]>
              src6: <list or string>
              standalone_action: <value in [disable, enable]>
              start_port: <integer>
              status: <value in [disable, enable]>
              tos: <string>
              tos_mask: <string>
              users: <list or string>
              tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
              use_shortcut_sla: <value in [disable, enable]>
              input_zone: <list or string>
              internet_service_app_ctrl_category: <list or integer>
              passive_measurement: <value in [disable, enable]>
              priority_zone: <list or string>
              agent_exclusive: <value in [disable, enable]>
              shortcut: <value in [disable, enable]>
              shortcut_stickiness: <value in [disable, enable]>
              end_src_port: <integer>
              load_balance: <value in [disable, enable]>
              sla_stickiness: <value in [disable, enable]>
              start_src_port: <integer>
              zone_mode: <value in [disable, enable]>
              shortcut_priority: <value in [disable, enable, auto]>
              comment: <string>
          status: <value in [disable, enable]>
          zone:
            -
              name: <string>
              service_sla_tie_break: <value in [cfg-order, fib-best-match, input-device]>
              minimum_sla_meet_members: <integer>
              advpn_health_check: <string>
              advpn_select: <value in [disable, enable]>
          speedtest_bypass_routing: <value in [disable, enable]>
          fail_alert_interfaces: <list or string>
          app_perf_log_period: <integer>
          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"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)