Skip to content

Latest commit

 

History

History
507 lines (463 loc) · 22.3 KB

fortios_system_gre_tunnel.rst

File metadata and controls

507 lines (463 loc) · 22.3 KB
source:fortios_system_gre_tunnel.py
orphan:

fortios_system_gre_tunnel -- Configure GRE tunnel in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

  • 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

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Using member operation to add an element to an existing object.


Supported Version Ranges
fortios_system_gre_tunnel v6.0.0 -> latest

  • 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 -> latest
    • 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 -> latest
      [disable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
      [enable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
    • 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 -> latest
      [disable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
      [enable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
    • diffservcode - DiffServ setting to be applied to GRE tunnel outer IP header. type: str more...
      Supported Version Ranges
      diffservcode v6.2.0 -> latest
    • dscp_copying - Enable/disable DSCP copying. type: str choices: disable, enable more...
      Supported Version Ranges
      dscp_copying v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • interface - Interface name. Source system.interface.name. type: str more...
      Supported Version Ranges
      interface v6.0.0 -> latest
    • ip_version - IP version to use for VPN interface. type: str choices: 4, 6 more...
      Supported Version Ranges
      ip_version v6.0.0 -> latest
      [4] v6.0.0 -> latest
      [6] v6.0.0 -> latest
    • 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 -> latest
    • keepalive_interval - Keepalive message interval (0 - 32767, 0 = disabled). type: int more...
      Supported Version Ranges
      keepalive_interval v6.0.0 -> latest
    • 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 -> latest
    • 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 -> latest
    • local_gw - IP address of the local gateway. type: str more...
      Supported Version Ranges
      local_gw v6.0.0 -> latest
    • local_gw6 - IPv6 address of the local gateway. type: str more...
      Supported Version Ranges
      local_gw6 v6.0.0 -> latest
    • name - Tunnel name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • remote_gw - IP address of the remote gateway. type: str more...
      Supported Version Ranges
      remote_gw v6.0.0 -> latest
    • remote_gw6 - IPv6 address of the remote gateway. type: str more...
      Supported Version Ranges
      remote_gw6 v6.0.0 -> latest
    • 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 -> latest
      [disable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
      [enable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
    • 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 -> latest
      [disable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
      [enable] v6.4.0 -> v6.4.0 v7.0.0 -> v7.2.2 v7.4.0 -> latest
    • 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 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure GRE tunnel.
  fortinet.fortios.fortios_system_gre_tunnel:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_gre_tunnel:
          checksum_reception: "disable"
          checksum_transmission: "disable"
          diffservcode: "<your_own_value>"
          dscp_copying: "disable"
          interface: "<your_own_value> (source system.interface.name)"
          ip_version: "4"
          keepalive_failtimes: "10"
          keepalive_interval: "0"
          key_inbound: "0"
          key_outbound: "0"
          local_gw: "<your_own_value>"
          local_gw6: "<your_own_value>"
          name: "default_name_15"
          remote_gw: "<your_own_value>"
          remote_gw6: "<your_own_value>"
          sequence_number_reception: "disable"
          sequence_number_transmission: "disable"
          use_sdwan: "disable"

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
  • This module is not guaranteed to have a backwards compatible interface.
  • 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.