- source
fortios_wireless_controller_wids_profile.py
- orphan
fortios_wireless_controller_wids_profile -- Configure wireless intrusion detection system (WIDS) profiles in Fortinet's FortiOS and FortiGate.
2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wids_profile 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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_wids_profile - Configure wireless intrusion detection system (WIDS) profiles. 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>wireless_controller_wids_profile</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">ap_auto_suppress</span> - Enable/disable on-wire rogue AP auto-suppression . <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>ap_auto_suppress</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">ap_bgscan_disable_day</span> - Optionally turn off scanning for one or more days of the week. Separate the days with a space. By default, no days are set. <span class="li-normal">type: str</span> <span class="li-normal">choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday</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>ap_bgscan_disable_day</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> <tr> <td>[sunday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[monday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[tuesday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[wednesday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[thursday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[friday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[saturday]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">ap_bgscan_disable_end</span> - End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . <span class="li-normal">type: str</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_bgscan_disable_end</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_bgscan_disable_schedules</span> - Firewall schedules for turning off FortiAP radio background scan. Background scan will be disabled when at least one of the schedules is valid. Separate multiple schedule names with a space. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: ap_bgscan_disable_schedules:name</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>ap_bgscan_disable_schedules</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">name</span> - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>name</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">ap_bgscan_disable_start</span> - Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . <span class="li-normal">type: str</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_bgscan_disable_start</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_bgscan_duration</span> - Listen time on scanning a channel (10 - 1000 msec). <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>ap_bgscan_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">ap_bgscan_idle</span> - Wait time for channel inactivity before scanning this channel (0 - 1000 msec). <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>ap_bgscan_idle</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_bgscan_intv</span> - Period between successive channel scans (1 - 600 sec). <span class="li-normal">type: int</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_bgscan_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_bgscan_period</span> - Period between background scans (10 - 3600 sec). <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>ap_bgscan_period</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_bgscan_report_intv</span> - Period between background scan reports (15 - 600 sec). <span class="li-normal">type: int</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>ap_bgscan_report_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_fgscan_report_intv</span> - Period between foreground scan reports (15 - 600 sec). <span class="li-normal">type: int</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>ap_fgscan_report_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_scan</span> - Enable/disable rogue AP detection. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>ap_scan</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">ap_scan_channel_list_2G_5G</span> - Selected ap scan channel list for 2.4G and 5G bands. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: ap_scan_channel_list_2G_5G:chan</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>ap_scan_channel_list_2G_5G</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">chan</span> - Channel number. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>chan</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">ap_scan_channel_list_6G</span> - Selected ap scan channel list for 6G band. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: ap_scan_channel_list_6G:chan</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>ap_scan_channel_list_6G</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">chan</span> - Channel 6g number. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>chan</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">ap_scan_passive</span> - Enable/disable passive scanning. Enable means do not send probe request on any channels . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>ap_scan_passive</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">ap_scan_threshold</span> - Minimum signal level/threshold in dBm required for the AP to report detected rogue AP (-95 to -20). <span class="li-normal">type: str</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_scan_threshold</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">asleap_attack</span> - Enable/disable asleap attack detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>asleap_attack</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">assoc_flood_thresh</span> - The threshold value for association frame flooding. <span class="li-normal">type: int</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>assoc_flood_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">assoc_flood_time</span> - Number of seconds after which a station is considered not connected. <span class="li-normal">type: int</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>assoc_flood_time</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">assoc_frame_flood</span> - Enable/disable association frame flooding detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>assoc_frame_flood</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">auth_flood_thresh</span> - The threshold value for authentication frame flooding. <span class="li-normal">type: int</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>auth_flood_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auth_flood_time</span> - Number of seconds after which a station is considered not connected. <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>auth_flood_time</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auth_frame_flood</span> - Enable/disable authentication frame flooding detection . <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>auth_frame_flood</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">comment</span> - Comment. <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>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">deauth_broadcast</span> - Enable/disable broadcasting de-authentication detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>deauth_broadcast</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">deauth_unknown_src_thresh</span> - Threshold value per second to deauth unknown src for DoS attack (0: no limit). <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>deauth_unknown_src_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_fail_flood</span> - Enable/disable EAPOL-Failure flooding (to AP) detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>eapol_fail_flood</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">eapol_fail_intv</span> - The detection interval for EAPOL-Failure flooding (1 - 3600 sec). <span class="li-normal">type: int</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>eapol_fail_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_fail_thresh</span> - The threshold value for EAPOL-Failure flooding in specified interval. <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="1">Supported Version Ranges</td> </tr> <tr> <td>eapol_fail_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_logoff_flood</span> - Enable/disable EAPOL-Logoff flooding (to AP) detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>eapol_logoff_flood</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">eapol_logoff_intv</span> - The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). <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>eapol_logoff_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_logoff_thresh</span> - The threshold value for EAPOL-Logoff flooding in specified interval. <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>eapol_logoff_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_pre_fail_flood</span> - Enable/disable premature EAPOL-Failure flooding (to STA) detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>eapol_pre_fail_flood</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">eapol_pre_fail_intv</span> - The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). <span class="li-normal">type: int</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>eapol_pre_fail_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_pre_fail_thresh</span> - The threshold value for premature EAPOL-Failure flooding in specified interval. <span class="li-normal">type: int</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>eapol_pre_fail_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_pre_succ_flood</span> - Enable/disable premature EAPOL-Success flooding (to STA) detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>eapol_pre_succ_flood</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">eapol_pre_succ_intv</span> - The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). <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>eapol_pre_succ_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_pre_succ_thresh</span> - The threshold value for premature EAPOL-Success flooding in specified interval. <span class="li-normal">type: int</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>eapol_pre_succ_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_start_flood</span> - Enable/disable EAPOL-Start flooding (to AP) detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>eapol_start_flood</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">eapol_start_intv</span> - The detection interval for EAPOL-Start flooding (1 - 3600 sec). <span class="li-normal">type: int</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>eapol_start_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_start_thresh</span> - The threshold value for EAPOL-Start flooding in specified interval. <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>eapol_start_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_succ_flood</span> - Enable/disable EAPOL-Success flooding (to AP) detection . <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>eapol_succ_flood</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">eapol_succ_intv</span> - The detection interval for EAPOL-Success flooding (1 - 3600 sec). <span class="li-normal">type: int</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>eapol_succ_intv</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">eapol_succ_thresh</span> - The threshold value for EAPOL-Success flooding in specified interval. <span class="li-normal">type: int</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>eapol_succ_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">invalid_mac_oui</span> - Enable/disable invalid MAC OUI detection. <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>invalid_mac_oui</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">long_duration_attack</span> - Enable/disable long duration attack detection based on user configured threshold . <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>long_duration_attack</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">long_duration_thresh</span> - Threshold value for long duration attack detection (1000 - 32767 usec). <span class="li-normal">type: int</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>long_duration_thresh</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - WIDS profile name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>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">null_ssid_probe_resp</span> - Enable/disable null SSID probe response detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>null_ssid_probe_resp</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">sensor_mode</span> - Scan nearby WiFi stations . <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, foreign, both</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>sensor_mode</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>[foreign]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[both]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">spoofed_deauth</span> - Enable/disable spoofed de-authentication attack detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>spoofed_deauth</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">weak_wep_iv</span> - Enable/disable weak WEP IV (Initialization Vector) detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>weak_wep_iv</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">wireless_bridge</span> - Enable/disable wireless bridge detection . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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="1">Supported Version Ranges</td> </tr> <tr> <td>wireless_bridge</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> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure wireless intrusion detection system (WIDS) profiles. fortinet.fortios.fortios_wireless_controller_wids_profile: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" wireless_controller_wids_profile: ap_auto_suppress: "enable" ap_bgscan_disable_day: "sunday" ap_bgscan_disable_end: "<your_own_value>" ap_bgscan_disable_schedules: - name: "default_name_7 (source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name)" ap_bgscan_disable_start: "<your_own_value>" ap_bgscan_duration: "30" ap_bgscan_idle: "20" ap_bgscan_intv: "3" ap_bgscan_period: "600" ap_bgscan_report_intv: "30" ap_fgscan_report_intv: "15" ap_scan: "disable" ap_scan_channel_list_2G_5G: - chan: "<your_own_value>" ap_scan_channel_list_6G: - chan: "<your_own_value>" ap_scan_passive: "enable" ap_scan_threshold: "<your_own_value>" asleap_attack: "enable" assoc_flood_thresh: "30" assoc_flood_time: "10" assoc_frame_flood: "enable" auth_flood_thresh: "30" auth_flood_time: "10" auth_frame_flood: "enable" comment: "Comment." deauth_broadcast: "enable" deauth_unknown_src_thresh: "10" eapol_fail_flood: "enable" eapol_fail_intv: "1" eapol_fail_thresh: "10" eapol_logoff_flood: "enable" eapol_logoff_intv: "1" eapol_logoff_thresh: "10" eapol_pre_fail_flood: "enable" eapol_pre_fail_intv: "1" eapol_pre_fail_thresh: "10" eapol_pre_succ_flood: "enable" eapol_pre_succ_intv: "1" eapol_pre_succ_thresh: "10" eapol_start_flood: "enable" eapol_start_intv: "1" eapol_start_thresh: "10" eapol_succ_flood: "enable" eapol_succ_intv: "1" eapol_succ_thresh: "10" invalid_mac_oui: "enable" long_duration_attack: "enable" long_duration_thresh: "8200" name: "default_name_53" null_ssid_probe_resp: "enable" sensor_mode: "disable" spoofed_deauth: "enable" weak_wep_iv: "enable" wireless_bridge: "enable"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.