- source
fortios_vpn_ocvpn.py
- orphan
2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn feature and ocvpn 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.15
Using member operation to add an element to an existing object.
Supported Version Ranges: v6.0.0 -> v7.2.4
- 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
- vpn_ocvpn - Configure Overlay Controller VPN settings. 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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>vpn_ocvpn</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auto_discovery</span> - Enable/disable auto-discovery shortcuts. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auto_discovery</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">auto_discovery_shortcut_mode</span> - Control deletion of child short-cut tunnels when the parent tunnel goes down. <span class="li-normal">type: str</span> <span class="li-normal">choices: independent, dependent</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auto_discovery_shortcut_mode</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.2.4 </code></td> </tr> <tr> <td>[independent]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.2.4</code></td> <tr> <td>[dependent]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">eap</span> - Enable/disable EAP client authentication. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>eap</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">eap_users</span> - EAP authentication user group. Source user.group.name. <span class="li-normal">type: str</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>eap_users</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">forticlient_access</span> - Configure FortiClient settings. <span class="li-normal">type: dict</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>forticlient_access</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auth_groups</span> - FortiClient user authentication groups. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_access/auth_groups:name</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auth_groups</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auth_group</span> - Authentication user group for FortiClient access. Source user.group.name. <span class="li-normal">type: str</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auth_group</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Group name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">overlays</span> - OCVPN overlays to allow access to. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: forticlient_access/auth_groups:name/overlays:overlay_name</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>overlays</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">overlay_name</span> - Overlay name. Source vpn.ocvpn.overlays.overlay-name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>overlay_name</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> </ul> </ul> <li> <span class="li-head">psksecret</span> - Pre-shared secret for FortiClient PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>psksecret</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">status</span> - Enable/disable FortiClient to access OCVPN networks. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>status</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> </table> </div> </li> </ul> <li> <span class="li-head">ha_alias</span> - Hidden HA alias. <span class="li-normal">type: str</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 colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ha_alias</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ip_allocation_block</span> - Class B subnet reserved for private IP address assignment. <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ip_allocation_block</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">multipath</span> - Enable/disable multipath redundancy. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>multipath</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">nat</span> - Enable/disable NAT support. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nat</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">overlays</span> - Network overlays to register with Overlay Controller VPN service. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: overlays:overlay_name</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>overlays</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">assign_ip</span> - Enable/disable mode-cfg address assignment. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>assign_ip</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0</code></td> </table> </div> </li> <li> <span class="li-head">id</span> - ID. <span class="li-normal">type: int</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.7 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">inter_overlay</span> - Allow or deny traffic from other overlays. <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>inter_overlay</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">ipv4_end_ip</span> - End of IPv4 range. <span class="li-normal">type: str</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ipv4_end_ip</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ipv4_start_ip</span> - Start of IPv4 range. <span class="li-normal">type: str</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ipv4_start_ip</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.0.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Overlay name. <span class="li-normal">type: str</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.7 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">overlay_name</span> - Overlay name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>overlay_name</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">subnets</span> - Internal subnets to register with OCVPN service. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: overlays:overlay_name/subnets:id</span> <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a> <div id="label51" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>subnets</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a> <div id="label53" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">interface</span> - LAN interface. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a> <div id="label55" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>interface</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">subnet</span> - IPv4 address and subnet mask. <span class="li-normal">type: str</span> <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a> <div id="label57" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>subnet</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">type</span> - Subnet type. <span class="li-normal">type: str</span> <span class="li-normal">choices: subnet, interface</span> <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a> <div id="label59" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>type</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> <tr> <td>[subnet]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> <tr> <td>[interface]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> </table> </div> </li> </ul> </ul> <li> <span class="li-head">poll_interval</span> - Overlay Controller VPN polling interval. <span class="li-normal">type: int</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>poll_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">role</span> - Set device role. <span class="li-normal">type: str</span> <span class="li-normal">choices: spoke, primary-hub, secondary-hub</span> <a id='label62' href="javascript:ContentClick('label63', 'label62');" onmouseover="ContentPreview('label63');" onmouseout="ContentUnpreview('label63');" title="click to collapse or expand..."> more... </a> <div id="label63" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>role</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4 </code></td> </tr> <tr> <td>[spoke]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> <tr> <td>[primary-hub]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> <tr> <td>[secondary-hub]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">sdwan</span> - Enable/disable adding OCVPN tunnels to SD-WAN. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label64' href="javascript:ContentClick('label65', 'label64');" onmouseover="ContentPreview('label65');" onmouseout="ContentUnpreview('label65');" title="click to collapse or expand..."> more... </a> <div id="label65" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sdwan</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">sdwan_zone</span> - Set SD-WAN zone. Source system.sdwan.zone.name. <span class="li-normal">type: str</span> <a id='label66' href="javascript:ContentClick('label67', 'label66');" onmouseover="ContentPreview('label67');" onmouseout="ContentUnpreview('label67');" title="click to collapse or expand..."> more... </a> <div id="label67" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sdwan_zone</td> <td><code class="docutils literal notranslate">v7.0.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">status</span> - Enable/disable Overlay Controller cloud assisted VPN. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label68' href="javascript:ContentClick('label69', 'label68');" onmouseover="ContentPreview('label69');" onmouseout="ContentUnpreview('label69');" title="click to collapse or expand..."> more... </a> <div id="label69" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>status</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4</code></td> </table> </div> </li> <li> <span class="li-head">subnets</span> - Internal subnets to register with Overlay Controller VPN service. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: subnets:id</span> <a id='label70' href="javascript:ContentClick('label71', 'label70');" onmouseover="ContentPreview('label71');" onmouseout="ContentUnpreview('label71');" title="click to collapse or expand..."> more... </a> <div id="label71" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>subnets</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label72' href="javascript:ContentClick('label73', 'label72');" onmouseover="ContentPreview('label73');" onmouseout="ContentUnpreview('label73');" title="click to collapse or expand..."> more... </a> <div id="label73" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">interface</span> - LAN interface. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label74' href="javascript:ContentClick('label75', 'label74');" onmouseover="ContentPreview('label75');" onmouseout="ContentUnpreview('label75');" title="click to collapse or expand..."> more... </a> <div id="label75" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>interface</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">subnet</span> - IPv4 address and subnet mask. <span class="li-normal">type: str</span> <a id='label76' href="javascript:ContentClick('label77', 'label76');" onmouseover="ContentPreview('label77');" onmouseout="ContentUnpreview('label77');" title="click to collapse or expand..."> more... </a> <div id="label77" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>subnet</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">type</span> - Subnet type. <span class="li-normal">type: str</span> <span class="li-normal">choices: subnet, interface</span> <a id='label78' href="javascript:ContentClick('label79', 'label78');" onmouseover="ContentPreview('label79');" onmouseout="ContentUnpreview('label79');" title="click to collapse or expand..."> more... </a> <div id="label79" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>type</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[subnet]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[interface]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> </ul> <li> <span class="li-head">wan_interface</span> - FortiGate WAN interfaces to use with OCVPN. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: wan_interface:name</span> <a id='label80' href="javascript:ContentClick('label81', 'label80');" onmouseover="ContentPreview('label81');" onmouseout="ContentUnpreview('label81');" title="click to collapse or expand..."> more... </a> <div id="label81" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>wan_interface</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - Interface name. Source system.interface.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label82' href="javascript:ContentClick('label83', 'label82');" onmouseover="ContentPreview('label83');" onmouseout="ContentUnpreview('label83');" title="click to collapse or expand..."> more... </a> <div id="label83" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.4.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> </ul> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure Overlay Controller VPN settings. fortinet.fortios.fortios_vpn_ocvpn: vdom: "{{ vdom }}" vpn_ocvpn: auto_discovery: "enable" auto_discovery_shortcut_mode: "independent" eap: "enable" eap_users: "<your_own_value> (source user.group.name)" forticlient_access: auth_groups: - auth_group: "<your_own_value> (source user.group.name)" name: "default_name_10" overlays: - overlay_name: "<your_own_value> (source vpn.ocvpn.overlays.overlay-name)" psksecret: "<your_own_value>" status: "enable" ha_alias: "<your_own_value>" ip_allocation_block: "<your_own_value>" multipath: "enable" nat: "enable" overlays: - assign_ip: "enable" id: "21" inter_overlay: "allow" ipv4_end_ip: "<your_own_value>" ipv4_start_ip: "<your_own_value>" name: "default_name_25" overlay_name: "<your_own_value>" subnets: - id: "28" interface: "<your_own_value> (source system.interface.name)" subnet: "<your_own_value>" type: "subnet" poll_interval: "30" role: "spoke" sdwan: "enable" sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)" status: "enable" subnets: - id: "38" interface: "<your_own_value> (source system.interface.name)" subnet: "<your_own_value>" type: "subnet" wan_interface: - name: "default_name_43 (source system.interface.name)"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.