:source: fortios_system_gre_tunnel.py
:orphan:
.. fortios_system_gre_tunnel:
fortios_system_gre_tunnel -- Configure GRE tunnel in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and gre_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_gre_tunnel - Configure GRE tunnel. type: dict
more...
| Supported Version Ranges |
| system_gre_tunnel |
v6.0.0 -> 7.6.6 |
- auto_asic_offload - Enable/disable automatic ASIC offloading. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_asic_offload |
v7.4.2 -> v7.4.2 |
| [enable] |
v7.4.2 -> v7.4.2 |
| [disable] |
v7.4.2 -> v7.4.2 |
- checksum_reception - Enable/disable validating checksums in received GRE packets. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| checksum_reception |
v6.4.0 -> v6.4.0 |
v7.2.0 -> v7.2.0 |
v7.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
- checksum_transmission - Enable/disable including checksums in transmitted GRE packets. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| checksum_transmission |
v6.4.0 -> v6.4.0 |
v7.2.0 -> v7.2.0 |
v7.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
- diffservcode - DiffServ setting to be applied to GRE tunnel outer IP header. type: str
more...
|
Supported Version Ranges |
| diffservcode |
v6.2.0 -> 7.6.6 |
- dscp_copying - Enable/disable DSCP copying. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| dscp_copying |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- interface - Interface name. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| interface |
v6.0.0 -> 7.6.6 |
- ip_version - IP version to use for VPN interface. type: str choices: 4, 6
more...
|
Supported Version Ranges |
| ip_version |
v6.0.0 -> 7.6.6 |
| [4] |
v6.0.0 -> 7.6.6 |
| [6] |
v6.0.0 -> 7.6.6 |
- keepalive_failtimes - Number of consecutive unreturned keepalive messages before a GRE connection is considered down (1 - 255). type: int
more...
|
Supported Version Ranges |
| keepalive_failtimes |
v6.0.0 -> 7.6.6 |
- keepalive_interval - Keepalive message interval (0 - 32767, 0 = disabled). type: int
more...
|
Supported Version Ranges |
| keepalive_interval |
v6.0.0 -> 7.6.6 |
- key_inbound - Require received GRE packets contain this key (0 - 4294967295). type: int
more...
|
Supported Version Ranges |
| key_inbound |
v6.4.0 -> v6.4.0 |
v7.2.0 -> v7.2.0 |
v7.4.0 -> 7.6.6 |
- key_outbound - Include this key in transmitted GRE packets (0 - 4294967295). type: int
more...
|
Supported Version Ranges |
| key_outbound |
v6.4.0 -> v6.4.0 |
v7.2.0 -> v7.2.0 |
v7.4.0 -> 7.6.6 |
- local_gw - IP address of the local gateway. type: str
more...
|
Supported Version Ranges |
| local_gw |
v6.0.0 -> 7.6.6 |
- local_gw6 - IPv6 address of the local gateway. type: str
more...
|
Supported Version Ranges |
| local_gw6 |
v6.0.0 -> 7.6.6 |
- name - Tunnel name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- remote_gw - IP address of the remote gateway. type: str
more...
|
Supported Version Ranges |
| remote_gw |
v6.0.0 -> 7.6.6 |
- remote_gw6 - IPv6 address of the remote gateway. type: str
more...
|
Supported Version Ranges |
| remote_gw6 |
v6.0.0 -> 7.6.6 |
- sequence_number_reception - Enable/disable validating sequence numbers in received GRE packets. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| sequence_number_reception |
v6.4.0 -> v6.4.0 |
v7.2.0 -> v7.2.0 |
v7.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
- sequence_number_transmission - Enable/disable including of sequence numbers in transmitted GRE packets. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| sequence_number_transmission |
v6.4.0 -> v6.4.0 |
v7.2.0 -> v7.2.0 |
v7.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> v6.4.0 |
v7.0.0 -> v7.2.2 |
v7.4.0 -> 7.6.6 |
- use_sdwan - Enable/disable use of SD-WAN to reach remote gateway. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| use_sdwan |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure GRE tunnel.
fortinet.fortios.fortios_system_gre_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
system_gre_tunnel:
auto_asic_offload: "enable"
checksum_reception: "disable"
checksum_transmission: "disable"
diffservcode: ""
dscp_copying: "disable"
interface: " (source system.interface.name)"
ip_version: "4"
keepalive_failtimes: "10"
keepalive_interval: "0"
key_inbound: "0"
key_outbound: "0"
local_gw: ""
local_gw6: ""
name: "default_name_16"
remote_gw: ""
remote_gw6: ""
sequence_number_reception: "disable"
sequence_number_transmission: "disable"
use_sdwan: "disable"
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:
.. raw:: html
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.