fortinet.fortimanager.fmgr_wanprof_system_sdwan_members – FortiGate interfaces added to the SD-WAN.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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_members.
New in version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | Comments | |
|---|---|---|---|
| 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
|
|
| enable_log
boolean
|
|
Enable/Disable logging for task
|
|
| proposed_method
string
|
|
The overridden method for the underlying Json RPC request
|
|
| rc_failed
list / elements=string
|
the rc codes list with which the conditions to fail will be overriden
|
||
| rc_succeeded
list / elements=string
|
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
|
|
| wanprof
string / required
|
the parameter (wanprof) in requested url
|
||
| wanprof_system_sdwan_members
dictionary
|
the top level parameters set
|
||
| _dynamic-member
string
|
no description
|
||
| comment
string
|
Comments.
|
||
| cost
integer
|
Cost of this interface for services in SLA mode (0 - 4294967295, default = 0).
|
||
| gateway
string
|
The default gateway for this interface. Usually the default gateway of the Internet service provider that this interface is co...
|
||
| gateway6
string
|
IPv6 gateway.
|
||
| ingress-spillover-threshold
integer
|
Ingress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessi...
|
||
| interface
string
|
Interface name.
|
||
| priority
integer
|
Priority of the interface (0 - 65535). Used for SD-WAN rules or priority rules.
|
||
| priority6
integer
|
Priority of the interface for IPv6 (1 - 65535, default = 1024). Used for SD-WAN rules or priority rules.
|
||
| seq-num
integer
|
Sequence number(1-512).
|
||
| 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
integer
|
Egress spillover threshold for this interface (0 - 16776000 kbit/s). When this traffic volume threshold is reached, new sessio...
|
||
| status
string
|
|
Enable/disable this interface in the SD-WAN.
|
|
| volume-ratio
integer
|
Measured volume ratio (this value / sum of all values = percentage of link volume, 1 - 255).
|
||
| weight
integer
|
Weight of this interface for weighted load balancing. (1 - 255) More traffic is directed to interfaces with higher weights.
|
||
| zone
string
|
Zone name.
|
||
| 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
|
Default:
300
|
the maximum time in seconds to wait for other user to release the workspace lock
|
|
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
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: FortiGate interfaces added to the SD-WAN.
fmgr_wanprof_system_sdwan_members:
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: <value in [present, absent]>
wanprof_system_sdwan_members:
_dynamic-member: <value of string>
comment: <value of string>
cost: <value of integer>
gateway: <value of string>
gateway6: <value of string>
ingress-spillover-threshold: <value of integer>
interface: <value of string>
priority: <value of integer>
seq-num: <value of integer>
source: <value of string>
source6: <value of string>
spillover-threshold: <value of integer>
status: <value in [disable, enable]>
volume-ratio: <value of integer>
weight: <value of integer>
zone: <value of string>
priority6: <value of integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url
string
|
always |
The full url requested
Sample:
/sys/login/user
|
| response_code
integer
|
always |
The status of api request
|
| response_message
string
|
always |
The descriptive message of the api response
Sample:
OK.
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_wanprof_system_sdwan_members_module.html