Skip to content

Latest commit

 

History

History
1255 lines (1210 loc) · 41.8 KB

fortios_extender_controller_dataplan.rst

File metadata and controls

1255 lines (1210 loc) · 41.8 KB
Raw
source

fortios_extender_controller_dataplan.py

orphan

fortios_extender_controller_dataplan -- FortiExtender dataplan 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 dataplan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9

Tips

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

FortiOS Version Compatibility


v6.4.0 v6.4.4 v7.0.0 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.2.0
fortios_extender_controller_dataplan yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • extender_controller_dataplan - FortiExtender dataplan 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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>extender_controller_dataplan</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">apn</span> - APN configuration. <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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>apn</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">APN</span> - APN configuration. <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><code class="docutils literal notranslate">v6.4.0 </code></td> </tr> <tr> <td>APN</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">auth_type</span> - Authentication type. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, pap, chap</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>auth_type</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[none]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[pap]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[chap]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">billing_date</span> - Billing day of the month (1 - 31). <span class="li-normal">type: int</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>billing_date</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">capacity</span> - Capacity in MB (0 - 102400000). <span class="li-normal">type: int</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>capacity</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">carrier</span> - Carrier configuration. <span class="li-normal">type: str</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>carrier</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">iccid</span> - ICCID configuration. <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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>iccid</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">modem_id</span> - Dataplan"s modem specifics, if any. <span class="li-normal">type: str</span> <span class="li-normal">choices: modem1, modem2, all</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>modem_id</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[modem1]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[modem2]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[all]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">monthly_fee</span> - Monthly fee of dataplan (0 - 100000, in local currency). <span class="li-normal">type: int</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>monthly_fee</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - FortiExtender data plan 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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">overage</span> - Enable/disable dataplan overage detection. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>overage</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">password</span> - Password. <span class="li-normal">type: str</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>password</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">pdn</span> - PDN type. <span class="li-normal">type: str</span> <span class="li-normal">choices: ipv4-only, ipv6-only, ipv4-ipv6</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>pdn</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv4-only]</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv6-only]</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv4-ipv6]</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">PDN</span> - PDN type. <span class="li-normal">type: str</span> <span class="li-normal">choices: ipv4-only, ipv6-only, ipv4-ipv6</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> </tr> <tr> <td>PDN</td> <td>yes</td> </tr> <tr> <td>[ipv4-only]</td> <td>yes</td> </tr> <tr> <td>[ipv6-only]</td> <td>yes</td> </tr> <tr> <td>[ipv4-ipv6]</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">preferred_subnet</span> - Preferred subnet mask (0 - 32). <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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>preferred_subnet</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">private_network</span> - Enable/disable dataplan private network support. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>private_network</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">signal_period</span> - Signal period (600 to 18000 seconds). <span class="li-normal">type: int</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>signal_period</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">signal_threshold</span> - Signal threshold. Specify the range between 50 - 100, where 50/100 means -50/-100 dBm. <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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>signal_threshold</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">slot</span> - SIM slot configuration. <span class="li-normal">type: str</span> <span class="li-normal">choices: sim1, sim2</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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>slot</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[sim1]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[sim2]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">type</span> - Type preferences configuration. <span class="li-normal">type: str</span> <span class="li-normal">choices: carrier, slot, iccid, generic</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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>type</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[carrier]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[slot]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[iccid]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[generic]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">username</span> - Username. <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><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>username</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul>

    Notes

    Note

    • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

    Examples

    - hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: FortiExtender dataplan configuration.
    fortios_extender_controller_dataplan:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      extender_controller_dataplan:
        apn: "<your_own_value>"
        APN: "<your_own_value>"
        auth_type: "none"
        billing_date: "1"
        capacity: "0"
        carrier: "<your_own_value>"
        iccid: "<your_own_value>"
        modem_id: "modem1"
        monthly_fee: "0"
        name: "default_name_12"
        overage: "disable"
        password: "<your_own_value>"
        pdn: "ipv4-only"
        PDN: "ipv4-only"
        preferred_subnet: "32"
        private_network: "disable"
        signal_period: "3600"
        signal_threshold: "100"
        slot: "sim1"
        type: "carrier"
        username: "<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.