- source
fortios_system_fortiguard.py
- orphan
2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortiguard category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.15
Using member operation to add an element to an existing object.
Supported Version Ranges: v6.0.0 -> 7.4.3
- 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
- system_fortiguard - Configure FortiGuard services. 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>system_fortiguard</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">antispam_cache</span> - Enable/disable FortiGuard antispam request caching. Uses a small amount of memory but improves performance. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>antispam_cache</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">antispam_cache_mpercent</span> - Maximum percentage of FortiGate memory the antispam cache is allowed to use (1 - 15). <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>antispam_cache_mpercent</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">antispam_cache_mpermille</span> - Maximum permille of FortiGate memory the antispam cache is allowed to use (1 - 150). <span class="li-normal">type: int</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>antispam_cache_mpermille</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">antispam_cache_ttl</span> - Time-to-live for antispam cache entries in seconds (300 - 86400). Lower times reduce the cache size. Higher times may improve performance since the cache will have more entries. <span class="li-normal">type: int</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>antispam_cache_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">antispam_expiration</span> - Expiration date of the FortiGuard antispam contract. <span class="li-normal">type: int</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>antispam_expiration</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">antispam_force_off</span> - Enable/disable turning off the FortiGuard antispam service. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>antispam_force_off</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">antispam_license</span> - Interval of time between license checks for the FortiGuard antispam contract. <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="2">Supported Version Ranges</td> </tr> <tr> <td>antispam_license</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">antispam_timeout</span> - Antispam query time out (1 - 30 sec). <span class="li-normal">type: int</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>antispam_timeout</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">anycast_sdns_server_ip</span> - IP address of the FortiGuard anycast DNS rating server. <span class="li-normal">type: str</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>anycast_sdns_server_ip</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">anycast_sdns_server_port</span> - Port to connect to on the FortiGuard anycast DNS rating server. <span class="li-normal">type: int</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>anycast_sdns_server_port</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auto_firmware_upgrade</span> - Enable/disable automatic patch-level firmware upgrade from FortiGuard. The FortiGate unit searches for new patches only in the same major and minor version. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>auto_firmware_upgrade</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">auto_firmware_upgrade_day</span> - Allowed day(s) of the week to install an automatic patch-level firmware upgrade from FortiGuard . Disallow any day of the week to use auto-firmware-upgrade-delay instead, which waits for designated days before installing an automatic patch-level firmware upgrade. <span class="li-normal">type: list</span> <span class="li-normal">choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday</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>auto_firmware_upgrade_day</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> <tr> <td>[sunday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[monday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[tuesday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[wednesday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[thursday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[friday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[saturday]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">auto_firmware_upgrade_delay</span> - Delay of day(s) before installing an automatic patch-level firmware upgrade from FortiGuard of the week for installing an automatic patch-level firmware upgrade. <span class="li-normal">type: int</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>auto_firmware_upgrade_delay</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auto_firmware_upgrade_end_hour</span> - End time in the designated time window for automatic patch-level firmware upgrade from FortiGuard in 24 hour time (0 ~ 23). When the end time is smaller than the start time, the end time is interpreted as the next day. The actual upgrade time is selected randomly within the time window. <span class="li-normal">type: int</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auto_firmware_upgrade_end_hour</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auto_firmware_upgrade_start_hour</span> - Start time in the designated time window for automatic patch-level firmware upgrade from FortiGuard in 24 hour time (0 ~ 23). The actual upgrade time is selected randomly within the time window. <span class="li-normal">type: int</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>auto_firmware_upgrade_start_hour</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auto_join_forticloud</span> - Automatically connect to and login to FortiCloud. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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="0">Supported Version Ranges</td> </tr> <tr> <td>auto_join_forticloud</td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> v7.0.12</code></td> <td><code class="docutils literal notranslate">v7.2.1 -> v7.2.2</code></td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> v7.0.12</code></td> <td><code class="docutils literal notranslate">v7.2.1 -> v7.2.2</code></td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </tr> </table> </div> </li> <li> <span class="li-head">ddns_server_ip</span> - IP address of the FortiDDNS server. <span class="li-normal">type: str</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ddns_server_ip</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ddns_server_ip6</span> - IPv6 address of the FortiDDNS server. <span class="li-normal">type: str</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ddns_server_ip6</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ddns_server_port</span> - Port used to communicate with FortiDDNS servers. <span class="li-normal">type: int</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>ddns_server_port</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">FDS_license_expiring_days</span> - Threshold for number of days before FortiGuard license expiration to generate license expiring event log (1 - 100 days). <span class="li-normal">type: int</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>FDS_license_expiring_days</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">fortiguard_anycast</span> - Enable/disable use of FortiGuard"s Anycast network. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>fortiguard_anycast</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">fortiguard_anycast_source</span> - Configure which of Fortinet"s servers to provide FortiGuard services in FortiGuard"s anycast network. Default is Fortinet. <span class="li-normal">type: str</span> <span class="li-normal">choices: fortinet, aws, debug</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>fortiguard_anycast_source</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[fortinet]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[aws]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[debug]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">interface</span> - Specify outgoing interface to reach server. Source system.interface.name. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>interface</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> </table> </div> </li> <li> <span class="li-head">interface_select_method</span> - Specify how to select outgoing interface to reach server. <span class="li-normal">type: str</span> <span class="li-normal">choices: auto, sdwan, specify</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>interface_select_method</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>[auto]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.0</code></td> <tr> <td>[sdwan]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.0</code></td> <tr> <td>[specify]</td> <td><code class="docutils literal notranslate">v6.2.0 -> v6.2.0</code></td> </table> </div> </li> <li> <span class="li-head">load_balance_servers</span> - Number of servers to alternate between as first FortiGuard option. <span class="li-normal">type: int</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>load_balance_servers</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">outbreak_prevention_cache</span> - Enable/disable FortiGuard Virus Outbreak Prevention cache. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>outbreak_prevention_cache</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">outbreak_prevention_cache_mpercent</span> - Maximum percent of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 15%). <span class="li-normal">type: int</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>outbreak_prevention_cache_mpercent</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.2.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">outbreak_prevention_cache_mpermille</span> - Maximum permille of memory FortiGuard Virus Outbreak Prevention cache can use (1 - 150 permille). <span class="li-normal">type: int</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>outbreak_prevention_cache_mpermille</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">outbreak_prevention_cache_ttl</span> - Time-to-live for FortiGuard Virus Outbreak Prevention cache entries (300 - 86400 sec). <span class="li-normal">type: int</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>outbreak_prevention_cache_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">outbreak_prevention_expiration</span> - Expiration date of FortiGuard Virus Outbreak Prevention contract. <span class="li-normal">type: int</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>outbreak_prevention_expiration</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">outbreak_prevention_force_off</span> - Turn off FortiGuard Virus Outbreak Prevention service. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>outbreak_prevention_force_off</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">outbreak_prevention_license</span> - Interval of time between license checks for FortiGuard Virus Outbreak Prevention contract. <span class="li-normal">type: int</span> <a id='label64' href="javascript:ContentClick('label65', 'label64');" onmouseover="ContentPreview('label65');" onmouseout="ContentUnpreview('label65');" title="click to collapse or expand..."> more... </a> <div id="label65" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>outbreak_prevention_license</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">outbreak_prevention_timeout</span> - FortiGuard Virus Outbreak Prevention time out (1 - 30 sec). <span class="li-normal">type: int</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>outbreak_prevention_timeout</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">persistent_connection</span> - Enable/disable use of persistent connection to receive update notification from FortiGuard. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>persistent_connection</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">port</span> - Port used to communicate with the FortiGuard servers. <span class="li-normal">type: str</span> <span class="li-normal">choices: 8888, 53, 80, 443</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>port</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[8888]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[53]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[80]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[443]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </tr> </table> </div> </li> <li> <span class="li-head">protocol</span> - Protocol used to communicate with the FortiGuard servers. <span class="li-normal">type: str</span> <span class="li-normal">choices: udp, http, https</span> <a id='label72' href="javascript:ContentClick('label73', 'label72');" onmouseover="ContentPreview('label73');" onmouseout="ContentUnpreview('label73');" title="click to collapse or expand..."> more... </a> <div id="label73" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>protocol</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.0 </code></td> <td><code class="docutils literal notranslate">v6.0.11 -> 7.4.3 </code></td> </tr> <tr> <td>[udp]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.0</code></td> <tr> <td>[http]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.0</code></td> <tr> <td>[https]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.0</code></td> </table> </div> </li> <li> <span class="li-head">proxy_password</span> - Proxy user password. <span class="li-normal">type: str</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>proxy_password</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">proxy_server_ip</span> - Hostname or IPv4 address of the proxy server. <span class="li-normal">type: str</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>proxy_server_ip</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">proxy_server_port</span> - Port used to communicate with the proxy server. <span class="li-normal">type: int</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>proxy_server_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">proxy_username</span> - Proxy user name. <span class="li-normal">type: str</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>proxy_username</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sandbox_inline_scan</span> - Enable/disable FortiCloud Sandbox inline-scan. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>sandbox_inline_scan</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">sandbox_region</span> - FortiCloud Sandbox region. <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>sandbox_region</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">sdns_options</span> - Customization options for the FortiGuard DNS service. <span class="li-normal">type: list</span> <span class="li-normal">choices: include-question-section</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>sdns_options</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[include-question-section]</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">sdns_server_ip</span> - IP address of the FortiGuard DNS rating server. <span class="li-normal">type: list</span> </li> <li> <span class="li-head">sdns_server_port</span> - Port to connect to on the FortiGuard DNS rating server. <span class="li-normal">type: int</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>sdns_server_port</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">service_account_id</span> - Service account ID. <span class="li-normal">type: str</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="4">Supported Version Ranges</td> </tr> <tr> <td>service_account_id</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> <td><code class="docutils literal notranslate">v7.0.12 -> v7.0.12 </code></td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">source_ip</span> - Source IPv4 address used to communicate with FortiGuard. <span class="li-normal">type: str</span> <a id='label92' href="javascript:ContentClick('label93', 'label92');" onmouseover="ContentPreview('label93');" onmouseout="ContentUnpreview('label93');" title="click to collapse or expand..."> more... </a> <div id="label93" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>source_ip</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">source_ip6</span> - Source IPv6 address used to communicate with FortiGuard. <span class="li-normal">type: str</span> <a id='label94' href="javascript:ContentClick('label95', 'label94');" onmouseover="ContentPreview('label95');" onmouseout="ContentUnpreview('label95');" title="click to collapse or expand..."> more... </a> <div id="label95" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>source_ip6</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">update_build_proxy</span> - Enable/disable proxy dictionary rebuild. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>update_build_proxy</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">update_dldb</span> - Enable/disable DLP signature update. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>update_dldb</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">update_extdb</span> - Enable/disable external resource update. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>update_extdb</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">update_ffdb</span> - Enable/disable Internet Service Database update. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>update_ffdb</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">update_server_location</span> - Location from which to receive FortiGuard updates. <span class="li-normal">type: str</span> <span class="li-normal">choices: automatic, usa, eu, any</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>update_server_location</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[automatic]</td> <td><code class="docutils literal notranslate">v7.0.2 -> 7.4.3</code></td> </tr> <tr> <td>[usa]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[eu]</td> <td><code class="docutils literal notranslate">v7.0.2 -> 7.4.3</code></td> </tr> <tr> <td>[any]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.1</code></td> </tr> </table> </div> </li> <li> <span class="li-head">update_uwdb</span> - Enable/disable allowlist update. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>update_uwdb</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">vdom</span> - FortiGuard Service virtual domain name. Source system.vdom.name. <span class="li-normal">type: str</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>vdom</td> <td><code class="docutils literal notranslate">v7.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">videofilter_expiration</span> - Expiration date of the FortiGuard video filter contract. <span class="li-normal">type: int</span> <a id='label110' href="javascript:ContentClick('label111', 'label110');" onmouseover="ContentPreview('label111');" onmouseout="ContentUnpreview('label111');" title="click to collapse or expand..."> more... </a> <div id="label111" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>videofilter_expiration</td> <td><code class="docutils literal notranslate">v7.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">videofilter_license</span> - Interval of time between license checks for the FortiGuard video filter contract. <span class="li-normal">type: int</span> <a id='label112' href="javascript:ContentClick('label113', 'label112');" onmouseover="ContentPreview('label113');" onmouseout="ContentUnpreview('label113');" title="click to collapse or expand..."> more... </a> <div id="label113" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>videofilter_license</td> <td><code class="docutils literal notranslate">v7.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">webfilter_cache</span> - Enable/disable FortiGuard web filter caching. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label114' href="javascript:ContentClick('label115', 'label114');" onmouseover="ContentPreview('label115');" onmouseout="ContentUnpreview('label115');" title="click to collapse or expand..."> more... </a> <div id="label115" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>webfilter_cache</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">webfilter_cache_ttl</span> - Time-to-live for web filter cache entries in seconds (300 - 86400). <span class="li-normal">type: int</span> <a id='label116' href="javascript:ContentClick('label117', 'label116');" onmouseover="ContentPreview('label117');" onmouseout="ContentUnpreview('label117');" title="click to collapse or expand..."> more... </a> <div id="label117" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>webfilter_cache_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">webfilter_expiration</span> - Expiration date of the FortiGuard web filter contract. <span class="li-normal">type: int</span> <a id='label118' href="javascript:ContentClick('label119', 'label118');" onmouseover="ContentPreview('label119');" onmouseout="ContentUnpreview('label119');" title="click to collapse or expand..."> more... </a> <div id="label119" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>webfilter_expiration</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">webfilter_force_off</span> - Enable/disable turning off the FortiGuard web filtering service. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label120' href="javascript:ContentClick('label121', 'label120');" onmouseover="ContentPreview('label121');" onmouseout="ContentUnpreview('label121');" title="click to collapse or expand..."> more... </a> <div id="label121" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>webfilter_force_off</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">webfilter_license</span> - Interval of time between license checks for the FortiGuard web filter contract. <span class="li-normal">type: int</span> <a id='label122' href="javascript:ContentClick('label123', 'label122');" onmouseover="ContentPreview('label123');" onmouseout="ContentUnpreview('label123');" title="click to collapse or expand..."> more... </a> <div id="label123" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>webfilter_license</td> <td><code class="docutils literal notranslate">v6.0.0 -> v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.0 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">webfilter_timeout</span> - Web filter query time out (1 - 30 sec). <span class="li-normal">type: int</span> <a id='label124' href="javascript:ContentClick('label125', 'label124');" onmouseover="ContentPreview('label125');" onmouseout="ContentUnpreview('label125');" title="click to collapse or expand..."> more... </a> <div id="label125" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>webfilter_timeout</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure FortiGuard services. fortinet.fortios.fortios_system_fortiguard: vdom: "{{ vdom }}" system_fortiguard: antispam_cache: "enable" antispam_cache_mpercent: "2" antispam_cache_mpermille: "1" antispam_cache_ttl: "1800" antispam_expiration: "0" antispam_force_off: "enable" antispam_license: "4294967295" antispam_timeout: "7" anycast_sdns_server_ip: "<your_own_value>" anycast_sdns_server_port: "853" auto_firmware_upgrade: "enable" auto_firmware_upgrade_day: "sunday" auto_firmware_upgrade_delay: "3" auto_firmware_upgrade_end_hour: "4" auto_firmware_upgrade_start_hour: "1" auto_join_forticloud: "enable" ddns_server_ip: "<your_own_value>" ddns_server_ip6: "<your_own_value>" ddns_server_port: "443" FDS_license_expiring_days: "15" fortiguard_anycast: "enable" fortiguard_anycast_source: "fortinet" interface: "<your_own_value> (source system.interface.name)" interface_select_method: "auto" load_balance_servers: "1" outbreak_prevention_cache: "enable" outbreak_prevention_cache_mpercent: "2" outbreak_prevention_cache_mpermille: "1" outbreak_prevention_cache_ttl: "300" outbreak_prevention_expiration: "0" outbreak_prevention_force_off: "enable" outbreak_prevention_license: "4294967295" outbreak_prevention_timeout: "7" persistent_connection: "enable" port: "8888" protocol: "udp" proxy_password: "<your_own_value>" proxy_server_ip: "<your_own_value>" proxy_server_port: "0" proxy_username: "<your_own_value>" sandbox_inline_scan: "enable" sandbox_region: "<your_own_value>" sdns_options: "include-question-section" sdns_server_ip: "<your_own_value>" sdns_server_port: "53" service_account_id: "<your_own_value>" source_ip: "84.230.14.43" source_ip6: "<your_own_value>" update_build_proxy: "enable" update_dldb: "enable" update_extdb: "enable" update_ffdb: "enable" update_server_location: "automatic" update_uwdb: "enable" vdom: "<your_own_value> (source system.vdom.name)" videofilter_expiration: "0" videofilter_license: "4294967295" webfilter_cache: "enable" webfilter_cache_ttl: "3600" webfilter_expiration: "0" webfilter_force_off: "enable" webfilter_license: "4294967295" webfilter_timeout: "15"Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
- This module is not guaranteed to have a backwards compatible interface.
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Hint
If you notice any issues in this documentation, you can create a pull request to improve it.