fortinet.fortios.fortios_system_gre_tunnel – Configure GRE tunnel in Fortinet’s FortiOS and FortiGate.
fortinet.fortios.fortios_system_gre_tunnel – Configure GRE tunnel in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_system_gre_tunnel
.
New in version 2.9: of fortinet.fortios
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.9.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
access_token string |
Token-based authentication. Generated from GUI of Fortigate. | ||
state string / required |
|
Indicates whether to create or remove the object. | |
system_gre_tunnel dictionary |
Configure GRE tunnel. | ||
checksum_reception string |
|
Enable/disable validating checksums in received GRE packets. | |
checksum_transmission string |
|
Enable/disable including checksums in transmitted GRE packets. | |
dscp_copying string |
|
Enable/disable DSCP copying. | |
interface string |
Interface name. Source system.interface.name. | ||
ip_version string |
|
IP version to use for VPN interface. | |
keepalive_failtimes integer |
Number of consecutive unreturned keepalive messages before a GRE connection is considered down (1 - 255). | ||
keepalive_interval integer |
Keepalive message interval (0 - 32767, 0 = disabled). | ||
key_inbound integer |
Require received GRE packets contain this key (0 - 4294967295). | ||
key_outbound integer |
Include this key in transmitted GRE packets (0 - 4294967295). | ||
local_gw string |
IP address of the local gateway. | ||
local_gw6 string |
IPv6 address of the local gateway. | ||
name string / required |
Tunnel name. | ||
remote_gw string |
IP address of the remote gateway. | ||
remote_gw6 string |
IPv6 address of the remote gateway. | ||
sequence_number_reception string |
|
Enable/disable validating sequence numbers in received GRE packets. | |
sequence_number_transmission string |
|
Enable/disable including of sequence numbers in transmitted GRE packets. | |
vdom string |
Default: "root" |
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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure GRE tunnel.
fortios_system_gre_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_gre_tunnel:
checksum_reception: "disable"
checksum_transmission: "disable"
dscp_copying: "disable"
interface: "<your_own_value> (source system.interface.name)"
ip_version: "4"
keepalive_failtimes: "8"
keepalive_interval: "9"
key_inbound: "10"
key_outbound: "11"
local_gw: "<your_own_value>"
local_gw6: "<your_own_value>"
name: "default_name_14"
remote_gw: "<your_own_value>"
remote_gw6: "<your_own_value>"
sequence_number_reception: "disable"
sequence_number_transmission: "disable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string |
always |
Build number of the fortigate image
Sample: 1547 |
http_method string |
always |
Last method used to provision the content into FortiGate
Sample: PUT |
http_status string |
always |
Last result given by FortiGate on last operation applied
Sample: 200 |
mkey string |
success |
Master key (id) used in the last call to FortiGate
Sample: id |
name string |
always |
Name of the table used to fulfill the request
Sample: urlfilter |
path string |
always |
Path of the table used to fulfill the request
Sample: webfilter |
revision string |
always |
Internal revision number
Sample: 17.0.2.10658 |
serial string |
always |
Serial number of the unit
Sample: FGVMEVYYQT3AB5352 |
status string |
always |
Indication of the operation's result
Sample: success |
vdom string |
always |
Virtual domain used
Sample: root |
version string |
always |
Version of the FortiGate
Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_system_gre_tunnel_module.html