Skip to content

Latest commit

 

History

History
1634 lines (1590 loc) · 56.3 KB

fortios_system_gre_tunnel.rst

File metadata and controls

1634 lines (1590 loc) · 56.3 KB
source

fortios_system_gre_tunnel.py

orphan

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

2.0.0

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

FortiOS Version Compatibility


v6.0.0 v6.0.5 v6.0.11 v6.2.0 v6.2.3 v6.2.5 v6.2.7 v6.4.0 v6.4.1 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.2.0 v7.2.1 v7.2.2
fortios_system_gre_tunnel yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • 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

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>system_gre_tunnel</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">checksum_reception</span> - Enable/disable validating checksums in received GRE packets. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>checksum_reception</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">checksum_transmission</span> - Enable/disable including checksums in transmitted GRE packets. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>checksum_transmission</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">diffservcode</span> - DiffServ setting to be applied to GRE tunnel outer IP header. <span class="li-normal">type: str</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>diffservcode</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">dscp_copying</span> - Enable/disable DSCP copying. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>dscp_copying</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">interface</span> - Interface name. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>interface</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">ip_version</span> - IP version to use for VPN interface. <span class="li-normal">type: str</span> <span class="li-normal">choices: 4, 6</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ip_version</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[4]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[6]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">keepalive_failtimes</span> - Number of consecutive unreturned keepalive messages before a GRE connection is considered down (1 - 255). <span class="li-normal">type: int</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>keepalive_failtimes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">keepalive_interval</span> - Keepalive message interval (0 - 32767, 0 = disabled). <span class="li-normal">type: int</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>keepalive_interval</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">key_inbound</span> - Require received GRE packets contain this key (0 - 4294967295). <span class="li-normal">type: int</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>key_inbound</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">key_outbound</span> - Include this key in transmitted GRE packets (0 - 4294967295). <span class="li-normal">type: int</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>key_outbound</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">local_gw</span> - IP address of the local gateway. <span class="li-normal">type: str</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>local_gw</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">local_gw6</span> - IPv6 address of the local gateway. <span class="li-normal">type: str</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>local_gw6</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Tunnel name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">remote_gw</span> - IP address of the remote gateway. <span class="li-normal">type: str</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>remote_gw</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">remote_gw6</span> - IPv6 address of the remote gateway. <span class="li-normal">type: str</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>remote_gw6</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">sequence_number_reception</span> - Enable/disable validating sequence numbers in received GRE packets. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>sequence_number_reception</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">sequence_number_transmission</span> - Enable/disable including of sequence numbers in transmitted GRE packets. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>sequence_number_transmission</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">use_sdwan</span> - Enable/disable use of SD-WAN to reach remote gateway. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>use_sdwan</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul>

    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"
            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"

    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

    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.