fortinet.fortimanager.fmgr_wanprof_system_sdwan_service module – Create SD-WAN rules

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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

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.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

wanprof

string / required

The parameter (wanprof) in requested url.

wanprof_system_sdwan_service

dictionary

The top level parameters set.

addr-mode

string

Deprecated, please rename it to addr_mode. Address mode

Choices:

  • "ipv4"

  • "ipv6"

agent-exclusive

string

Deprecated, please rename it to agent_exclusive. Set/unset the service as agent use exclusively.

Choices:

  • "disable"

  • "enable"

bandwidth-weight

integer

Deprecated, please rename it to bandwidth_weight. Coefficient of reciprocal of available bidirectional bandwidth in the fo…

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.

end-src-port

integer

Deprecated, please rename it to end_src_port. End source port number.

gateway

string

Enable/disable SD-WAN service gateway.

Choices:

  • "disable"

  • "enable"

groups

any

(list or str) User groups.

hash-mode

string

Deprecated, please rename it to hash_mode. Hash algorithm for selected priority members for load balance mode.

Choices:

  • "round-robin"

  • "source-ip-based"

  • "source-dest-ip-based"

  • "inbandwidth"

  • "outbandwidth"

  • "bibandwidth"

health-check

any

(list or str) Deprecated, please rename it to health_check. Health check list.

hold-down-time

integer

Deprecated, please rename it to hold_down_time. Waiting period in seconds when switching from the back-up member to the pr…

id

integer / required

SD-WAN 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"

input-zone

any

(list) Deprecated, please rename it to input_zone.

internet-service

string

Deprecated, please rename it to internet_service. Enable/disable use of Internet service for application-based load balancing.

Choices:

  • "disable"

  • "enable"

internet-service-app-ctrl

any

(list) Deprecated, please rename it to internet_service_app_ctrl.

internet-service-app-ctrl-category

any

(list) Deprecated, please rename it to internet_service_app_ctrl_category.

internet-service-app-ctrl-group

any

(list or str) Deprecated, please rename it to internet_service_app_ctrl_group. Application control based Internet Service …

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-name

any

(list or str) 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.

string

Deprecated, please rename it to link_cost_factor. Link cost factor.

Choices:

  • "latency"

  • "jitter"

  • "packet-loss"

  • "inbandwidth"

  • "outbandwidth"

  • "bibandwidth"

  • "custom-profile-1"

integer

Deprecated, please rename it to link_cost_threshold. Percentage threshold change of link cost values that will result in p…

load-balance

string

Deprecated, please rename it to load_balance. Enable/disable load-balance.

Choices:

  • "disable"

  • "enable"

minimum-sla-meet-members

integer

Deprecated, please rename it to minimum_sla_meet_members. Minimum number of members which meet SLA.

mode

string

Control how the SD-WAN rule sets the priority of interfaces in the SD-WAN.

Choices:

  • "auto"

  • "manual"

  • "priority"

  • "sla"

  • "load-balance"

name

string

SD-WAN 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.

passive-measurement

string

Deprecated, please rename it to passive_measurement. Enable/disable passive measurement based on the service criteria.

Choices:

  • "disable"

  • "enable"

priority-members

any

(list or str) Deprecated, please rename it to priority_members. Member sequence number list.

priority-zone

any

(list or str) Deprecated, please rename it to priority_zone.

protocol

integer

Protocol number.

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.

shortcut

string

Enable/disable shortcut for this service.

Choices:

  • "disable"

  • "enable"

shortcut-priority

string

Deprecated, please rename it to shortcut_priority. High priority of ADVPN shortcut for this service.

Choices:

  • "disable"

  • "enable"

  • "auto"

shortcut-stickiness

string

Deprecated, please rename it to shortcut_stickiness. Enable/disable shortcut-stickiness of ADVPN.

Choices:

  • "disable"

  • "enable"

sla

list / elements=dictionary

No description.

health-check

string

Deprecated, please rename it to health_check. SD-WAN 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 mode.

Choices:

  • "order"

  • "number"

sla-stickiness

string

Deprecated, please rename it to sla_stickiness. Enable/disable SLA stickiness

Choices:

  • "disable"

  • "enable"

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 standalone while …

Choices:

  • "disable"

  • "enable"

start-port

integer

Deprecated, please rename it to start_port. Start destination port number.

start-src-port

integer

Deprecated, please rename it to start_src_port. Start source port number.

status

string

Enable/disable SD-WAN service.

Choices:

  • "disable"

  • "enable"

tie-break

string

Deprecated, please rename it to tie_break. Method of selecting member if more than one meets the SLA.

Choices:

  • "zone"

  • "cfg-order"

  • "fib-best-match"

  • "input-device"

tos

string

Type of service bit pattern.

tos-mask

string

Deprecated, please rename it to tos_mask. Type of service evaluated bits.

use-shortcut-sla

string

Deprecated, please rename it to use_shortcut_sla. Enable/disable use of ADVPN shortcut for quality comparison.

Choices:

  • "disable"

  • "enable"

users

any

(list or str) User name.

zone-mode

string

Deprecated, please rename it to zone_mode. Enable/disable zone mode.

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.

  • 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]>

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)