fortinet.fortios.fortios_wireless_controller_wids_profile module – Configure wireless intrusion detection system (WIDS) profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.4.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_wireless_controller_wids_profile.
New in fortinet.fortios 2.0.0
Synopsis
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
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
|
Configure wireless intrusion detection system (WIDS) profiles. |
|
Enable/disable adhoc network detection . Choices:
|
|
Enable/disable adhoc using valid SSID detection . Choices:
|
|
Enable/disable AirJack detection . Choices:
|
|
Enable/disable on-wire rogue AP auto-suppression . Choices:
|
|
Optionally turn off scanning for one or more days of the week. Separate the days with a space. By default, no days are set. Choices:
|
|
End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . |
|
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. |
|
Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. |
|
Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . |
|
Listen time on scanning a channel (10 - 1000 msec). |
|
Wait time for channel inactivity before scanning this channel (0 - 1000 msec). |
|
Period between successive channel scans (1 - 600 sec). |
|
Period between background scans (10 - 3600 sec). |
|
Period between background scan reports (15 - 600 sec). |
|
Period between foreground scan reports (15 - 600 sec). |
|
Enable/disable AP impersonation detection . Choices:
|
|
Enable/disable rogue AP detection. Choices:
|
|
Selected ap scan channel list for 2.4G and 5G bands. |
|
Channel number. |
|
Selected ap scan channel list for 6G band. |
|
Channel 6g number. |
|
Enable/disable passive scanning. Enable means do not send probe request on any channels . Choices:
|
|
Minimum signal level/threshold in dBm required for the AP to report detected rogue AP (-95 to -20). |
|
Enable/disable AP spoofing detection . Choices:
|
|
Enable/disable asleap attack detection . Choices:
|
|
The threshold value for association frame flooding. |
|
Number of seconds after which a station is considered not connected. |
|
Enable/disable association frame flooding detection . Choices:
|
|
The threshold value for authentication frame flooding. |
|
Number of seconds after which a station is considered not connected. |
|
Enable/disable authentication frame flooding detection . Choices:
|
|
Enable/disable bcn flood detection . Choices:
|
|
The threshold value for bcn flood. |
|
Detection Window Period. |
|
Enable/disable beacon wrong channel detection . Choices:
|
|
Enable/disable block_ack flood detection . Choices:
|
|
The threshold value for block_ack flood. |
|
Detection Window Period. |
|
Enable/disable channel based mitm detection . Choices:
|
|
Enable/disable client flood detection . Choices:
|
|
The threshold value for client flood. |
|
Detection Window Period. |
|
Comment. |
|
Enable/disable cts flood detection . Choices:
|
|
The threshold value for cts flood. |
|
Detection Window Period. |
|
Enable/disable broadcasting de-authentication detection . Choices:
|
|
Threshold value per second to deauth unknown src for DoS attack (0: no limit). |
|
Enable/disable broadcast dis-association detection . Choices:
|
|
Enable/disable disconnect station detection . Choices:
|
|
Enable/disable EAPOL-Failure flooding (to AP) detection . Choices:
|
|
The detection interval for EAPOL-Failure flooding (1 - 3600 sec). |
|
The threshold value for EAPOL-Failure flooding in specified interval. |
|
Enable/disable overflow EAPOL key detection . Choices:
|
|
Enable/disable EAPOL-Logoff flooding (to AP) detection . Choices:
|
|
The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). |
|
The threshold value for EAPOL-Logoff flooding in specified interval. |
|
Enable/disable premature EAPOL-Failure flooding (to STA) detection . Choices:
|
|
The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). |
|
The threshold value for premature EAPOL-Failure flooding in specified interval. |
|
Enable/disable premature EAPOL-Success flooding (to STA) detection . Choices:
|
|
The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). |
|
The threshold value for premature EAPOL-Success flooding in specified interval. |
|
Enable/disable EAPOL-Start flooding (to AP) detection . Choices:
|
|
The detection interval for EAPOL-Start flooding (1 - 3600 sec). |
|
The threshold value for EAPOL-Start flooding in specified interval. |
|
Enable/disable EAPOL-Success flooding (to AP) detection . Choices:
|
|
The detection interval for EAPOL-Success flooding (1 - 3600 sec). |
|
The threshold value for EAPOL-Success flooding in specified interval. |
|
Enable/disable FATA-Jack detection . Choices:
|
|
Enable/disable fuzzed beacon detection . Choices:
|
|
Enable/disable fuzzed probe request detection . Choices:
|
|
Enable/disable fuzzed probe response detection . Choices:
|
|
Enable/disable hotspotter attack detection . Choices:
|
|
Enable/disable HT 40 MHz intolerance detection . Choices:
|
|
Enable/disable HT greenfield detection . Choices:
|
|
Enable/disable invalid address combination detection . Choices:
|
|
Enable/disable invalid MAC OUI detection. Choices:
|
|
Enable/disable long duration attack detection based on user configured threshold . Choices:
|
|
Threshold value for long duration attack detection (1000 - 32767 usec). |
|
Enable/disable malformed association request detection . Choices:
|
|
Enable/disable malformed auth frame detection . Choices:
|
|
Enable/disable malformed HT IE detection . Choices:
|
|
WIDS profile name. |
|
Enable/disable netstumbler detection . Choices:
|
|
The threshold value for netstumbler. |
|
Detection Window Period. |
|
Enable/disable null SSID probe response detection . Choices:
|
|
Enable/disable omerta attack detection . Choices:
|
|
Enable/disable overflow IE detection . Choices:
|
|
Enable/disable probe flood detection . Choices:
|
|
The threshold value for probe flood. |
|
Detection Window Period. |
|
Enable/disable pspoll flood detection . Choices:
|
|
The threshold value for pspoll flood. |
|
Detection Window Period. |
|
Enable/disable power save DOS attack detection . Choices:
|
|
Enable/disable reassociation flood detection . Choices:
|
|
The threshold value for reassociation flood. |
|
Detection Window Period. |
|
Enable/disable Risky Encryption detection . Choices:
|
|
Enable/disable rts flood detection . Choices:
|
|
The threshold value for rts flood. |
|
Detection Window Period. |
|
Scan nearby WiFi stations . Choices:
|
|
Enable/disable spoofed de-authentication attack detection . Choices:
|
|
Enable/disable unencrypted valid detection . Choices:
|
|
Enable/disable valid client misassociation detection . Choices:
|
|
Enable/disable valid SSID misuse detection . Choices:
|
|
Enable/disable weak WEP IV (Initialization Vector) detection . Choices:
|
|
Enable/disable wellenreiter detection . Choices:
|
|
The threshold value for wellenreiter. |
|
Detection Window Period. |
|
Enable/disable windows bridge detection . Choices:
|
|
Enable/disable wireless bridge detection . Choices:
|
|
Enable/disable WPA FT attack detection . Choices:
|
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- 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:
adhoc_network: "enable"
adhoc_valid_ssid: "enable"
air_jack: "enable"
ap_auto_suppress: "enable"
ap_bgscan_disable_day: "sunday"
ap_bgscan_disable_end: "<your_own_value>"
ap_bgscan_disable_schedules:
-
name: "default_name_10 (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_impersonation: "enable"
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>"
ap_spoofing: "enable"
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"
bcn_flood: "enable"
bcn_flood_thresh: "15"
bcn_flood_time: "1"
beacon_wrong_channel: "enable"
block_ack_flood: "enable"
block_ack_flood_thresh: "50"
block_ack_flood_time: "1"
chan_based_mitm: "enable"
client_flood: "enable"
client_flood_thresh: "30"
client_flood_time: "10"
comment: "Comment."
cts_flood: "enable"
cts_flood_thresh: "30"
cts_flood_time: "10"
deauth_broadcast: "enable"
deauth_unknown_src_thresh: "10"
disassoc_broadcast: "enable"
disconnect_station: "enable"
eapol_fail_flood: "enable"
eapol_fail_intv: "1"
eapol_fail_thresh: "10"
eapol_key_overflow: "enable"
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"
fata_jack: "enable"
fuzzed_beacon: "enable"
fuzzed_probe_request: "enable"
fuzzed_probe_response: "enable"
hotspotter_attack: "enable"
ht_40mhz_intolerance: "enable"
ht_greenfield: "enable"
invalid_addr_combination: "enable"
invalid_mac_oui: "enable"
long_duration_attack: "enable"
long_duration_thresh: "8200"
malformed_association: "enable"
malformed_auth: "enable"
malformed_ht_ie: "enable"
name: "default_name_86"
netstumbler: "enable"
netstumbler_thresh: "5"
netstumbler_time: "30"
null_ssid_probe_resp: "enable"
omerta_attack: "enable"
overflow_ie: "enable"
probe_flood: "enable"
probe_flood_thresh: "30"
probe_flood_time: "1"
pspoll_flood: "enable"
pspoll_flood_thresh: "30"
pspoll_flood_time: "1"
pwsave_dos_attack: "enable"
reassoc_flood: "enable"
reassoc_flood_thresh: "30"
reassoc_flood_time: "10"
risky_encryption: "enable"
rts_flood: "enable"
rts_flood_thresh: "30"
rts_flood_time: "10"
sensor_mode: "disable"
spoofed_deauth: "enable"
unencrypted_valid: "enable"
valid_client_misassociation: "enable"
valid_ssid_misuse: "enable"
weak_wep_iv: "enable"
wellenreiter: "enable"
wellenreiter_thresh: "5"
wellenreiter_time: "30"
windows_bridge: "enable"
wireless_bridge: "enable"
wpa_ft_attack: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |