fortinet.fortimanager.fmgr_wanprof_system_sdwan_service module – Create SD-WAN rules
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_service.
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The parameter (wanprof) in requested url. |
|
The top level parameters set. |
|
Address mode Choices:
|
|
Set/unset the service as agent use exclusively. Choices:
|
|
Coefficient of reciprocal of available bidirectional bandwidth in the formula of custom-profile-1. |
|
Comments. |
|
Enable/disable use of SD-WAN as default service. Choices:
|
|
Enable/disable forward traffic DSCP tag. Choices:
|
|
Forward traffic DSCP tag. |
|
Enable/disable reverse traffic DSCP tag. Choices:
|
|
Reverse traffic DSCP tag. |
|
(list or str) Destination address name. |
|
(list or str) Destination address6 name. |
|
Enable/disable negation of destination address match. Choices:
|
|
End destination port number. |
|
End source port number. |
|
Enable/disable SD-WAN service gateway. Choices:
|
|
(list or str) User groups. |
|
Hash algorithm for selected priority members for load balance mode. Choices:
|
|
(list or str) Health check list. |
|
Waiting period in seconds when switching from the back-up member to the primary member |
|
SD-WAN rule ID |
|
(list or str) Source interface name. |
|
Enable/disable negation of input device match. Choices:
|
|
(list) Source input-zone name. |
|
Enable/disable use of Internet service for application-based load balancing. Choices:
|
|
(list) Application control based Internet Service ID list. |
|
(list) IDs of one or more application control categories. |
|
(list or str) Application control based Internet Service group list. |
|
(list or str) Custom Internet service name list. |
|
(list or str) Custom Internet Service group list. |
|
(list or str) Internet Service group list. |
|
(list or str) Internet service name list. |
|
Coefficient of jitter in the formula of custom-profile-1. |
|
Coefficient of latency in the formula of custom-profile-1. |
|
Link cost factor. Choices:
|
|
Percentage threshold change of link cost values that will result in policy route regeneration |
|
Enable/disable load-balance. Choices:
|
|
Minimum number of members which meet SLA. |
|
Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN. Choices:
|
|
SD-WAN rule name. |
|
Coefficient of packet-loss in the formula of custom-profile-1. |
|
Enable/disable passive measurement based on the service criteria. Choices:
|
|
(list or str) Member sequence number list. |
|
(list or str) Priority zone name list. |
|
Protocol number. |
|
Quality grade. |
|
Service role to work with neighbor. Choices:
|
|
IPv4 route map route-tag. |
|
Enable/disable shortcut for this service. Choices:
|
|
High priority of ADVPN shortcut for this service. Choices:
|
|
Enable/disable shortcut-stickiness of ADVPN. Choices:
|
|
Sla. |
|
SD-WAN health-check. |
|
SLA ID. |
|
Method to compare SLA value for SLA mode. Choices:
|
|
Enable/disable SLA stickiness Choices:
|
|
(list or str) Source address name. |
|
(list or str) Source address6 name. |
|
Enable/disable negation of source address match. Choices:
|
|
Enable/disable service when selected neighbor role is standalone while service role is not standalone. Choices:
|
|
Start destination port number. |
|
Start source port number. |
|
Enable/disable SD-WAN service. Choices:
|
|
Method of selecting member if more than one meets the SLA. Choices:
|
|
Type of service bit pattern. |
|
Type of service evaluated bits. |
|
Enable/disable use of ADVPN shortcut for quality comparison. Choices:
|
|
(list or str) User name. |
|
Enable/disable zone mode. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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.
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: Create SD-WAN rules
fortinet.fortimanager.fmgr_wanprof_system_sdwan_service:
# 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>
state: present # <value in [present, absent]>
wanprof_system_sdwan_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>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |