- source
fortios_system_ddns.py
- orphan
2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ddns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.9
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_system_ddns | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_ddns - Configure DDNS. type: dict
<a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>system_ddns</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">addr_type</span> - Address type of interface address in DDNS update. <span class="li-normal">type: str</span> <span class="li-normal">choices: ipv4, ipv6</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>addr_type</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv4]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv6]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">bound_ip</span> - Bound IP address. <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.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> </tr> <tr> <td>bound_ip</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">clear_text</span> - Enable/disable use of clear text connections. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, 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><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>clear_text</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">ddns_auth</span> - Enable/disable TSIG authentication for your DDNS server. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, tsig</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_auth</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[tsig]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_domain</span> - Your fully qualified domain name. For example, yourname.ddns.com. <span class="li-normal">type: str</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_domain</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_key</span> - DDNS update key (base 64 encoding). <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.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_key</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_keyname</span> - DDNS update key name. <span class="li-normal">type: str</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_keyname</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_password</span> - DDNS password. <span class="li-normal">type: str</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_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> <td>yes</td> <td>yes</td> <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">ddns_server</span> - Select a DDNS service provider. <span class="li-normal">type: str</span> <span class="li-normal">choices: dyndns.org, dyns.net, tzo.com, vavic.com, dipdns.net, now.net.cn, dhs.org, easydns.com, genericDDNS, FortiGuardDDNS, noip.com</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_server</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[dyndns.org]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[dyns.net]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[tzo.com]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[vavic.com]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[dipdns.net]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[now.net.cn]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[dhs.org]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[easydns.com]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[genericDDNS]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[FortiGuardDDNS]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[noip.com]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_server_addr</span> - Generic DDNS server IP/FQDN list. <span class="li-normal">type: list</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_server_addr</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">addr</span> - IP address or FQDN of the server. <span class="li-normal">type: str</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>addr</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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> <li> <span class="li-head">ddns_server_ip</span> - Generic DDNS server IP. <span class="li-normal">type: str</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> </tr> <tr> <td>ddns_server_ip</td> <td>yes</td> <td>yes</td> <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">ddns_sn</span> - DDNS Serial Number. <span class="li-normal">type: str</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_sn</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_ttl</span> - Time-to-live for DDNS packets. <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><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_ttl</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddns_username</span> - DDNS user name. <span class="li-normal">type: str</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_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> <td>yes</td> <td>yes</td> <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">ddns_zone</span> - Zone of your domain name (for example, DDNS.com). <span class="li-normal">type: str</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddns_zone</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ddnsid</span> - DDNS ID. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ddnsid</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">monitor_interface</span> - Monitored interface. <span class="li-normal">type: list</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>monitor_interface</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">interface_name</span> - Interface name. Source system.interface.name. <span class="li-normal">type: str</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.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>interface_name</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">server_type</span> - Address type of the DDNS server. <span class="li-normal">type: str</span> <span class="li-normal">choices: ipv4, ipv6</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.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>server_type</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv4]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipv6]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">ssl_certificate</span> - Name of local certificate for SSL connections. Source certificate.local.name. <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.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ssl_certificate</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">update_interval</span> - DDNS update interval (60 - 2592000 sec, 0 means default). <span class="li-normal">type: int</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><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>update_interval</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">use_public_ip</span> - Enable/disable use of public IP address. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>use_public_ip</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure DDNS. fortios_system_ddns: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" system_ddns: addr_type: "ipv4" bound_ip: "<your_own_value>" clear_text: "disable" ddns_auth: "disable" ddns_domain: "<your_own_value>" ddns_key: "<your_own_value>" ddns_keyname: "<your_own_value>" ddns_password: "<your_own_value>" ddns_server: "dyndns.org" ddns_server_addr: - addr: "<your_own_value>" ddns_server_ip: "<your_own_value>" ddns_sn: "<your_own_value>" ddns_ttl: "300" ddns_username: "<your_own_value>" ddns_zone: "<your_own_value>" ddnsid: "0" monitor_interface: - interface_name: "<your_own_value> (source system.interface.name)" server_type: "ipv4" ssl_certificate: "<your_own_value> (source certificate.local.name)" update_interval: "300" use_public_ip: "disable"
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.