fmgd_system_sdwan_service – Create SD-WAN rules (also called services) to control how sessions are distributed to interfaces in the SD-WAN.
Added in version 1.0.0.
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-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> 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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- 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
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- system_sdwan_service - Create SD-WAN rules type: dict
- addr_mode (Alias name: addr-mode) Address mode (ipv4 or ipv6). type: str choices: [ipv4, ipv6] more...
- agent_exclusive (Alias name: agent-exclusive) Set/unset the service as agent use exclusively. type: str choices: [disable, enable] 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 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 more...
- end_port (Alias name: end-port) End destination port number. type: int more...
- end_src_port (Alias name: end-src-port) End source port number. type: int more...
- gateway Enable/disable sd-wan service gateway. type: str choices: [disable, enable] more...
- groups User groups. type: list more...
- hash_mode (Alias name: hash-mode) Hash algorithm for selected priority members for load balance mode. type: str choices: [round-robin, source-ip-based, source-dest-ip-based, inbandwidth, outbandwidth, bibandwidth] more...
- health_check (Alias name: health-check) Health check list. type: list 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 Sd-wan rule id (1 - 4000). type: int more...
- input_device (Alias name: input-device) Source interface name. type: list more...
- input_device_negate (Alias name: input-device-negate) Enable/disable negation of input device match. type: str choices: [disable, enable] more...
- input_zone (Alias name: input-zone) Source input-zone name. type: list 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_app_ctrl (Alias name: internet-service-app-ctrl) Application control based internet service id list. type: list more...
- internet_service_app_ctrl_category (Alias name: internet-service-app-ctrl-category) Ids of one or more application control categories. type: list more...
- internet_service_app_ctrl_group (Alias name: internet-service-app-ctrl-group) Application control based internet service group list. type: list more...
- internet_service_custom (Alias name: internet-service-custom) Custom internet service name list. type: list more...
- internet_service_custom_group (Alias name: internet-service-custom-group) Custom internet service group list. type: list more...
- internet_service_group (Alias name: internet-service-group) Internet service group list. type: list more...
- internet_service_name (Alias name: internet-service-name) Internet service name list. type: list 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...
- load_balance (Alias name: load-balance) Enable/disable load-balance. type: str choices: [disable, enable] more...
- minimum_sla_meet_members (Alias name: minimum-sla-meet-members) Minimum number of members which meet sla. type: int more...
- mode Control how the sd-wan rule sets the priority of interfaces in the sd-wan. type: str choices: [auto, manual, priority, sla, load-balance] more...
- name Sd-wan 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...
- passive_measurement (Alias name: passive-measurement) Enable/disable passive measurement based on the service criteria. type: str choices: [disable, enable] more...
- priority_members (Alias name: priority-members) Member sequence number list. type: list more...
- priority_zone (Alias name: priority-zone) Priority zone name list. type: list more...
- protocol Protocol number. type: int more...
- quality_link (Alias name: quality-link) Quality grade. type: int more...
- role Service role to work with neighbor. type: str choices: [primary, secondary, standalone] more...
- shortcut Enable/disable shortcut for this service. type: str choices: [disable, enable] more...
- shortcut_priority (Alias name: shortcut-priority) High priority of advpn shortcut for this service. type: str choices: [disable, enable, auto] more...
- sla Sla. type: list more...
- sla_compare_method (Alias name: sla-compare-method) Method to compare sla value for sla mode. type: str choices: [order, number] more...
- sla_stickiness (Alias name: sla-stickiness) Enable/disable sla stickiness (default = disable). type: str choices: [disable, enable] more...
- src Source address name. type: list 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 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...
- start_port (Alias name: start-port) Start destination port number. type: int more...
- start_src_port (Alias name: start-src-port) Start source port number. type: int more...
- status Enable/disable sd-wan service. type: str choices: [disable, enable] more...
- tie_break (Alias name: tie-break) Method of selecting member if more than one meets the sla. type: str choices: [zone, cfg-order, fib-best-match, input-device, priority] more...
- tos Type of service bit pattern. type: str more...
- tos_mask (Alias name: tos-mask) Type of service evaluated bits. type: str more...
- use_shortcut_sla (Alias name: use-shortcut-sla) Enable/disable use of advpn shortcut for quality comparison. type: str choices: [disable, enable] more...
- users User name. type: list more...
- zone_mode (Alias name: zone-mode) Enable/disable zone mode. type: str choices: [disable, enable] more...
- route_tag (Alias name: route-tag) Ipv4 route map route-tag. type: int more...
- comment Comments. type: str more...
- fib_best_match_force (Alias name: fib-best-match-force) Enable/disable force using fib-best-match oif as outgoing interface. type: str choices: [disable, enable] more...
- internet_service_fortiguard (Alias name: internet-service-fortiguard) Fortiguard internet service name list. 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
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Create SD-WAN rules
fortinet.fmgdevice.fmgd_system_sdwan_service:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
state: present # <value in [present, absent]>
system_sdwan_service:
id: 0 # Required variable, integer
# addr_mode: <value in [ipv4, ipv6]>
# agent_exclusive: <value in [disable, enable]>
# 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>
# end_src_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>
# input_device: <list or string>
# input_device_negate: <value in [disable, enable]>
# input_zone: <list or string>
# internet_service: <value in [disable, enable]>
# internet_service_app_ctrl: <list or integer>
# internet_service_app_ctrl_category: <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>
# load_balance: <value in [disable, enable]>
# minimum_sla_meet_members: <integer>
# mode: <value in [auto, manual, priority, ...]>
# name: <string>
# packet_loss_weight: <integer>
# passive_measurement: <value in [disable, enable]>
# priority_members: <list or string>
# priority_zone: <list or string>
# protocol: <integer>
# quality_link: <integer>
# role: <value in [primary, secondary, standalone]>
# shortcut: <value in [disable, enable]>
# shortcut_priority: <value in [disable, enable, auto]>
# sla:
# - health_check: <list or string>
# id: <integer>
# sla_compare_method: <value in [order, number]>
# sla_stickiness: <value in [disable, enable]>
# src: <list or string>
# src_negate: <value in [disable, enable]>
# src6: <list or string>
# standalone_action: <value in [disable, enable]>
# start_port: <integer>
# start_src_port: <integer>
# status: <value in [disable, enable]>
# tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
# tos: <string>
# tos_mask: <string>
# use_shortcut_sla: <value in [disable, enable]>
# users: <list or string>
# zone_mode: <value in [disable, enable]>
# route_tag: <integer>
# comment: <string>
# fib_best_match_force: <value in [disable, enable]>
# internet_service_fortiguard: <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.