source: fortios_extender_controller_extender.py
orphan

fortios_extender_controller_extender -- Extender controller configuration 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 extender_controller feature and extender 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.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> v7.2.0

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
extender_controller_extender - Extender controller configuration. 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>extender_controller_extender</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">aaa_shared_secret</span> - AAA shared secret. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>aaa_shared_secret</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">access_point_name</span> - Access point name(APN). <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>access_point_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">admin</span> - FortiExtender Administration (enable or disable). <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, discovered, enable</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="2">Supported Version Ranges</td> </tr> <tr> <td>admin</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[discovered]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">allowaccess</span> - Control management access to the managed extender. Separate entries with a space. <span class="li-normal">type: list</span> <span class="li-normal">choices: ping, telnet, http, https, ssh, snmp</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>allowaccess</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[ping]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[telnet]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[http]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[https]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[ssh]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[snmp]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">at_dial_script</span> - Initialization AT commands specific to the MODEM. <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 colspan="2">Supported Version Ranges</td> </tr> <tr> <td>at_dial_script</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">authorized</span> - FortiExtender Administration (enable or disable). <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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="2">Supported Version Ranges</td> </tr> <tr> <td>authorized</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.2.0 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">bandwidth_limit</span> - FortiExtender LAN extension bandwidth limit (Mbps). <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>bandwidth_limit</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">billing_start_day</span> - Billing start day. <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 colspan="2">Supported Version Ranges</td> </tr> <tr> <td>billing_start_day</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">cdma_aaa_spi</span> - CDMA AAA SPI. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>cdma_aaa_spi</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">cdma_ha_spi</span> - CDMA HA SPI. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>cdma_ha_spi</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">cdma_nai</span> - NAI for CDMA MODEMS. <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="2">Supported Version Ranges</td> </tr> <tr> <td>cdma_nai</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">conn_status</span> - Connection status. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>conn_status</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">controller_report</span> - FortiExtender controller report configuration. <span class="li-normal">type: dict</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>controller_report</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">interval</span> - Controller report interval. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>interval</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">signal_threshold</span> - Controller report signal threshold. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>signal_threshold</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">status</span> - FortiExtender controller report status. <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 colspan="2">Supported Version Ranges</td> </tr> <tr> <td>status</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> </ul> <li> <span class="li-head">description</span> - Description. <span class="li-normal">type: str</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>description</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">device_id</span> - Device ID. <span class="li-normal">type: int</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>device_id</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">dial_mode</span> - Dial mode (dial-on-demand or always-connect). <span class="li-normal">type: str</span> <span class="li-normal">choices: dial-on-demand, always-connect</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="2">Supported Version Ranges</td> </tr> <tr> <td>dial_mode</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[dial-on-demand]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[always-connect]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">dial_status</span> - Dial status. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>dial_status</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">enforce_bandwidth</span> - Enable/disable enforcement of bandwidth on LAN extension interface. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>enforce_bandwidth</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">ext_name</span> - FortiExtender name. <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>ext_name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">extension_type</span> - Extension type for this FortiExtender. <span class="li-normal">type: str</span> <span class="li-normal">choices: wan-extension, lan-extension</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>extension_type</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[wan-extension]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[lan-extension]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">ha_shared_secret</span> - HA shared secret. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>ha_shared_secret</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - FortiExtender serial number. <span class="li-normal">type: str</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>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ifname</span> - FortiExtender interface name. Source system.interface.name. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>ifname</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">initiated_update</span> - Allow/disallow network initiated updates to the MODEM. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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="2">Supported Version Ranges</td> </tr> <tr> <td>initiated_update</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">login_password</span> - Set the managed extender"s administrator password. <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="2">Supported Version Ranges</td> </tr> <tr> <td>login_password</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">login_password_change</span> - Change or reset the administrator password of a managed extender (yes, default, or no). <span class="li-normal">type: str</span> <span class="li-normal">choices: yes, default, no</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>login_password_change</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[yes]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[default]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[no]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">mode</span> - FortiExtender mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: standalone, redundant</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="2">Supported Version Ranges</td> </tr> <tr> <td>mode</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[standalone]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[redundant]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">modem_passwd</span> - MODEM password. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>modem_passwd</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">modem_type</span> - MODEM type (CDMA, GSM/LTE or WIMAX). <span class="li-normal">type: str</span> <span class="li-normal">choices: cdma, gsm/lte, wimax</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="2">Supported Version Ranges</td> </tr> <tr> <td>modem_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[cdma]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[gsm/lte]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[wimax]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">modem1</span> - Configuration options for modem 1. <span class="li-normal">type: dict</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="2">Supported Version Ranges</td> </tr> <tr> <td>modem1</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auto_switch</span> - FortiExtender auto switch configuration. <span class="li-normal">type: dict</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="2">Supported Version Ranges</td> </tr> <tr> <td>auto_switch</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">dataplan</span> - Automatically switch based on data usage. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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="2">Supported Version Ranges</td> </tr> <tr> <td>dataplan</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">disconnect</span> - Auto switch by disconnect. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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="2">Supported Version Ranges</td> </tr> <tr> <td>disconnect</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">disconnect_period</span> - Automatically switch based on disconnect period. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>disconnect_period</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">disconnect_threshold</span> - Automatically switch based on disconnect threshold. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>disconnect_threshold</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">signal</span> - Automatically switch based on signal strength. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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="2">Supported Version Ranges</td> </tr> <tr> <td>signal</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">switch_back</span> - Auto switch with switch back multi-options. <span class="li-normal">type: list</span> <span class="li-normal">choices: time, timer</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="2">Supported Version Ranges</td> </tr> <tr> <td>switch_back</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[time]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[timer]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">switch_back_time</span> - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>switch_back_time</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">switch_back_timer</span> - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). <span class="li-normal">type: int</span> <a id='label84' href="javascript:ContentClick('label85', 'label84');" onmouseover="ContentPreview('label85');" onmouseout="ContentUnpreview('label85');" title="click to collapse or expand..."> more... </a> <div id="label85" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>switch_back_timer</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">conn_status</span> - Connection status. <span class="li-normal">type: int</span> <a id='label86' href="javascript:ContentClick('label87', 'label86');" onmouseover="ContentPreview('label87');" onmouseout="ContentUnpreview('label87');" title="click to collapse or expand..."> more... </a> <div id="label87" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>conn_status</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_sim</span> - Default SIM selection. <span class="li-normal">type: str</span> <span class="li-normal">choices: sim1, sim2, carrier, cost</span> <a id='label88' href="javascript:ContentClick('label89', 'label88');" onmouseover="ContentPreview('label89');" onmouseout="ContentUnpreview('label89');" title="click to collapse or expand..."> more... </a> <div id="label89" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>default_sim</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[sim1]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[sim2]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[carrier]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[cost]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">gps</span> - FortiExtender GPS enable/disable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label90' href="javascript:ContentClick('label91', 'label90');" onmouseover="ContentPreview('label91');" onmouseout="ContentUnpreview('label91');" title="click to collapse or expand..."> more... </a> <div id="label91" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>gps</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">ifname</span> - FortiExtender interface name. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label92' href="javascript:ContentClick('label93', 'label92');" onmouseover="ContentPreview('label93');" onmouseout="ContentUnpreview('label93');" title="click to collapse or expand..."> more... </a> <div id="label93" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ifname</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">preferred_carrier</span> - Preferred carrier. <span class="li-normal">type: str</span> <a id='label94' href="javascript:ContentClick('label95', 'label94');" onmouseover="ContentPreview('label95');" onmouseout="ContentUnpreview('label95');" title="click to collapse or expand..."> more... </a> <div id="label95" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>preferred_carrier</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">redundant_intf</span> - Redundant interface. <span class="li-normal">type: str</span> <a id='label96' href="javascript:ContentClick('label97', 'label96');" onmouseover="ContentPreview('label97');" onmouseout="ContentUnpreview('label97');" title="click to collapse or expand..."> more... </a> <div id="label97" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redundant_intf</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">redundant_mode</span> - FortiExtender mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label98' href="javascript:ContentClick('label99', 'label98');" onmouseover="ContentPreview('label99');" onmouseout="ContentUnpreview('label99');" title="click to collapse or expand..."> more... </a> <div id="label99" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redundant_mode</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">sim1_pin</span> - SIM <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label100' href="javascript:ContentClick('label101', 'label100');" onmouseover="ContentPreview('label101');" onmouseout="ContentUnpreview('label101');" title="click to collapse or expand..."> more... </a> <div id="label101" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim1_pin</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">sim1_pin_code</span> - SIM <span class="li-normal">type: str</span> <a id='label102' href="javascript:ContentClick('label103', 'label102');" onmouseover="ContentPreview('label103');" onmouseout="ContentUnpreview('label103');" title="click to collapse or expand..."> more... </a> <div id="label103" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim1_pin_code</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sim2_pin</span> - SIM <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label104' href="javascript:ContentClick('label105', 'label104');" onmouseover="ContentPreview('label105');" onmouseout="ContentUnpreview('label105');" title="click to collapse or expand..."> more... </a> <div id="label105" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim2_pin</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">sim2_pin_code</span> - SIM <span class="li-normal">type: str</span> <a id='label106' href="javascript:ContentClick('label107', 'label106');" onmouseover="ContentPreview('label107');" onmouseout="ContentUnpreview('label107');" title="click to collapse or expand..."> more... </a> <div id="label107" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim2_pin_code</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">modem2</span> - Configuration options for modem 2. <span class="li-normal">type: dict</span> <a id='label108' href="javascript:ContentClick('label109', 'label108');" onmouseover="ContentPreview('label109');" onmouseout="ContentUnpreview('label109');" title="click to collapse or expand..."> more... </a> <div id="label109" style="display:none"> <table border="1"> <tr> <td></td><td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>modem2</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auto_switch</span> - FortiExtender auto switch configuration. <span class="li-normal">type: dict</span> <a id='label110' href="javascript:ContentClick('label111', 'label110');" onmouseover="ContentPreview('label111');" onmouseout="ContentUnpreview('label111');" title="click to collapse or expand..."> more... </a> <div id="label111" style="display:none"> <table border="1"> <tr> <td></td><td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>auto_switch</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">dataplan</span> - Automatically switch based on data usage. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label112' href="javascript:ContentClick('label113', 'label112');" onmouseover="ContentPreview('label113');" onmouseout="ContentUnpreview('label113');" title="click to collapse or expand..."> more... </a> <div id="label113" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>dataplan</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">disconnect</span> - Auto switch by disconnect. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label114' href="javascript:ContentClick('label115', 'label114');" onmouseover="ContentPreview('label115');" onmouseout="ContentUnpreview('label115');" title="click to collapse or expand..."> more... </a> <div id="label115" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>disconnect</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">disconnect_period</span> - Automatically switch based on disconnect period. <span class="li-normal">type: int</span> <a id='label116' href="javascript:ContentClick('label117', 'label116');" onmouseover="ContentPreview('label117');" onmouseout="ContentUnpreview('label117');" title="click to collapse or expand..."> more... </a> <div id="label117" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>disconnect_period</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">disconnect_threshold</span> - Automatically switch based on disconnect threshold. <span class="li-normal">type: int</span> <a id='label118' href="javascript:ContentClick('label119', 'label118');" onmouseover="ContentPreview('label119');" onmouseout="ContentUnpreview('label119');" title="click to collapse or expand..."> more... </a> <div id="label119" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>disconnect_threshold</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">signal</span> - Automatically switch based on signal strength. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label120' href="javascript:ContentClick('label121', 'label120');" onmouseover="ContentPreview('label121');" onmouseout="ContentUnpreview('label121');" title="click to collapse or expand..."> more... </a> <div id="label121" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>signal</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">switch_back</span> - Auto switch with switch back multi-options. <span class="li-normal">type: list</span> <span class="li-normal">choices: time, timer</span> <a id='label122' href="javascript:ContentClick('label123', 'label122');" onmouseover="ContentPreview('label123');" onmouseout="ContentUnpreview('label123');" title="click to collapse or expand..."> more... </a> <div id="label123" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>switch_back</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[time]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[timer]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">switch_back_time</span> - Automatically switch over to preferred SIM/carrier at a specified time in UTC (HH:MM). <span class="li-normal">type: str</span> <a id='label124' href="javascript:ContentClick('label125', 'label124');" onmouseover="ContentPreview('label125');" onmouseout="ContentUnpreview('label125');" title="click to collapse or expand..."> more... </a> <div id="label125" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>switch_back_time</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">switch_back_timer</span> - Automatically switch over to preferred SIM/carrier after the given time (3600 - 2147483647 sec). <span class="li-normal">type: int</span> <a id='label126' href="javascript:ContentClick('label127', 'label126');" onmouseover="ContentPreview('label127');" onmouseout="ContentUnpreview('label127');" title="click to collapse or expand..."> more... </a> <div id="label127" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>switch_back_timer</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">conn_status</span> - Connection status. <span class="li-normal">type: int</span> <a id='label128' href="javascript:ContentClick('label129', 'label128');" onmouseover="ContentPreview('label129');" onmouseout="ContentUnpreview('label129');" title="click to collapse or expand..."> more... </a> <div id="label129" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>conn_status</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_sim</span> - Default SIM selection. <span class="li-normal">type: str</span> <span class="li-normal">choices: sim1, sim2, carrier, cost</span> <a id='label130' href="javascript:ContentClick('label131', 'label130');" onmouseover="ContentPreview('label131');" onmouseout="ContentUnpreview('label131');" title="click to collapse or expand..."> more... </a> <div id="label131" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>default_sim</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[sim1]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[sim2]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[carrier]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[cost]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">gps</span> - FortiExtender GPS enable/disable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label132' href="javascript:ContentClick('label133', 'label132');" onmouseover="ContentPreview('label133');" onmouseout="ContentUnpreview('label133');" title="click to collapse or expand..."> more... </a> <div id="label133" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>gps</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">ifname</span> - FortiExtender interface name. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label134' href="javascript:ContentClick('label135', 'label134');" onmouseover="ContentPreview('label135');" onmouseout="ContentUnpreview('label135');" title="click to collapse or expand..."> more... </a> <div id="label135" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ifname</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">preferred_carrier</span> - Preferred carrier. <span class="li-normal">type: str</span> <a id='label136' href="javascript:ContentClick('label137', 'label136');" onmouseover="ContentPreview('label137');" onmouseout="ContentUnpreview('label137');" title="click to collapse or expand..."> more... </a> <div id="label137" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>preferred_carrier</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">redundant_intf</span> - Redundant interface. <span class="li-normal">type: str</span> <a id='label138' href="javascript:ContentClick('label139', 'label138');" onmouseover="ContentPreview('label139');" onmouseout="ContentUnpreview('label139');" title="click to collapse or expand..."> more... </a> <div id="label139" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redundant_intf</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">redundant_mode</span> - FortiExtender mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label140' href="javascript:ContentClick('label141', 'label140');" onmouseover="ContentPreview('label141');" onmouseout="ContentUnpreview('label141');" title="click to collapse or expand..."> more... </a> <div id="label141" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redundant_mode</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">sim1_pin</span> - SIM <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label142' href="javascript:ContentClick('label143', 'label142');" onmouseover="ContentPreview('label143');" onmouseout="ContentUnpreview('label143');" title="click to collapse or expand..."> more... </a> <div id="label143" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim1_pin</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">sim1_pin_code</span> - SIM <span class="li-normal">type: str</span> <a id='label144' href="javascript:ContentClick('label145', 'label144');" onmouseover="ContentPreview('label145');" onmouseout="ContentUnpreview('label145');" title="click to collapse or expand..."> more... </a> <div id="label145" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim1_pin_code</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sim2_pin</span> - SIM <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label146' href="javascript:ContentClick('label147', 'label146');" onmouseover="ContentPreview('label147');" onmouseout="ContentUnpreview('label147');" title="click to collapse or expand..."> more... </a> <div id="label147" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim2_pin</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">sim2_pin_code</span> - SIM <span class="li-normal">type: str</span> <a id='label148' href="javascript:ContentClick('label149', 'label148');" onmouseover="ContentPreview('label149');" onmouseout="ContentUnpreview('label149');" title="click to collapse or expand..."> more... </a> <div id="label149" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim2_pin_code</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.0.1 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">multi_mode</span> - MODEM mode of operation(3G,LTE,etc). <span class="li-normal">type: str</span> <span class="li-normal">choices: auto, auto-3g, force-lte, force-3g, force-2g</span> <a id='label150' href="javascript:ContentClick('label151', 'label150');" onmouseover="ContentPreview('label151');" onmouseout="ContentUnpreview('label151');" title="click to collapse or expand..."> more... </a> <div id="label151" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>multi_mode</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[auto]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[auto-3g]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[force-lte]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[force-3g]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[force-2g]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - FortiExtender entry name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label152' href="javascript:ContentClick('label153', 'label152');" onmouseover="ContentPreview('label153');" onmouseout="ContentUnpreview('label153');" title="click to collapse or expand..."> more... </a> <div id="label153" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">override_allowaccess</span> - Enable to override the extender profile management access configuration. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label154' href="javascript:ContentClick('label155', 'label154');" onmouseover="ContentPreview('label155');" onmouseout="ContentUnpreview('label155');" title="click to collapse or expand..."> more... </a> <div id="label155" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>override_allowaccess</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">override_enforce_bandwidth</span> - Enable to override the extender profile enforce-bandwidth setting. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label156' href="javascript:ContentClick('label157', 'label156');" onmouseover="ContentPreview('label157');" onmouseout="ContentUnpreview('label157');" title="click to collapse or expand..."> more... </a> <div id="label157" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>override_enforce_bandwidth</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">override_login_password_change</span> - Enable to override the extender profile login-password (administrator password) setting. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label158' href="javascript:ContentClick('label159', 'label158');" onmouseover="ContentPreview('label159');" onmouseout="ContentUnpreview('label159');" title="click to collapse or expand..."> more... </a> <div id="label159" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>override_login_password_change</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0</code></td> </table> </div> </li> <li> <span class="li-head">ppp_auth_protocol</span> - PPP authentication protocol (PAP,CHAP or auto). <span class="li-normal">type: str</span> <span class="li-normal">choices: auto, pap, chap</span> <a id='label160' href="javascript:ContentClick('label161', 'label160');" onmouseover="ContentPreview('label161');" onmouseout="ContentUnpreview('label161');" title="click to collapse or expand..."> more... </a> <div id="label161" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ppp_auth_protocol</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[auto]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[pap]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[chap]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">ppp_echo_request</span> - Enable/disable PPP echo request. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label162' href="javascript:ContentClick('label163', 'label162');" onmouseover="ContentPreview('label163');" onmouseout="ContentUnpreview('label163');" title="click to collapse or expand..."> more... </a> <div id="label163" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ppp_echo_request</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">ppp_password</span> - PPP password. <span class="li-normal">type: str</span> <a id='label164' href="javascript:ContentClick('label165', 'label164');" onmouseover="ContentPreview('label165');" onmouseout="ContentUnpreview('label165');" title="click to collapse or expand..."> more... </a> <div id="label165" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ppp_password</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ppp_username</span> - PPP username. <span class="li-normal">type: str</span> <a id='label166' href="javascript:ContentClick('label167', 'label166');" onmouseover="ContentPreview('label167');" onmouseout="ContentUnpreview('label167');" title="click to collapse or expand..."> more... </a> <div id="label167" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>ppp_username</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">primary_ha</span> - Primary HA. <span class="li-normal">type: str</span> <a id='label168' href="javascript:ContentClick('label169', 'label168');" onmouseover="ContentPreview('label169');" onmouseout="ContentUnpreview('label169');" title="click to collapse or expand..."> more... </a> <div id="label169" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>primary_ha</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">profile</span> - FortiExtender profile configuration. Source extender-controller.extender-profile.name. <span class="li-normal">type: str</span> <a id='label170' href="javascript:ContentClick('label171', 'label170');" onmouseover="ContentPreview('label171');" onmouseout="ContentUnpreview('label171');" title="click to collapse or expand..."> more... </a> <div id="label171" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>profile</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">quota_limit_mb</span> - Monthly quota limit (MB). <span class="li-normal">type: int</span> <a id='label172' href="javascript:ContentClick('label173', 'label172');" onmouseover="ContentPreview('label173');" onmouseout="ContentUnpreview('label173');" title="click to collapse or expand..."> more... </a> <div id="label173" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>quota_limit_mb</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">redial</span> - Number of redials allowed based on failed attempts. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10</span> <a id='label174' href="javascript:ContentClick('label175', 'label174');" onmouseover="ContentPreview('label175');" onmouseout="ContentUnpreview('label175');" title="click to collapse or expand..."> more... </a> <div id="label175" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redial</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[1]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[3]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[4]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[5]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[6]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[7]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[8]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[9]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[10]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">redundant_intf</span> - Redundant interface. <span class="li-normal">type: str</span> <a id='label176' href="javascript:ContentClick('label177', 'label176');" onmouseover="ContentPreview('label177');" onmouseout="ContentUnpreview('label177');" title="click to collapse or expand..."> more... </a> <div id="label177" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>redundant_intf</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">roaming</span> - Enable/disable MODEM roaming. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label178' href="javascript:ContentClick('label179', 'label178');" onmouseover="ContentPreview('label179');" onmouseout="ContentUnpreview('label179');" title="click to collapse or expand..."> more... </a> <div id="label179" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>roaming</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">role</span> - FortiExtender work role(Primary, Secondary, None). <span class="li-normal">type: str</span> <span class="li-normal">choices: none, primary, secondary</span> <a id='label180' href="javascript:ContentClick('label181', 'label180');" onmouseover="ContentPreview('label181');" onmouseout="ContentUnpreview('label181');" title="click to collapse or expand..."> more... </a> <div id="label181" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>role</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[primary]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[secondary]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">secondary_ha</span> - Secondary HA. <span class="li-normal">type: str</span> <a id='label182' href="javascript:ContentClick('label183', 'label182');" onmouseover="ContentPreview('label183');" onmouseout="ContentUnpreview('label183');" title="click to collapse or expand..."> more... </a> <div id="label183" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>secondary_ha</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sim_pin</span> - SIM PIN. <span class="li-normal">type: str</span> <a id='label184' href="javascript:ContentClick('label185', 'label184');" onmouseover="ContentPreview('label185');" onmouseout="ContentUnpreview('label185');" title="click to collapse or expand..."> more... </a> <div id="label185" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>sim_pin</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">vdom</span> - VDOM. <span class="li-normal">type: int</span> <a id='label186' href="javascript:ContentClick('label187', 'label186');" onmouseover="ContentPreview('label187');" onmouseout="ContentUnpreview('label187');" title="click to collapse or expand..."> more... </a> <div id="label187" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>vdom</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">wan_extension</span> - FortiExtender wan extension configuration. <span class="li-normal">type: dict</span> <a id='label188' href="javascript:ContentClick('label189', 'label188');" onmouseover="ContentPreview('label189');" onmouseout="ContentUnpreview('label189');" title="click to collapse or expand..."> more... </a> <div id="label189" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>wan_extension</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">modem1_extension</span> - FortiExtender interface name. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label190' href="javascript:ContentClick('label191', 'label190');" onmouseover="ContentPreview('label191');" onmouseout="ContentUnpreview('label191');" title="click to collapse or expand..."> more... </a> <div id="label191" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>modem1_extension</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">modem2_extension</span> - FortiExtender interface name. Source system.interface.name. <span class="li-normal">type: str</span> <a id='label192' href="javascript:ContentClick('label193', 'label192');" onmouseover="ContentPreview('label193');" onmouseout="ContentUnpreview('label193');" title="click to collapse or expand..."> more... </a> <div id="label193" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>modem2_extension</td> <td><code class="docutils literal notranslate">v7.0.2 -> v7.2.0 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">wimax_auth_protocol</span> - WiMax authentication protocol(TLS or TTLS). <span class="li-normal">type: str</span> <span class="li-normal">choices: tls, ttls</span> <a id='label194' href="javascript:ContentClick('label195', 'label194');" onmouseover="ContentPreview('label195');" onmouseout="ContentUnpreview('label195');" title="click to collapse or expand..."> more... </a> <div id="label195" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>wimax_auth_protocol</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[tls]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[ttls]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">wimax_carrier</span> - WiMax carrier. <span class="li-normal">type: str</span> <a id='label196' href="javascript:ContentClick('label197', 'label196');" onmouseover="ContentPreview('label197');" onmouseout="ContentUnpreview('label197');" title="click to collapse or expand..."> more... </a> <div id="label197" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>wimax_carrier</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">wimax_realm</span> - WiMax realm. <span class="li-normal">type: str</span> <a id='label198' href="javascript:ContentClick('label199', 'label198');" onmouseover="ContentPreview('label199');" onmouseout="ContentUnpreview('label199');" title="click to collapse or expand..."> more... </a> <div id="label199" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>wimax_realm</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> </table> </div> </li> </ul> </ul>

Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
```
- name: Extender controller configuration.
  fortinet.fortios.fortios_extender_controller_extender:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_extender:
          aaa_shared_secret: "<your_own_value>"
          access_point_name: "<your_own_value>"
          admin: "disable"
          allowaccess: "ping"
          at_dial_script: "<your_own_value>"
          authorized: "disable"
          bandwidth_limit: "1024"
          billing_start_day: "14"
          cdma_aaa_spi: "<your_own_value>"
          cdma_ha_spi: "<your_own_value>"
          cdma_nai: "<your_own_value>"
          conn_status: "2147483647"
          controller_report:
              interval: "300"
              signal_threshold: "10"
              status: "disable"
          description: "<your_own_value>"
          device_id: "1024"
          dial_mode: "dial-on-demand"
          dial_status: "2147483647"
          enforce_bandwidth: "enable"
          ext_name: "<your_own_value>"
          extension_type: "wan-extension"
          ha_shared_secret: "<your_own_value>"
          id: "27"
          ifname: "<your_own_value> (source system.interface.name)"
          initiated_update: "enable"
          login_password: "<your_own_value>"
          login_password_change: "yes"
          mode: "standalone"
          modem_passwd: "<your_own_value>"
          modem_type: "cdma"
          modem1:
              auto_switch:
                  dataplan: "disable"
                  disconnect: "disable"
                  disconnect_period: "600"
                  disconnect_threshold: "3"
                  signal: "disable"
                  switch_back: "time"
                  switch_back_time: "<your_own_value>"
                  switch_back_timer: "86400"
              conn_status: "0"
              default_sim: "sim1"
              gps: "disable"
              ifname: "<your_own_value> (source system.interface.name)"
              preferred_carrier: "<your_own_value>"
              redundant_intf: "<your_own_value>"
              redundant_mode: "disable"
              sim1_pin: "disable"
              sim1_pin_code: "<your_own_value>"
              sim2_pin: "disable"
              sim2_pin_code: "<your_own_value>"
          modem2:
              auto_switch:
                  dataplan: "disable"
                  disconnect: "disable"
                  disconnect_period: "600"
                  disconnect_threshold: "3"
                  signal: "disable"
                  switch_back: "time"
                  switch_back_time: "<your_own_value>"
                  switch_back_timer: "86400"
              conn_status: "0"
              default_sim: "sim1"
              gps: "disable"
              ifname: "<your_own_value> (source system.interface.name)"
              preferred_carrier: "<your_own_value>"
              redundant_intf: "<your_own_value>"
              redundant_mode: "disable"
              sim1_pin: "disable"
              sim1_pin_code: "<your_own_value>"
              sim2_pin: "disable"
              sim2_pin_code: "<your_own_value>"
          multi_mode: "auto"
          name: "default_name_78"
          override_allowaccess: "enable"
          override_enforce_bandwidth: "enable"
          override_login_password_change: "enable"
          ppp_auth_protocol: "auto"
          ppp_echo_request: "enable"
          ppp_password: "<your_own_value>"
          ppp_username: "<your_own_value>"
          primary_ha: "<your_own_value>"
          profile: "<your_own_value> (source extender-controller.extender-profile.name)"
          quota_limit_mb: "5242880"
          redial: "none"
          redundant_intf: "<your_own_value>"
          roaming: "enable"
          role: "none"
          secondary_ha: "<your_own_value>"
          sim_pin: "<your_own_value>"
          vdom: "0"
          wan_extension:
              modem1_extension: "<your_own_value> (source system.interface.name)"
              modem2_extension: "<your_own_value> (source system.interface.name)"
          wimax_auth_protocol: "tls"
          wimax_carrier: "<your_own_value>"
          wimax_realm: "<your_own_value>"
```
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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_extender_controller_extender.rst

fortios_extender_controller_extender.rst

fortios_extender_controller_extender -- Extender controller configuration in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_extender_controller_extender.rst

Latest commit

History

fortios_extender_controller_extender.rst

File metadata and controls

fortios_extender_controller_extender -- Extender controller configuration in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors