fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_wanprof_system_sdwan_members FortiGate interfaces added to the SD-WAN. | "added in version" 2.1.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_wanprof_system_sdwan_members (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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: FortiGate interfaces added to the SD-WAN. fortinet.fortimanager.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: present # <value in [present, absent]> wanprof_system_sdwan_members: _dynamic_member: <string> comment: <string> cost: <integer> 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> zone: <string> priority6: <integer> preferred_source: <string> transport_group: <integer>
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str wanprof: description: The parameter (wanprof) in requested url. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int wanprof_system_sdwan_members: description: The top level parameters set. required: false suboptions: _dynamic-member: description: Deprecated, please rename it to _dynamic_member. type: str comment: description: Comments. type: str cost: description: Cost of this interface for services in SLA mode type: int gateway: description: The default gateway for this interface. type: str gateway6: description: IPv6 gateway. type: str ingress-spillover-threshold: description: Deprecated, please rename it to ingress_spillover_threshold. Ingress spillover threshold for this interface type: int interface: description: Interface name. type: str preferred-source: description: Deprecated, please rename it to preferred_source. Preferred source of route for this member. type: str priority: description: Priority of the interface type: int priority6: description: Priority of the interface for IPv6 type: int seq-num: description: Deprecated, please rename it to seq_num. Sequence number type: int source: description: Source IP address used in the health-check packet to the server. type: str source6: description: Source IPv6 address used in the health-check packet to the server. type: str spillover-threshold: description: Deprecated, please rename it to spillover_threshold. Egress spillover threshold for this interface type: int status: choices: - disable - enable description: Enable/disable this interface in the SD-WAN. type: str transport-group: description: Deprecated, please rename it to transport_group. Measured transport group type: int volume-ratio: description: Deprecated, please rename it to volume_ratio. Measured volume ratio type: int weight: description: Weight of this interface for weighted load balancing. type: int zone: description: Zone name. type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list