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.9.1).

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 aliases: fail-alert-interfaces any	(list) Physical interfaces that will be alerted.
fail_detect aliases: fail-detect string	Enable/disable SD-WAN Internet connection status checking Choices: "disable" "enable"
health_check aliases: health-check list / elements=dictionary	Health check.
_dynamic_server aliases: _dynamic-server string	Dynamic server.
addr_mode aliases: addr-mode string	Address mode Choices: "ipv4" "ipv6"
diffservcode string	Differentiated services code point
dns_request_domain aliases: dns-request-domain string	Fully qualified domain name to resolve for the DNS probe.
failtime integer	Number of failures before server is considered lost
ha_priority aliases: ha-priority integer	HA election priority
http_agent aliases: http-agent string	String in the http-agent field in the HTTP header.
http_get aliases: http-get string	URL used to communicate with the server if the protocol if the protocol is HTTP.
http_match aliases: http-match string	Response string expected from the server if the protocol is HTTP.
internet_service_id aliases: internet-service-id string	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 aliases: 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 aliases: probe-count integer	Number of most recent probes that should be used to calculate latency and jitter
probe_packets aliases: probe-packets string	Enable/disable transmission of probe packets. Choices: "disable" "enable"
probe_timeout aliases: 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"
recoverytime integer	Number of successful responses received before server is considered recovered
security_mode aliases: 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 aliases: jitter-threshold integer	Jitter for SLA to make decision in milliseconds.
latency_threshold aliases: latency-threshold integer	Latency for SLA to make decision in milliseconds.
link_cost_factor aliases: link-cost-factor list / elements=string	Criteria on which to base link selection. Choices: "latency" "jitter" "packet-loss"
packetloss_threshold aliases: packetloss-threshold integer	Packet loss for SLA to make decision in percentage.
sla_fail_log_period aliases: sla-fail-log-period integer	Time interval in seconds that SLA fail log messages will be generated
sla_pass_log_period aliases: sla-pass-log-period integer	Time interval in seconds that SLA pass log messages will be generated
system_dns aliases: system-dns string	Enable/disable system DNS as the probe server. Choices: "disable" "enable"
threshold_alert_jitter aliases: threshold-alert-jitter integer	Alert threshold for jitter
threshold_alert_latency aliases: threshold-alert-latency integer	Alert threshold for latency
threshold_alert_packetloss aliases: threshold-alert-packetloss integer	Alert threshold for packet loss
threshold_warning_jitter aliases: threshold-warning-jitter integer	Warning threshold for jitter
threshold_warning_latency aliases: threshold-warning-latency integer	Warning threshold for latency
threshold_warning_packetloss aliases: threshold-warning-packetloss integer	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 aliases: update-cascade-interface string	Enable/disable update cascade interface. Choices: "disable" "enable"
update_static_route aliases: update-static-route string	Enable/disable updating the static route. Choices: "disable" "enable"
load_balance_mode aliases: 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 aliases: _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 aliases: ingress-spillover-threshold integer	Ingress spillover threshold for this interface
interface string	Interface name.
priority integer	Priority of the interface
seq_num aliases: 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 aliases: spillover-threshold integer	Egress spillover threshold for this interface
status string	Enable/disable this interface in the SD-WAN. Choices: "disable" "enable"
volume_ratio aliases: volume-ratio integer	Measured volume ratio
weight integer	Weight of this interface for weighted load balancing.
neighbor list / elements=dictionary	Neighbor.
health_check aliases: 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 aliases: sla-id integer	SLA ID.
neighbor_hold_boot_time aliases: 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 aliases: neighbor-hold-down string	Enable/disable hold switching from the secondary neighbor to the primary neighbor. Choices: "disable" "enable"
neighbor_hold_down_time aliases: neighbor-hold-down-time integer	Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled.
service list / elements=dictionary	Service.
addr_mode aliases: addr-mode string	Address mode Choices: "ipv4" "ipv6"
bandwidth_weight aliases: 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 aliases: dscp-forward string	Enable/disable forward traffic DSCP tag. Choices: "disable" "enable"
dscp_forward_tag aliases: dscp-forward-tag string	Forward traffic DSCP tag.
dscp_reverse aliases: dscp-reverse string	Enable/disable reverse traffic DSCP tag. Choices: "disable" "enable"
dscp_reverse_tag aliases: 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 aliases: dst-negate string	Enable/disable negation of destination address match. Choices: "disable" "enable"
end_port aliases: end-port integer	End destination port number.
gateway string	Enable/disable SD-WAN service gateway. Choices: "disable" "enable"
groups any	(list or str) User groups.
health_check aliases: health-check string	Health check.
hold_down_time aliases: hold-down-time integer	Waiting period in seconds when switching from the back-up member to the primary member
id integer	Priority rule ID
input_device aliases: input-device any	(list or str) Source interface name.
input_device_negate aliases: input-device-negate string	Enable/disable negation of input device match. Choices: "disable" "enable"
internet_service aliases: internet-service string	Enable/disable use of Internet service for application-based load balancing. Choices: "disable" "enable"
internet_service_app_ctrl aliases: internet-service-app-ctrl any	(list) Application control based Internet Service ID list.
internet_service_app_ctrl_group aliases: internet-service-app-ctrl-group any	(list or str) Application control based Internet Service group list.
internet_service_ctrl aliases: internet-service-ctrl any	(list) Control-based Internet Service ID list.
internet_service_ctrl_group aliases: internet-service-ctrl-group any	(list or str) Control-based Internet Service group list.
internet_service_custom aliases: internet-service-custom any	(list or str) Custom Internet service name list.
internet_service_custom_group aliases: internet-service-custom-group any	(list or str) Custom Internet Service group list.
internet_service_group aliases: internet-service-group any	(list or str) Internet Service group list.
internet_service_id aliases: internet-service-id any	(list or str) Internet service ID list.
internet_service_name aliases: internet-service-name string	Internet service name list.
jitter_weight aliases: jitter-weight integer	Coefficient of jitter in the formula of custom-profile-1.
latency_weight aliases: latency-weight integer	Coefficient of latency in the formula of custom-profile-1.
link_cost_factor aliases: link-cost-factor string	Link cost factor. Choices: "latency" "jitter" "packet-loss" "inbandwidth" "outbandwidth" "bibandwidth" "custom-profile-1"
link_cost_threshold aliases: link-cost-threshold integer	Percentage threshold change of link cost values that will result in policy route regeneration
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 aliases: packet-loss-weight integer	Coefficient of packet-loss in the formula of custom-profile-1.
priority_members aliases: priority-members any	(list or str) Member sequence number list.
protocol integer	Protocol number.
quality_link aliases: quality-link integer	Quality grade.
role string	Service role to work with neighbor. Choices: "primary" "secondary" "standalone"
route_tag aliases: route-tag integer	IPv4 route map route-tag.
sla list / elements=dictionary	Sla.
health_check aliases: health-check string	Virtual WAN Link health-check.
id integer	SLA ID.
sla_compare_method aliases: sla-compare-method string	Method to compare SLA value for sla and load balance mode. Choices: "order" "number"
src any	(list or str) Source address name.
src6 any	(list or str) Source address6 name.
src_negate aliases: src-negate string	Enable/disable negation of source address match. Choices: "disable" "enable"
standalone_action aliases: standalone-action string	Enable/disable service when selected neighbor role is standalone while service role is not standalone. Choices: "disable" "enable"
start_port aliases: 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 aliases: tos-mask string	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)