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

New in fortinet.fortimanager 2.0.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_virtualwanlink dictionary	The top level parameters set.
fail-alert-interfaces any	(list) Deprecated, please rename it to fail_alert_interfaces. Physical interfaces that will be alerted.
fail-detect string	Deprecated, please rename it to fail_detect. Enable/disable SD-WAN Internet connection status checking Choices: "disable" "enable"
health-check list / elements=dictionary	Deprecated, please rename it to health_check. Health check.
_dynamic-server string	Deprecated, please rename it to _dynamic_server. Dynamic server.
addr-mode string	Deprecated, please rename it to addr_mode. Address mode Choices: "ipv4" "ipv6"
diffservcode string	Differentiated services code point
dns-request-domain string	Deprecated, please rename it to dns_request_domain. Fully qualified domain name to resolve for the DNS probe.
failtime integer	Number of failures before server is considered lost
ha-priority integer	Deprecated, please rename it to ha_priority. HA election priority
http-agent string	Deprecated, please rename it to http_agent. String in the http-agent field in the HTTP header.
http-get string	Deprecated, please rename it to http_get. URL used to communicate with the server if the protocol if the protocol …
http-match string	Deprecated, please rename it to http_match. Response string expected from the server if the protocol is HTTP.
internet-service-id string	Deprecated, please rename it to internet_service_id. Internet service ID.
interval integer	Status check interval, or the time between attempting to connect to the server
members any	(list or str) Member sequence number list.
name string	Status check or health check name.
packet-size integer	Deprecated, please rename it to packet_size. 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	Deprecated, please rename it to probe_count. Number of most recent probes that should be used to calculate latency…
probe-packets string	Deprecated, please rename it to probe_packets. Enable/disable transmission of probe packets. Choices: "disable" "enable"
probe-timeout integer	Deprecated, please rename it to probe_timeout. 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"
recoverytime integer	Number of successful responses received before server is considered recovered
security-mode string	Deprecated, please rename it to security_mode. 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	Deprecated, please rename it to jitter_threshold. Jitter for SLA to make decision in milliseconds.
latency-threshold integer	Deprecated, please rename it to latency_threshold. Latency for SLA to make decision in milliseconds.
link-cost-factor list / elements=string	Deprecated, please rename it to link_cost_factor. Criteria on which to base link selection. Choices: "latency" "jitter" "packet-loss"
packetloss-threshold integer	Deprecated, please rename it to packetloss_threshold. Packet loss for SLA to make decision in percentage.
sla-fail-log-period integer	Deprecated, please rename it to sla_fail_log_period. Time interval in seconds that SLA fail log messages will be g…
sla-pass-log-period integer	Deprecated, please rename it to sla_pass_log_period. Time interval in seconds that SLA pass log messages will be g…
system-dns string	Deprecated, please rename it to system_dns. Enable/disable system DNS as the probe server. Choices: "disable" "enable"
threshold-alert-jitter integer	Deprecated, please rename it to threshold_alert_jitter. Alert threshold for jitter
threshold-alert-latency integer	Deprecated, please rename it to threshold_alert_latency. Alert threshold for latency
threshold-alert-packetloss integer	Deprecated, please rename it to threshold_alert_packetloss. Alert threshold for packet loss
threshold-warning-jitter integer	Deprecated, please rename it to threshold_warning_jitter. Warning threshold for jitter
threshold-warning-latency integer	Deprecated, please rename it to threshold_warning_latency. Warning threshold for latency
threshold-warning-packetloss integer	Deprecated, please rename it to threshold_warning_packetloss. Warning threshold for packet loss
timeout integer	How long to wait before not receiving a reply from the server to consider the connetion attempt a failure
update-cascade-interface string	Deprecated, please rename it to update_cascade_interface. Enable/disable update cascade interface. Choices: "disable" "enable"
update-static-route string	Deprecated, please rename it to update_static_route. Enable/disable updating the static route. Choices: "disable" "enable"
load-balance-mode string	Deprecated, please rename it to load_balance_mode. Algorithm or mode to use for load balancing Internet traffic to SD-WAN … Choices: "source-ip-based" "weight-based" "usage-based" "source-dest-ip-based" "measured-volume-based"
members list / elements=dictionary	Members.
_dynamic-member string	Deprecated, please rename it to _dynamic_member. 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	Deprecated, please rename it to ingress_spillover_threshold. Ingress spillover threshold for this interface
interface string	Interface name.
priority integer	Priority of the interface
seq-num integer	Deprecated, please rename it to seq_num. 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	Deprecated, please rename it to spillover_threshold. Egress spillover threshold for this interface
status string	Enable/disable this interface in the SD-WAN. Choices: "disable" "enable"
volume-ratio integer	Deprecated, please rename it to volume_ratio. Measured volume ratio
weight integer	Weight of this interface for weighted load balancing.
neighbor list / elements=dictionary	Neighbor.
health-check string	Deprecated, please rename it to health_check. 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	Deprecated, please rename it to sla_id. SLA ID.
neighbor-hold-boot-time integer	Deprecated, please rename it to neighbor_hold_boot_time. Waiting period in seconds when switching from the primary neighbo…
neighbor-hold-down string	Deprecated, please rename it to neighbor_hold_down. Enable/disable hold switching from the secondary neighbor to the prima… Choices: "disable" "enable"
neighbor-hold-down-time integer	Deprecated, please rename it to neighbor_hold_down_time. Waiting period in seconds when switching from the secondary neigh…
service list / elements=dictionary	Service.
addr-mode string	Deprecated, please rename it to addr_mode. Address mode Choices: "ipv4" "ipv6"
bandwidth-weight integer	Deprecated, please rename it to bandwidth_weight. Coefficient of reciprocal of available bidirectional bandwidth i…
default string	Enable/disable use of SD-WAN as default service. Choices: "disable" "enable"
dscp-forward string	Deprecated, please rename it to dscp_forward. Enable/disable forward traffic DSCP tag. Choices: "disable" "enable"
dscp-forward-tag string	Deprecated, please rename it to dscp_forward_tag. Forward traffic DSCP tag.
dscp-reverse string	Deprecated, please rename it to dscp_reverse. Enable/disable reverse traffic DSCP tag. Choices: "disable" "enable"
dscp-reverse-tag string	Deprecated, please rename it to dscp_reverse_tag. Reverse traffic DSCP tag.
dst any	(list or str) Destination address name.
dst-negate string	Deprecated, please rename it to dst_negate. Enable/disable negation of destination address match. Choices: "disable" "enable"
dst6 any	(list or str) Destination address6 name.
end-port integer	Deprecated, please rename it to end_port. End destination port number.
gateway string	Enable/disable SD-WAN service gateway. Choices: "disable" "enable"
groups any	(list or str) User groups.
health-check string	Deprecated, please rename it to health_check. Health check.
hold-down-time integer	Deprecated, please rename it to hold_down_time. Waiting period in seconds when switching from the back-up member t…
id integer	Priority rule ID
input-device any	(list or str) Deprecated, please rename it to input_device. Source interface name.
input-device-negate string	Deprecated, please rename it to input_device_negate. Enable/disable negation of input device match. Choices: "disable" "enable"
internet-service string	Deprecated, please rename it to internet_service. Enable/disable use of Internet service for application-based loa… Choices: "disable" "enable"
internet-service-app-ctrl any	(list) Deprecated, please rename it to internet_service_app_ctrl. Application control based Internet Service ID list.
internet-service-app-ctrl-group any	(list or str) Deprecated, please rename it to internet_service_app_ctrl_group. Application control based Internet …
internet-service-ctrl any	(list) Deprecated, please rename it to internet_service_ctrl. Control-based Internet Service ID list.
internet-service-ctrl-group any	(list or str) Deprecated, please rename it to internet_service_ctrl_group. Control-based Internet Service group list.
internet-service-custom any	(list or str) Deprecated, please rename it to internet_service_custom. Custom Internet service name list.
internet-service-custom-group any	(list or str) Deprecated, please rename it to internet_service_custom_group. Custom Internet Service group list.
internet-service-group any	(list or str) Deprecated, please rename it to internet_service_group. Internet Service group list.
internet-service-id any	(list or str) Deprecated, please rename it to internet_service_id. Internet service ID list.
internet-service-name string	Deprecated, please rename it to internet_service_name. Internet service name list.
jitter-weight integer	Deprecated, please rename it to jitter_weight. Coefficient of jitter in the formula of custom-profile-1.
latency-weight integer	Deprecated, please rename it to latency_weight. Coefficient of latency in the formula of custom-profile-1.
link-cost-factor string	Deprecated, please rename it to link_cost_factor. Link cost factor. Choices: "latency" "jitter" "packet-loss" "inbandwidth" "outbandwidth" "bibandwidth" "custom-profile-1"
link-cost-threshold integer	Deprecated, please rename it to link_cost_threshold. Percentage threshold change of link cost values that will res…
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	Deprecated, please rename it to packet_loss_weight. Coefficient of packet-loss in the formula of custom-profile-1.
priority-members any	(list or str) Deprecated, please rename it to priority_members. Member sequence number list.
protocol integer	Protocol number.
quality-link integer	Deprecated, please rename it to quality_link. Quality grade.
role string	Service role to work with neighbor. Choices: "primary" "secondary" "standalone"
route-tag integer	Deprecated, please rename it to route_tag. IPv4 route map route-tag.
sla list / elements=dictionary	Sla.
health-check string	Deprecated, please rename it to health_check. Virtual WAN Link health-check.
id integer	SLA ID.
sla-compare-method string	Deprecated, please rename it to sla_compare_method. Method to compare SLA value for sla and load balance mode. Choices: "order" "number"
src any	(list or str) Source address name.
src-negate string	Deprecated, please rename it to src_negate. Enable/disable negation of source address match. Choices: "disable" "enable"
src6 any	(list or str) Source address6 name.
standalone-action string	Deprecated, please rename it to standalone_action. Enable/disable service when selected neighbor role is standalon… Choices: "disable" "enable"
start-port integer	Deprecated, please rename it to start_port. Start destination port number.
status string	Enable/disable SD-WAN service. Choices: "disable" "enable"
tos string	Type of service bit pattern.
tos-mask string	Deprecated, please rename it to tos_mask. Type of service evaluated bits.
users any	(list or str) 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

• 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_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: <string>
              addr_mode: <value in [ipv4, ipv6]>
              failtime: <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>
              protocol: <value in [ping, tcp-echo, udp-echo, ...]>
              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
                  packetloss_threshold: <integer>
              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]>
              internet_service_id: <string>
              probe_packets: <value in [disable, enable]>
              sla_fail_log_period: <integer>
              sla_pass_log_period: <integer>
              timeout: <integer>
              ha_priority: <integer>
              diffservcode: <string>
              probe_timeout: <integer>
              dns_request_domain: <string>
              probe_count: <integer>
              system_dns: <value in [disable, enable]>
          load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
          members:
            -
              _dynamic_member: <string>
              comment: <string>
              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>
              cost: <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>
              health_check: <string>
              hold_down_time: <integer>
              id: <integer>
              internet_service: <value in [disable, enable]>
              internet_service_ctrl: <list or integer>
              internet_service_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_id: <list or string>
              jitter_weight: <integer>
              latency_weight: <integer>
              link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
              link_cost_threshold: <integer>
              member: <string>
              mode: <value in [auto, manual, priority, ...]>
              name: <string>
              packet_loss_weight: <integer>
              priority_members: <list or string>
              protocol: <integer>
              quality_link: <integer>
              route_tag: <integer>
              sla:
                -
                  health_check: <string>
                  id: <integer>
              src: <list or string>
              src_negate: <value in [disable, enable]>
              src6: <list or string>
              start_port: <integer>
              status: <value in [disable, enable]>
              tos: <string>
              tos_mask: <string>
              users: <list or string>
              internet_service_app_ctrl: <list or integer>
              internet_service_app_ctrl_group: <list or string>
              role: <value in [primary, secondary, standalone]>
              sla_compare_method: <value in [order, number]>
              standalone_action: <value in [disable, enable]>
              input_device: <list or string>
              internet_service_name: <string>
              input_device_negate: <value in [disable, enable]>
          status: <value in [disable, enable]>
          neighbor:
            -
              health_check: <string>
              ip: <string>
              member: <string>
              role: <value in [primary, secondary, standalone]>
              sla_id: <integer>
          neighbor_hold_boot_time: <integer>
          neighbor_hold_down: <value in [disable, enable]>
          neighbor_hold_down_time: <integer>
          fail_alert_interfaces: <list or string>

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)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)