• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Documentation
Ansible
6

Ansible getting started

  • Getting started with Ansible

Installation, Upgrade & Configuration

  • Installation Guide
  • Ansible Porting Guides

Using Ansible

  • User Guide

Contributing to Ansible

  • Ansible Community Guide
  • Ansible Collections Contributor Guide
  • ansible-core Contributors Guide
  • Advanced Contributor Guide
  • Ansible documentation style guide

Extending Ansible

  • Developer Guide

Common Ansible Scenarios

  • Legacy Public Cloud Guides
  • Network Technology Guides
  • Virtualization and Containerization Guides

Network Automation

  • Network Getting Started
  • Network Advanced Topics
  • Network Developer Guide

Ansible Galaxy

  • Galaxy User Guide
  • Galaxy Developer Guide

Reference & Appendices

  • Collection Index
    • Collections in the Amazon Namespace
    • Collections in the Ansible Namespace
    • Collections in the Arista Namespace
    • Collections in the Awx Namespace
    • Collections in the Azure Namespace
    • Collections in the Check_point Namespace
    • Collections in the Chocolatey Namespace
    • Collections in the Cisco Namespace
    • Collections in the Cloud Namespace
    • Collections in the Cloudscale_ch Namespace
    • Collections in the Community Namespace
    • Collections in the Containers Namespace
    • Collections in the Cyberark Namespace
    • Collections in the Dellemc Namespace
    • Collections in the F5networks Namespace
    • Collections in the Fortinet Namespace
      • Fortinet.Fortimanager
        • Description
        • Plugin Index
      • Fortinet.Fortios
    • Collections in the Frr Namespace
    • Collections in the Gluster Namespace
    • Collections in the Google Namespace
    • Collections in the Hetzner Namespace
    • Collections in the Hpe Namespace
    • Collections in the Ibm Namespace
    • Collections in the Infinidat Namespace
    • Collections in the Infoblox Namespace
    • Collections in the Inspur Namespace
    • Collections in the Junipernetworks Namespace
    • Collections in the Kubernetes Namespace
    • Collections in the Mellanox Namespace
    • Collections in the Netapp Namespace
    • Collections in the Netapp_eseries Namespace
    • Collections in the Netbox Namespace
    • Collections in the Ngine_io Namespace
    • Collections in the Openstack Namespace
    • Collections in the Openvswitch Namespace
    • Collections in the Ovirt Namespace
    • Collections in the Purestorage Namespace
    • Collections in the Sensu Namespace
    • Collections in the Servicenow Namespace
    • Collections in the Splunk Namespace
    • Collections in the T_systems_mms Namespace
    • Collections in the Theforeman Namespace
    • Collections in the Vmware Namespace
    • Collections in the Vyos Namespace
    • Collections in the Wti Namespace
  • Indexes of all modules and plugins
  • Playbook Keywords
  • Return Values
  • Ansible Configuration Settings
  • Controlling how Ansible behaves: precedence rules
  • YAML Syntax
  • Python 3 Support
  • Interpreter Discovery
  • Releases and maintenance
  • Testing Strategies
  • Sanity Tests
  • Frequently Asked Questions
  • Glossary
  • Ansible Reference: Module Utilities
  • Special Variables
  • Red Hat Ansible Automation Platform
  • Ansible Automation Hub
  • Logging Ansible output

Roadmaps

  • Ansible Roadmap
  • ansible-core Roadmaps




Ansible
  • »
  • Collection Index »
  • Collections in the Fortinet Namespace »
  • Fortinet.Fortimanager »
  • fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink module – Configure redundant internet connections using SD-WAN


fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink module – Configure redundant internet connections using SD-WAN

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

New in version 2.10: of fortinet.fortimanager

  • Synopsis

  • Parameters

  • Notes

  • Examples

  • Return Values

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

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:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

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

rc_succeeded

list / elements=string

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

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

wanprof

string / required

the parameter (wanprof) in requested url

wanprof_system_virtualwanlink

dictionary

the top level parameters set

fail-detect

string

Enable/disable SD-WAN Internet connection status checking (failure detection).

Choices:

  • disable

  • enable

health-check

list / elements=string

no description

_dynamic-server

string

no description

addr-mode

string

Address mode (IPv4 or IPv6).

Choices:

  • ipv4

  • ipv6

diffservcode

string

Differentiated services code point (DSCP) in the IP header of the probe packet.

dns-request-domain

string

Fully qualified domain name to resolve for the DNS probe.

failtime

integer

Number of failures before server is considered lost (1 - 3600, default = 5).

ha-priority

integer

HA election priority (1 - 50).

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.

internet-service-id

string

Internet service ID.

interval

integer

Status check interval, or the time between attempting to connect to the server (1 - 3600 sec, default = 5).

members

string

Member sequence number list.

name

string

Status check or health check name.

packet-size

integer

Packet size of a twamp test session,

password

string

no description

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 (5 - 30, default = 30).

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 (500 - 5000 msec, default = 500).

protocol

string

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

Choices:

  • ping

  • tcp-echo

  • udp-echo

  • http

  • twamp

  • ping6

  • dns

recoverytime

integer

Number of successful responses received before server is considered recovered (1 - 3600, default = 5).

security-mode

string

Twamp controller security mode.

Choices:

  • none

  • authentication

server

string

no description

sla

list / elements=string

no description

id

integer

SLA ID.

jitter-threshold

integer

Jitter for SLA to make decision in milliseconds. (0 - 10000000, default = 5).

latency-threshold

integer

Latency for SLA to make decision in milliseconds. (0 - 10000000, default = 5).

link-cost-factor

list / elements=string

no description

Choices:

  • latency

  • jitter

  • packet-loss

packetloss-threshold

integer

Packet loss for SLA to make decision in percentage. (0 - 100, default = 0).

sla-fail-log-period

integer

Time interval in seconds that SLA fail log messages will be generated (0 - 3600, default = 0).

sla-pass-log-period

integer

Time interval in seconds that SLA pass log messages will be generated (0 - 3600, default = 0).

system-dns

string

Enable/disable system DNS as the probe server.

Choices:

  • disable

  • enable

threshold-alert-jitter

integer

Alert threshold for jitter (ms, default = 0).

threshold-alert-latency

integer

Alert threshold for latency (ms, default = 0).

threshold-alert-packetloss

integer

Alert threshold for packet loss (percentage, default = 0).

threshold-warning-jitter

integer

Warning threshold for jitter (ms, default = 0).

threshold-warning-latency

integer

Warning threshold for latency (ms, default = 0).

threshold-warning-packetloss

integer

Warning threshold for packet loss (percentage, default = 0).

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

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=string

no description

_dynamic-member

string

no description

comment

string

Comments.

cost

integer

Cost of this interface for services in SLA mode (0 - 4294967295, default = 0).

gateway

string

The default gateway for this interface. Usually the default gateway of the Internet service provider that this interfa…

gateway6

string

IPv6 gateway.

ingress-spillover-threshold

integer

Ingress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, n…

interface

string

Interface name.

priority

integer

Priority of the interface (0 - 4294967295). Used for SD-WAN rules or priority rules.

seq-num

integer

Sequence number(1-255).

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 (0 - 16776000 kbit/s). When this traffic volume threshold is reached, ne…

status

string

Enable/disable this interface in the SD-WAN.

Choices:

  • disable

  • enable

volume-ratio

integer

Measured volume ratio (this value / sum of all values = percentage of link volume, 0 - 255).

weight

integer

Weight of this interface for weighted load balancing. (0 - 255) More traffic is directed to interfaces with higher wei…

neighbor

list / elements=string

no description

health-check

string

SD-WAN health-check name.

ip

string

IP address of neighbor.

member

string

Member sequence number.

role

string

Role of neighbor.

Choices:

  • primary

  • secondary

  • standalone

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. (0 - 100…

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. (0 - …

service

list / elements=string

no description

addr-mode

string

Address mode (IPv4 or IPv6).

Choices:

  • ipv4

  • ipv6

bandwidth-weight

integer

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

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

string

Destination address name.

dst-negate

string

Enable/disable negation of destination address match.

Choices:

  • disable

  • enable

dst6

string

Destination address6 name.

end-port

integer

End destination port number.

gateway

string

Enable/disable SD-WAN service gateway.

Choices:

  • disable

  • enable

groups

string

User groups.

health-check

string

Health check.

hold-down-time

integer

Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0).

id

integer

Priority rule ID (1 - 4000).

input-device

string

Source interface name.

internet-service

string

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

Choices:

  • disable

  • enable

internet-service-app-ctrl

integer

no description

internet-service-app-ctrl-group

string

Application control based Internet Service group list.

internet-service-ctrl

integer

no description

internet-service-ctrl-group

string

Control-based Internet Service group list.

internet-service-custom

string

Custom Internet service name list.

internet-service-custom-group

string

Custom Internet Service group list.

internet-service-group

string

Internet Service group list.

internet-service-id

string

Internet service ID list.

internet-service-name

string

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.

link-cost-factor

string

Link cost factor.

Choices:

  • latency

  • jitter

  • packet-loss

  • inbandwidth

  • outbandwidth

  • bibandwidth

  • custom-profile-1

link-cost-threshold

integer

Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default =…

member

string

Member sequence number.

mode

string

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

Choices:

  • auto

  • manual

  • priority

  • sla

  • load-balance

name

string

Priority rule name.

packet-loss-weight

integer

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

priority-members

string

Member sequence number list.

protocol

integer

Protocol number.

quality-link

integer

Quality grade.

role

string

Service role to work with neighbor.

Choices:

  • primary

  • secondary

  • standalone

route-tag

integer

IPv4 route map route-tag.

sla

list / elements=string

no description

health-check

string

Virtual WAN Link health-check.

id

integer

SLA ID.

sla-compare-method

string

Method to compare SLA value for sla and load balance mode.

Choices:

  • order

  • number

src

string

Source address name.

src-negate

string

Enable/disable negation of source address match.

Choices:

  • disable

  • enable

src6

string

Source address6 name.

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.

status

string

Enable/disable SD-WAN service.

Choices:

  • disable

  • enable

tos

string

Type of service bit pattern.

tos-mask

string

Type of service evaluated bits.

users

string

User name.

status

string

Enable/disable SD-WAN.

Choices:

  • disable

  • enable

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

  • 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_virtualwanlink:
        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_virtualwanlink:
           fail-detect: <value in [disable, enable]>
           health-check:
             -
                 _dynamic-server: <value of string>
                 addr-mode: <value in [ipv4, ipv6]>
                 failtime: <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>
                 protocol: <value in [ping, tcp-echo, udp-echo, ...]>
                 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
                       packetloss-threshold: <value of integer>
                 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]>
                 internet-service-id: <value of string>
                 probe-packets: <value in [disable, enable]>
                 sla-fail-log-period: <value of integer>
                 sla-pass-log-period: <value of integer>
                 ha-priority: <value of integer>
                 diffservcode: <value of string>
                 probe-timeout: <value of integer>
                 dns-request-domain: <value of string>
                 probe-count: <value of integer>
                 system-dns: <value in [disable, enable]>
           load-balance-mode: <value in [source-ip-based, weight-based, usage-based, ...]>
           members:
             -
                 _dynamic-member: <value of string>
                 comment: <value of string>
                 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>
                 cost: <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>
                 health-check: <value of string>
                 hold-down-time: <value of integer>
                 id: <value of integer>
                 internet-service: <value in [disable, enable]>
                 internet-service-ctrl: <value of integer>
                 internet-service-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-id: <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>
                 member: <value of string>
                 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>
                 route-tag: <value of integer>
                 sla:
                   -
                       health-check: <value of string>
                       id: <value of integer>
                 src: <value of string>
                 src-negate: <value in [disable, enable]>
                 src6: <value of string>
                 start-port: <value of integer>
                 status: <value in [disable, enable]>
                 tos: <value of string>
                 tos-mask: <value of string>
                 users: <value of string>
                 internet-service-app-ctrl: <value of integer>
                 internet-service-app-ctrl-group: <value of string>
                 role: <value in [primary, secondary, standalone]>
                 sla-compare-method: <value in [order, number]>
                 standalone-action: <value in [disable, enable]>
                 input-device: <value of string>
                 internet-service-name: <value of string>
           status: <value in [disable, enable]>
           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>
           neighbor-hold-boot-time: <value of integer>
           neighbor-hold-down: <value in [disable, enable]>
           neighbor-hold-down-time: <value of integer>

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)

Collection links

Issue Tracker Homepage Repository (Sources)

Previous Next

© Copyright Ansible project contributors. Last updated on Jun 21, 2022.