fortios_system_gre_tunnel – Configure GRE tunnel in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_gre_tunnel - Configure GRE tunnel. type: dict
- checksum_reception - Enable/disable validating checksums in received GRE packets. type: str choices: disable, enable
- checksum_transmission - Enable/disable including checksums in transmitted GRE packets. type: str choices: disable, enable
- dscp_copying - Enable/disable DSCP copying. type: str choices: disable, enable
- interface - Interface name. Source system.interface.name. type: str
- ip_version - IP version to use for VPN interface. type: str choices: 4, 6
- keepalive_failtimes - Number of consecutive unreturned keepalive messages before a GRE connection is considered down (1 - 255). type: int
- keepalive_interval - Keepalive message interval (0 - 32767, 0 = disabled). type: int
- key_inbound - Require received GRE packets contain this key (0 - 4294967295). type: int
- key_outbound - Include this key in transmitted GRE packets (0 - 4294967295). type: int
- local_gw - IP address of the local gateway. type: str
- local_gw6 - IPv6 address of the local gateway. type: str
- name - Tunnel name. type: str required: True
- remote_gw - IP address of the remote gateway. type: str
- remote_gw6 - IPv6 address of the remote gateway. type: str
- sequence_number_reception - Enable/disable validating sequence numbers in received GRE packets. type: str choices: disable, enable
- sequence_number_transmission - Enable/disable including of sequence numbers in transmitted GRE packets. type: str choices: disable, enable
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- 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