source: fortios_firewall_address6.py
orphan

fortios_firewall_address6 -- Configure IPv6 firewall addresses in Fortinet's FortiOS and FortiGate.

2.10

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address6 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.0

FortiOS Version Compatibility

	`v6.0.0`	`v6.0.5`	`v6.0.11`	`v6.2.0`	`v6.2.3`	`v6.2.5`	`v6.2.7`	`v6.4.0`	`v6.4.1`	`v6.4.4`	`v7.0.0`
fortios_firewall_address6	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
state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
firewall_address6 - Configure IPv6 firewall addresses. 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> </tr> <tr> <td>firewall_address6</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">cache_ttl</span> - Minimal TTL of individual IPv6 addresses in FQDN cache. <span class="li-normal">type: int</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> </tr> <tr> <td>cache_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> </tr> </table> </div> </li> <li> <span class="li-head">color</span> - Integer value to determine the color of the icon in the GUI (range 1 to 32). <span class="li-normal">type: int</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> </tr> <tr> <td>color</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">comment</span> - Comment. <span class="li-normal">type: str</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>comment</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">country</span> - IPv6 addresses associated to a specific country. <span class="li-normal">type: str</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>country</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">end_ip</span> - Final IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). <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> </tr> <tr> <td>end_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> </tr> </table> </div> </li> <li> <span class="li-head">end_mac</span> - Last MAC address in the range. <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.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> </tr> <tr> <td>end_mac</td> <td>yes</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>no</td> <td>yes</td> <td>no</td> </tr> </table> </div> </li> <li> <span class="li-head">fabric_object</span> - Security Fabric global object setting. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>fabric_object</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">fqdn</span> - Fully qualified domain name. <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> </tr> <tr> <td>fqdn</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">host</span> - Host Address. <span class="li-normal">type: str</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>host</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">host_type</span> - Host type. <span class="li-normal">type: str</span> <span class="li-normal">choices: any, specific</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> </tr> <tr> <td>host_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> </tr> <tr> <td>[any]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[specific]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ip6</span> - IPv6 address prefix (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx). <span class="li-normal">type: str</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>ip6</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">list</span> - IP address list. <span class="li-normal">type: list</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>list</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">ip</span> - IP. <span class="li-normal">type: str</span> <span class="li-required">required: True</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.5 </code></td> <td><code class="docutils literal notranslate">v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> </tr> <tr> <td>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> </tr> </table> </div> </li> <li> <span class="li-head">net_id</span> - Network ID. <span class="li-normal">type: str</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.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> </tr> <tr> <td>net_id</td> <td>yes</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> </tr> </table> </div> </li> <li> <span class="li-head">obj_id</span> - Object ID. <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.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> </tr> <tr> <td>obj_id</td> <td>yes</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">macaddr</span> - Multiple MAC address ranges. <span class="li-normal">type: list</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">v7.0.0 </code></td> </tr> <tr> <td>macaddr</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">macaddr</span> - MAC address ranges <start>[-<end>] separated by space. <span class="li-normal">type: str</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">v7.0.0 </code></td> </tr> <tr> <td>macaddr</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">name</span> - Address name. <span class="li-normal">type: str</span> <span class="li-required">required: True</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> </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> </tr> </table> </div> </li> <li> <span class="li-head">obj_id</span> - Object ID for NSX. <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> </tr> <tr> <td>obj_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> </tr> </table> </div> </li> <li> <span class="li-head">sdn</span> - SDN. Source system.sdn-connector.name. <span class="li-normal">type: str</span> <span class="li-normal">choices: nsx</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> </tr> <tr> <td>sdn</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[nsx]</td> <td>yes</td> <td>yes</td> <td>yes</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> </tr> </table> </div> </li> <li> <span class="li-head">start_ip</span> - First IP address (inclusive) in the range for the address (format: xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx). <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> </tr> <tr> <td>start_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> </tr> </table> </div> </li> <li> <span class="li-head">start_mac</span> - First MAC address in the range. <span class="li-normal">type: str</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>start_mac</td> <td>yes</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>no</td> <td>yes</td> <td>no</td> </tr> </table> </div> </li> <li> <span class="li-head">subnet_segment</span> - IPv6 subnet segments. <span class="li-normal">type: list</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> </tr> <tr> <td>subnet_segment</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">name</span> - Name. <span class="li-normal">type: str</span> <span class="li-required">required: True</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </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> </tr> </table> </div> </li> <li> <span class="li-head">type</span> - Subnet segment type. <span class="li-normal">type: str</span> <span class="li-normal">choices: any, specific</span> <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a> <div id="label51" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </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> </tr> <tr> <td>[any]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[specific]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">value</span> - Subnet segment value. <span class="li-normal">type: str</span> <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a> <div id="label53" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>value</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">tagging</span> - Config object tagging <span class="li-normal">type: list</span> <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a> <div id="label55" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>tagging</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">category</span> - Tag category. Source system.object-tagging.category. <span class="li-normal">type: str</span> <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a> <div id="label57" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>category</td> <td>yes</td> <td>yes</td> <td>yes</td> <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> - Tagging entry name. <span class="li-normal">type: str</span> <span class="li-required">required: True</span> <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a> <div id="label59" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </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> </tr> </table> </div> </li> <li> <span class="li-head">tags</span> - Tags. <span class="li-normal">type: list</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>tags</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">name</span> - Tag name. Source system.object-tagging.tags.name. <span class="li-normal">type: str</span> <span class="li-required">required: True</span> <a id='label62' href="javascript:ContentClick('label63', 'label62');" onmouseover="ContentPreview('label63');" onmouseout="ContentUnpreview('label63');" title="click to collapse or expand..."> more... </a> <div id="label63" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </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> </tr> </table> </div> </li> </ul> </ul> <li> <span class="li-head">template</span> - IPv6 address template. Source firewall.address6-template.name. <span class="li-normal">type: str</span> <a id='label64' href="javascript:ContentClick('label65', 'label64');" onmouseover="ContentPreview('label65');" onmouseout="ContentUnpreview('label65');" title="click to collapse or expand..."> more... </a> <div id="label65" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>template</td> <td>yes</td> <td>yes</td> <td>yes</td> <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 of IPv6 address object . <span class="li-normal">type: str</span> <span class="li-normal">choices: ipprefix, iprange, fqdn, dynamic, template, mac, geography</span> <a id='label66' href="javascript:ContentClick('label67', 'label66');" onmouseover="ContentPreview('label67');" onmouseout="ContentUnpreview('label67');" title="click to collapse or expand..."> more... </a> <div id="label67" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </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> </tr> <tr> <td>[ipprefix]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[iprange]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[fqdn]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[dynamic]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[template]</td> <td>yes</td> <td>yes</td> <td>yes</td> <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>[mac]</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> <td>yes</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>no</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[geography]</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> </tr> </table> </div> </li> <li> <span class="li-head">uuid</span> - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). <span class="li-normal">type: str</span> <a id='label68' href="javascript:ContentClick('label69', 'label68');" onmouseover="ContentPreview('label69');" onmouseout="ContentUnpreview('label69');" title="click to collapse or expand..."> more... </a> <div id="label69" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>uuid</td> <td>yes</td> <td>yes</td> <td>yes</td> <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">visibility</span> - Enable/disable the visibility of the object in the GUI. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label70' href="javascript:ContentClick('label71', 'label70');" onmouseover="ContentPreview('label71');" onmouseout="ContentUnpreview('label71');" title="click to collapse or expand..."> more... </a> <div id="label71" style="display:none"> <table border="1"> <tr> <td></td> <td><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> </tr> <tr> <td>visibility</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>no</td> <td>no</td> <td>no</td> <td>no</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>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</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>n/a</td> <td>n/a</td> <td>n/a</td> <td>n/a</td> </tr> </table> </div> </li> </ul> </ul>

Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
```
- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPv6 firewall addresses.
    fortios_firewall_address6:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address6:
        cache_ttl: "3"
        color: "4"
        comment: "Comment."
        country: "<your_own_value>"
        end_ip: "<your_own_value>"
        end_mac: "<your_own_value>"
        fabric_object: "enable"
        fqdn: "<your_own_value>"
        host: "<your_own_value>"
        host_type: "any"
        ip6: "<your_own_value>"
        list:
         -
            ip: "<your_own_value>"
            net_id: "<your_own_value>"
            obj_id: "<your_own_value>"
        macaddr:
         -
            macaddr: "<your_own_value>"
        name: "default_name_20"
        obj_id: "<your_own_value>"
        sdn: "nsx"
        start_ip: "<your_own_value>"
        start_mac: "<your_own_value>"
        subnet_segment:
         -
            name: "default_name_26"
            type: "any"
            value: "<your_own_value>"
        tagging:
         -
            category: "<your_own_value> (source system.object-tagging.category)"
            name: "default_name_31"
            tags:
             -
                name: "default_name_33 (source system.object-tagging.tags.name)"
        template: "<your_own_value> (source firewall.address6-template.name)"
        type: "ipprefix"
        uuid: "<your_own_value>"
        visibility: "enable"
```
Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
- This module is not guaranteed to have a backwards compatible interface.
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_firewall_address6.rst

fortios_firewall_address6.rst

fortios_firewall_address6 -- Configure IPv6 firewall addresses in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

fortios_firewall_address6.rst

Latest commit

History

fortios_firewall_address6.rst

File metadata and controls

fortios_firewall_address6 -- Configure IPv6 firewall addresses in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors