fmgr_wanprof_system_virtualwanlink – Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name
,var name
,var.name
New argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- wanprof - The parameter in requested url type: str required: true
- wanprof_system_virtualwanlink - Configure redundant internet connections using SD-WAN type: dict
- fail_detect (Alias name: fail-detect) Enable/disable sd-wan internet connection status checking (failure detection). type: str choices: [disable, enable] more...
- health_check (Alias name: health-check) Health check. type: list
more...
- _dynamic_server (Alias name: _dynamic-server) Dynamic server. type: str more...
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
- failtime Number of failures before server is considered lost (1 - 3600, default = 5). type: int more...
- http_agent (Alias name: http-agent) String in the http-agent field in the http header. type: str more...
- http_get (Alias name: http-get) Url used to communicate with the server if the protocol if the protocol is http. type: str more...
- http_match (Alias name: http-match) Response string expected from the server if the protocol is http. type: str more...
- interval Status check interval, or the time between attempting to connect to the server (1 - 3600 sec, default = 5). type: int more...
- members Member sequence number list. type: list or str more...
- name Status check or health check name. type: str more...
- packet_size (Alias name: packet-size) Packet size of a twamp test session, type: int more...
- password Twamp controller password in authentication mode type: list more...
- port Port number used to communicate with the server over the selected protocol. type: int more...
- protocol Protocol used to determine if the fortigate can communicate with the server. type: str choices: [ping, tcp-echo, udp-echo, http, twamp, ping6, dns] more...
- recoverytime Number of successful responses received before server is considered recovered (1 - 3600, default = 5). type: int more...
- security_mode (Alias name: security-mode) Twamp controller security mode. type: str choices: [none, authentication] more...
- server Ip address or fqdn name of the server. type: list more...
- sla Sla. type: list
more...
- id Sla id. type: int more...
- jitter_threshold (Alias name: jitter-threshold) Jitter for sla to make decision in milliseconds. type: int more...
- latency_threshold (Alias name: latency-threshold) Latency for sla to make decision in milliseconds. type: int more...
- link_cost_factor (Alias name: link-cost-factor) Criteria on which to base link selection. type: list choices: [latency, jitter, packet-loss] more...
- packetloss_threshold (Alias name: packetloss-threshold) Packet loss for sla to make decision in percentage. type: int more...
- threshold_alert_jitter (Alias name: threshold-alert-jitter) Alert threshold for jitter (ms, default = 0). type: int more...
- threshold_alert_latency (Alias name: threshold-alert-latency) Alert threshold for latency (ms, default = 0). type: int more...
- threshold_alert_packetloss (Alias name: threshold-alert-packetloss) Alert threshold for packet loss (percentage, default = 0). type: int more...
- threshold_warning_jitter (Alias name: threshold-warning-jitter) Warning threshold for jitter (ms, default = 0). type: int more...
- threshold_warning_latency (Alias name: threshold-warning-latency) Warning threshold for latency (ms, default = 0). type: int more...
- threshold_warning_packetloss (Alias name: threshold-warning-packetloss) Warning threshold for packet loss (percentage, default = 0). type: int more...
- update_cascade_interface (Alias name: update-cascade-interface) Enable/disable update cascade interface. type: str choices: [disable, enable] more...
- update_static_route (Alias name: update-static-route) Enable/disable updating the static route. type: str choices: [disable, enable] more...
- internet_service_id (Alias name: internet-service-id) Internet service id. type: str more...
- probe_packets (Alias name: probe-packets) Enable/disable transmission of probe packets. type: str choices: [disable, enable] more...
- sla_fail_log_period (Alias name: sla-fail-log-period) Time interval in seconds that sla fail log messages will be generated (0 - 3600, default = 0). type: int more...
- sla_pass_log_period (Alias name: sla-pass-log-period) Time interval in seconds that sla pass log messages will be generated (0 - 3600, default = 0). type: int more...
- timeout How long to wait before not receiving a reply from the server to consider the connetion attempt a failure (1 - 255 sec, default = 1). type: int more...
- ha_priority (Alias name: ha-priority) Ha election priority (1 - 50). type: int more...
- diffservcode Differentiated services code point (dscp) in the ip header of the probe packet. type: str more...
- probe_timeout (Alias name: probe-timeout) Time to wait before a probe packet is considered lost (500 - 5000 msec, default = 500). type: int more...
- dns_request_domain (Alias name: dns-request-domain) Fully qualified domain name to resolve for the dns probe. type: str more...
- probe_count (Alias name: probe-count) Number of most recent probes that should be used to calculate latency and jitter (5 - 30, default = 30). type: int more...
- system_dns (Alias name: system-dns) Enable/disable system dns as the probe server. type: str choices: [disable, enable] more...
- load_balance_mode (Alias name: load-balance-mode) Algorithm or mode to use for load balancing internet traffic to sd-wan members. type: str choices: [source-ip-based, weight-based, usage-based, source-dest-ip-based, measured-volume-based] more...
- members Members. type: list
more...
- _dynamic_member (Alias name: _dynamic-member) Dynamic member. type: str more...
- comment Comments. type: str more...
- gateway The default gateway for this interface. type: str more...
- gateway6 Ipv6 gateway. type: str more...
- ingress_spillover_threshold (Alias name: ingress-spillover-threshold) Ingress spillover threshold for this interface (0 - 16776000 kbit/s). type: int more...
- interface Interface name. type: str more...
- priority Priority of the interface (0 - 4294967295). type: int more...
- seq_num (Alias name: seq-num) Sequence number(1-255). type: int more...
- source Source ip address used in the health-check packet to the server. type: str more...
- source6 Source ipv6 address used in the health-check packet to the server. type: str more...
- spillover_threshold (Alias name: spillover-threshold) Egress spillover threshold for this interface (0 - 16776000 kbit/s). type: int more...
- status Enable/disable this interface in the sd-wan. type: str choices: [disable, enable] more...
- volume_ratio (Alias name: volume-ratio) Measured volume ratio (this value / sum of all values = percentage of link volume, 0 - 255). type: int more...
- weight Weight of this interface for weighted load balancing. type: int more...
- cost Cost of this interface for services in sla mode (0 - 4294967295, default = 0). type: int more...
- service Service. type: list
more...
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
- bandwidth_weight (Alias name: bandwidth-weight) Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. type: int more...
- default Enable/disable use of sd-wan as default service. type: str choices: [disable, enable] more...
- dscp_forward (Alias name: dscp-forward) Enable/disable forward traffic dscp tag. type: str choices: [disable, enable] more...
- dscp_forward_tag (Alias name: dscp-forward-tag) Forward traffic dscp tag. type: str more...
- dscp_reverse (Alias name: dscp-reverse) Enable/disable reverse traffic dscp tag. type: str choices: [disable, enable] more...
- dscp_reverse_tag (Alias name: dscp-reverse-tag) Reverse traffic dscp tag. type: str more...
- dst Destination address name. type: list or str more...
- dst_negate (Alias name: dst-negate) Enable/disable negation of destination address match. type: str choices: [disable, enable] more...
- dst6 Destination address6 name. type: list or str more...
- end_port (Alias name: end-port) End destination port number. type: int more...
- gateway Enable/disable sd-wan service gateway. type: str choices: [disable, enable] more...
- groups User groups. type: list or str more...
- health_check (Alias name: health-check) Health check. type: str more...
- hold_down_time (Alias name: hold-down-time) Waiting period in seconds when switching from the back-up member to the primary member (0 - 10000000, default = 0). type: int more...
- id Priority rule id (1 - 4000). type: int more...
- internet_service (Alias name: internet-service) Enable/disable use of internet service for application-based load balancing. type: str choices: [disable, enable] more...
- internet_service_ctrl (Alias name: internet-service-ctrl) Control-based internet service id list. type: list more...
- internet_service_ctrl_group (Alias name: internet-service-ctrl-group) Control-based internet service group list. type: list or str more...
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name list. type: list or str more...
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group list. type: list or str more...
- internet_service_group (Alias name: internet-service-group) Internet service group list. type: list or str more...
- internet_service_id (Alias name: internet-service-id) Internet service id list. type: list or str more...
- jitter_weight (Alias name: jitter-weight) Coefficient of jitter in the formula of custom-profile-1. type: int more...
- latency_weight (Alias name: latency-weight) Coefficient of latency in the formula of custom-profile-1. type: int more...
- link_cost_factor (Alias name: link-cost-factor) Link cost factor. type: str choices: [latency, jitter, packet-loss, inbandwidth, outbandwidth, bibandwidth, custom-profile-1] more...
- link_cost_threshold (Alias name: link-cost-threshold) Percentage threshold change of link cost values that will result in policy route regeneration (0 - 10000000, default = 10). type: int more...
- member Member sequence number. type: str more...
- mode Control how the priority rule sets the priority of interfaces in the sd-wan. type: str choices: [auto, manual, priority, sla, load-balance] more...
- name Priority rule name. type: str more...
- packet_loss_weight (Alias name: packet-loss-weight) Coefficient of packet-loss in the formula of custom-profile-1. type: int more...
- priority_members (Alias name: priority-members) Member sequence number list. type: list or str more...
- protocol Protocol number. type: int more...
- quality_link (Alias name: quality-link) Quality grade. type: int more...
- route_tag (Alias name: route-tag) Ipv4 route map route-tag. type: int more...
- sla Sla. type: list more...
- src Source address name. type: list or str more...
- src_negate (Alias name: src-negate) Enable/disable negation of source address match. type: str choices: [disable, enable] more...
- src6 Source address6 name. type: list or str more...
- start_port (Alias name: start-port) Start destination port number. type: int more...
- status Enable/disable sd-wan service. type: str choices: [disable, enable] more...
- tos Type of service bit pattern. type: str more...
- tos_mask (Alias name: tos-mask) Type of service evaluated bits. type: str more...
- users User name. type: list or str more...
- internet_service_app_ctrl (Alias name: internet-service-app-ctrl) Application control based internet service id list. type: list more...
- internet_service_app_ctrl_group (Alias name: internet-service-app-ctrl-group) Application control based internet service group list. type: list or str more...
- role Service role to work with neighbor. type: str choices: [primary, secondary, standalone] more...
- sla_compare_method (Alias name: sla-compare-method) Method to compare sla value for sla and load balance mode. type: str choices: [order, number] more...
- standalone_action (Alias name: standalone-action) Enable/disable service when selected neighbor role is standalone while service role is not standalone. type: str choices: [disable, enable] more...
- input_device (Alias name: input-device) Source interface name. type: list or str more...
- internet_service_name (Alias name: internet-service-name) Internet service name list. type: str more...
- input_device_negate (Alias name: input-device-negate) Enable/disable negation of input device match. type: str choices: [disable, enable] more...
- status Enable/disable sd-wan. type: str choices: [disable, enable] more...
- neighbor Neighbor. type: list
more...
- health_check (Alias name: health-check) Sd-wan health-check name. type: str more...
- ip Ip address of neighbor. type: str more...
- member Member sequence number. type: str more...
- role Role of neighbor. type: str choices: [primary, secondary, standalone] more...
- sla_id (Alias name: sla-id) Sla id. type: int more...
- neighbor_hold_boot_time (Alias name: neighbor-hold-boot-time) Waiting period in seconds when switching from the primary neighbor to the secondary neighbor from the neighbor start. type: int more...
- neighbor_hold_down (Alias name: neighbor-hold-down) Enable/disable hold switching from the secondary neighbor to the primary neighbor. type: str choices: [disable, enable] more...
- neighbor_hold_down_time (Alias name: neighbor-hold-down-time) Waiting period in seconds when switching from the secondary neighbor to the primary neighbor when hold-down is disabled. type: int more...
- fail_alert_interfaces (Alias name: fail-alert-interfaces) Physical interfaces that will be alerted. type: list more...
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
- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.