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.3.9).
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 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 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 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:
|
|
Comment. |
|
Enable/disable broadcasting de-authentication detection . Choices:
|
|
Threshold value per second to deauth unknown src for DoS attack (0: no limit). |
|
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 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 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). |
|
WIDS profile name. |
|
Enable/disable null SSID probe response detection . Choices:
|
|
Scan nearby WiFi stations . Choices:
|
|
Enable/disable spoofed de-authentication attack detection . Choices:
|
|
Enable/disable weak WEP IV (Initialization Vector) detection . Choices:
|
|
Enable/disable wireless bridge 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:
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"
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: |