Skip to content

Latest commit

 

History

History
1247 lines (1206 loc) · 53.4 KB

fortios_application_list.rst

File metadata and controls

1247 lines (1206 loc) · 53.4 KB
source

fortios_application_list.py

orphan

fortios_application_list -- Configure application control lists in Fortinet's FortiOS and FortiGate.

2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • application_list - Configure application control lists. type: dict

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>application_list</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">app_replacemsg</span> - Enable/disable replacement messages for blocked applications. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>app_replacemsg</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">comment</span> - Comments. <span class="li-normal">type: str</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>comment</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">control_default_network_services</span> - Enable/disable enforcement of protocols over selected ports. <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>control_default_network_services</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">deep_app_inspection</span> - Enable/disable deep application inspection. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>deep_app_inspection</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">default_network_services</span> - Default network service entries. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: default_network_services:id</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>default_network_services</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">port</span> - Port number. <span class="li-normal">type: int</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>port</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">services</span> - Network protocols. <span class="li-normal">type: list</span> <span class="li-normal">choices: http, ssh, telnet, ftp, dns, smtp, pop3, imap, snmp, nntp, https</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>services</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[http]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[ssh]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[telnet]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[ftp]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[dns]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[smtp]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[pop3]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[imap]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[snmp]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[nntp]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[https]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">violation_action</span> - Action for protocols not in the allowlist for selected port. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, monitor, block</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>violation_action</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[pass]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[monitor]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> </ul> <li> <span class="li-head">enforce_default_app_port</span> - Enable/disable default application port enforcement for allowed applications. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>enforce_default_app_port</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">entries</span> - Application list entries. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>entries</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">action</span> - Pass or block traffic, or reset connection for traffic from this application. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, block, reset</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>action</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[pass]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[reset]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">application</span> - ID of allowed applications. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/application:id</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>application</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Application IDs. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">behavior</span> - Application behavior filter. <span class="li-normal">type: list</span> </li> <li> <span class="li-head">category</span> - Category ID list. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/category:id</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>category</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Application category ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">exclusion</span> - ID of excluded applications. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/exclusion:id</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td><td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>exclusion</td> <td><code class="docutils literal notranslate">v6.2.7 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Excluded application IDs. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</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 colspan="2">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.2.7 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">id</span> - Entry ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">log</span> - Enable/disable logging for this application list. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>log</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">log_packet</span> - Enable/disable packet logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>log_packet</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">parameters</span> - Application parameters. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/parameters:id</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>parameters</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Parameter tuple ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">members</span> - Parameter tuple members. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/parameters:id/members:id</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>members</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Parameter. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a> <div id="label51" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Parameter name. <span class="li-normal">type: str</span> <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a> <div id="label53" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">value</span> - Parameter value. <span class="li-normal">type: str</span> <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a> <div id="label55" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>value</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">value</span> - Parameter value. <span class="li-normal">type: str</span> <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a> <div id="label57" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>value</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">per_ip_shaper</span> - Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. <span class="li-normal">type: str</span> <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a> <div id="label59" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>per_ip_shaper</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">popularity</span> - Application popularity filter (1 - 5, from least to most popular). <span class="li-normal">type: list</span> <span class="li-normal">choices: 1, 2, 3, 4, 5</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>popularity</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[1]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[3]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[4]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[5]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">protocols</span> - Application protocol filter. <span class="li-normal">type: list</span> </li> <li> <span class="li-head">quarantine</span> - Quarantine method. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, attacker</span> <a id='label62' href="javascript:ContentClick('label63', 'label62');" onmouseover="ContentPreview('label63');" onmouseout="ContentUnpreview('label63');" title="click to collapse or expand..."> more... </a> <div id="label63" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>quarantine</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[attacker]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">quarantine_expiry</span> - Duration of quarantine. (Format <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>quarantine_expiry</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">quarantine_log</span> - Enable/disable quarantine logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label66' href="javascript:ContentClick('label67', 'label66');" onmouseover="ContentPreview('label67');" onmouseout="ContentUnpreview('label67');" title="click to collapse or expand..."> more... </a> <div id="label67" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>quarantine_log</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">rate_count</span> - Count of the rate. <span class="li-normal">type: int</span> <a id='label68' href="javascript:ContentClick('label69', 'label68');" onmouseover="ContentPreview('label69');" onmouseout="ContentUnpreview('label69');" title="click to collapse or expand..."> more... </a> <div id="label69" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rate_count</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">rate_duration</span> - Duration (sec) of the rate. <span class="li-normal">type: int</span> <a id='label70' href="javascript:ContentClick('label71', 'label70');" onmouseover="ContentPreview('label71');" onmouseout="ContentUnpreview('label71');" title="click to collapse or expand..."> more... </a> <div id="label71" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rate_duration</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">rate_mode</span> - Rate limit mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: periodical, continuous</span> <a id='label72' href="javascript:ContentClick('label73', 'label72');" onmouseover="ContentPreview('label73');" onmouseout="ContentUnpreview('label73');" title="click to collapse or expand..."> more... </a> <div id="label73" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rate_mode</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[periodical]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[continuous]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">rate_track</span> - Track the packet protocol field. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, src-ip, dest-ip, dhcp-client-mac, dns-domain</span> <a id='label74' href="javascript:ContentClick('label75', 'label74');" onmouseover="ContentPreview('label75');" onmouseout="ContentUnpreview('label75');" title="click to collapse or expand..."> more... </a> <div id="label75" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rate_track</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[src-ip]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[dest-ip]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[dhcp-client-mac]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[dns-domain]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">risk</span> - Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/risk:level</span> <a id='label76' href="javascript:ContentClick('label77', 'label76');" onmouseover="ContentPreview('label77');" onmouseout="ContentUnpreview('label77');" title="click to collapse or expand..."> more... </a> <div id="label77" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>risk</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">level</span> - Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label78' href="javascript:ContentClick('label79', 'label78');" onmouseover="ContentPreview('label79');" onmouseout="ContentUnpreview('label79');" title="click to collapse or expand..."> more... </a> <div id="label79" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>level</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">session_ttl</span> - Session TTL (0 = default). <span class="li-normal">type: int</span> <a id='label80' href="javascript:ContentClick('label81', 'label80');" onmouseover="ContentPreview('label81');" onmouseout="ContentUnpreview('label81');" title="click to collapse or expand..."> more... </a> <div id="label81" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>session_ttl</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">shaper</span> - Traffic shaper. Source firewall.shaper.traffic-shaper.name. <span class="li-normal">type: str</span> <a id='label82' href="javascript:ContentClick('label83', 'label82');" onmouseover="ContentPreview('label83');" onmouseout="ContentUnpreview('label83');" title="click to collapse or expand..."> more... </a> <div id="label83" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>shaper</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">shaper_reverse</span> - Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. <span class="li-normal">type: str</span> <a id='label84' href="javascript:ContentClick('label85', 'label84');" onmouseover="ContentPreview('label85');" onmouseout="ContentUnpreview('label85');" title="click to collapse or expand..."> more... </a> <div id="label85" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>shaper_reverse</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sub_category</span> - Application Sub-category ID list. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: entries:id/sub_category:id</span> <a id='label86' href="javascript:ContentClick('label87', 'label86');" onmouseover="ContentPreview('label87');" onmouseout="ContentUnpreview('label87');" title="click to collapse or expand..."> more... </a> <div id="label87" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sub_category</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Application sub-category ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</span> <a id='label88' href="javascript:ContentClick('label89', 'label88');" onmouseover="ContentPreview('label89');" onmouseout="ContentUnpreview('label89');" title="click to collapse or expand..."> more... </a> <div id="label89" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">technology</span> - Application technology filter. <span class="li-normal">type: list</span> </li> <li> <span class="li-head">vendor</span> - Application vendor filter. <span class="li-normal">type: list</span> </li> </ul> <li> <span class="li-head">extended_log</span> - Enable/disable extended logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label90' href="javascript:ContentClick('label91', 'label90');" onmouseover="ContentPreview('label91');" onmouseout="ContentUnpreview('label91');" title="click to collapse or expand..."> more... </a> <div id="label91" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>extended_log</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">force_inclusion_ssl_di_sigs</span> - Enable/disable forced inclusion of SSL deep inspection signatures. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label92' href="javascript:ContentClick('label93', 'label92');" onmouseover="ContentPreview('label93');" onmouseout="ContentUnpreview('label93');" title="click to collapse or expand..."> more... </a> <div id="label93" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>force_inclusion_ssl_di_sigs</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.5 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.0</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.0</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - List name. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label94' href="javascript:ContentClick('label95', 'label94');" onmouseover="ContentPreview('label95');" onmouseout="ContentUnpreview('label95');" title="click to collapse or expand..."> more... </a> <div id="label95" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">options</span> - Basic application protocol signatures allowed by default. <span class="li-normal">type: list</span> <span class="li-normal">choices: allow-dns, allow-icmp, allow-http, allow-ssl, allow-quic</span> <a id='label96' href="javascript:ContentClick('label97', 'label96');" onmouseover="ContentPreview('label97');" onmouseout="ContentUnpreview('label97');" title="click to collapse or expand..."> more... </a> <div id="label97" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>options</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[allow-dns]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[allow-icmp]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[allow-http]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[allow-ssl]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[allow-quic]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.2</code></td> </tr> </table> </div> </li> <li> <span class="li-head">other_application_action</span> - Action for other applications. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, block</span> <a id='label98' href="javascript:ContentClick('label99', 'label98');" onmouseover="ContentPreview('label99');" onmouseout="ContentUnpreview('label99');" title="click to collapse or expand..."> more... </a> <div id="label99" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>other_application_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[pass]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">other_application_log</span> - Enable/disable logging for other applications. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label100' href="javascript:ContentClick('label101', 'label100');" onmouseover="ContentPreview('label101');" onmouseout="ContentUnpreview('label101');" title="click to collapse or expand..."> more... </a> <div id="label101" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>other_application_log</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">p2p_black_list</span> - P2P applications to be black listed. <span class="li-normal">type: list</span> <span class="li-normal">choices: skype, edonkey, bittorrent</span> <a id='label102' href="javascript:ContentClick('label103', 'label102');" onmouseover="ContentPreview('label103');" onmouseout="ContentUnpreview('label103');" title="click to collapse or expand..."> more... </a> <div id="label103" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>p2p_black_list</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[skype]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[edonkey]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[bittorrent]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">p2p_block_list</span> - P2P applications to be block listed. <span class="li-normal">type: list</span> <span class="li-normal">choices: skype, edonkey, bittorrent</span> <a id='label104' href="javascript:ContentClick('label105', 'label104');" onmouseover="ContentPreview('label105');" onmouseout="ContentUnpreview('label105');" title="click to collapse or expand..."> more... </a> <div id="label105" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>p2p_block_list</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[skype]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[edonkey]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[bittorrent]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">replacemsg_group</span> - Replacement message group. Source system.replacemsg-group.name. <span class="li-normal">type: str</span> <a id='label106' href="javascript:ContentClick('label107', 'label106');" onmouseover="ContentPreview('label107');" onmouseout="ContentUnpreview('label107');" title="click to collapse or expand..."> more... </a> <div id="label107" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>replacemsg_group</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">unknown_application_action</span> - Pass or block traffic from unknown applications. <span class="li-normal">type: str</span> <span class="li-normal">choices: pass, block</span> <a id='label108' href="javascript:ContentClick('label109', 'label108');" onmouseover="ContentPreview('label109');" onmouseout="ContentUnpreview('label109');" title="click to collapse or expand..."> more... </a> <div id="label109" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>unknown_application_action</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[pass]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[block]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">unknown_application_log</span> - Enable/disable logging for unknown applications. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> <a id='label110' href="javascript:ContentClick('label111', 'label110');" onmouseover="ContentPreview('label111');" onmouseout="ContentUnpreview('label111');" title="click to collapse or expand..."> more... </a> <div id="label111" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>unknown_application_log</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> </ul> </ul>

    Notes

    Note

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

    Examples

    - name: Configure application control lists.
      fortinet.fortios.fortios_application_list:
          vdom: "{{ vdom }}"
          state: "present"
          access_token: "<your_own_value>"
          application_list:
              app_replacemsg: "disable"
              comment: "Comments."
              control_default_network_services: "disable"
              deep_app_inspection: "disable"
              default_network_services:
                  -
                      id: "8"
                      port: "0"
                      services: "http"
                      violation_action: "pass"
              enforce_default_app_port: "disable"
              entries:
                  -
                      action: "pass"
                      application:
                          -
                              id: "16"
                      behavior: "<your_own_value>"
                      category:
                          -
                              id: "19"
                      exclusion:
                          -
                              id: "21"
                      id: "22"
                      log: "disable"
                      log_packet: "disable"
                      parameters:
                          -
                              id: "26"
                              members:
                                  -
                                      id: "28"
                                      name: "default_name_29"
                                      value: "<your_own_value>"
                              value: "<your_own_value>"
                      per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
                      popularity: "1"
                      protocols: "<your_own_value>"
                      quarantine: "none"
                      quarantine_expiry: "<your_own_value>"
                      quarantine_log: "disable"
                      rate_count: "0"
                      rate_duration: "60"
                      rate_mode: "periodical"
                      rate_track: "none"
                      risk:
                          -
                              level: "<you_own_value>"
                      session_ttl: "0"
                      shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
                      shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
                      sub_category:
                          -
                              id: "48"
                      technology: "<your_own_value>"
                      vendor: "<your_own_value>"
              extended_log: "enable"
              force_inclusion_ssl_di_sigs: "disable"
              name: "default_name_53"
              options: "allow-dns"
              other_application_action: "pass"
              other_application_log: "disable"
              p2p_black_list: "skype"
              p2p_block_list: "skype"
              replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
              unknown_application_action: "pass"
              unknown_application_log: "disable"

    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.