fortios_wireless_controller_wids_profile – Configure wireless intrusion detection system (WIDS) profiles in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- wireless_controller_wids_profile - Configure wireless intrusion detection system (WIDS) profiles. type: dict more...
- ap_auto_suppress - Enable/disable on-wire rogue AP auto-suppression . type: str choices: enable, disable more...
- ap_bgscan_disable_day - Optionally turn off scanning for one or more days of the week. Separate the days with a space. By default, no days are set. type: str choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday more...
- ap_bgscan_disable_end - End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . type: str more...
- ap_bgscan_disable_schedules - 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. type: list member_path: ap_bgscan_disable_schedules:name more...
- name - Schedule name. Source firewall.schedule.group.name firewall.schedule.recurring.name firewall.schedule.onetime.name. type: str required: true more...
- ap_bgscan_disable_start - Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . type: str more...
- ap_bgscan_duration - Listen time on scanning a channel (10 - 1000 msec). type: int more...
- ap_bgscan_idle - Wait time for channel inactivity before scanning this channel (0 - 1000 msec). type: int more...
- ap_bgscan_intv - Period between successive channel scans (1 - 600 sec). type: int more...
- ap_bgscan_period - Period between background scans (10 - 3600 sec). type: int more...
- ap_bgscan_report_intv - Period between background scan reports (15 - 600 sec). type: int more...
- ap_fgscan_report_intv - Period between foreground scan reports (15 - 600 sec). type: int more...
- ap_scan - Enable/disable rogue AP detection. type: str choices: disable, enable more...
- ap_scan_channel_list_2G_5G - Selected ap scan channel list for 2.4G and 5G bands. type: list member_path: ap_scan_channel_list_2G_5G:chan more...
- chan - Channel number. type: str required: true more...
- ap_scan_channel_list_6G - Selected ap scan channel list for 6G band. type: list member_path: ap_scan_channel_list_6G:chan more...
- chan - Channel 6g number. type: str required: true more...
- ap_scan_passive - Enable/disable passive scanning. Enable means do not send probe request on any channels . type: str choices: enable, disable more...
- ap_scan_threshold - Minimum signal level/threshold in dBm required for the AP to report detected rogue AP (-95 to -20). type: str more...
- asleap_attack - Enable/disable asleap attack detection . type: str choices: enable, disable more...
- assoc_flood_thresh - The threshold value for association frame flooding. type: int more...
- assoc_flood_time - Number of seconds after which a station is considered not connected. type: int more...
- assoc_frame_flood - Enable/disable association frame flooding detection . type: str choices: enable, disable more...
- auth_flood_thresh - The threshold value for authentication frame flooding. type: int more...
- auth_flood_time - Number of seconds after which a station is considered not connected. type: int more...
- auth_frame_flood - Enable/disable authentication frame flooding detection . type: str choices: enable, disable more...
- comment - Comment. type: str more...
- deauth_broadcast - Enable/disable broadcasting de-authentication detection . type: str choices: enable, disable more...
- deauth_unknown_src_thresh - Threshold value per second to deauth unknown src for DoS attack (0: no limit). type: int more...
- eapol_fail_flood - Enable/disable EAPOL-Failure flooding (to AP) detection . type: str choices: enable, disable more...
- eapol_fail_intv - The detection interval for EAPOL-Failure flooding (1 - 3600 sec). type: int more...
- eapol_fail_thresh - The threshold value for EAPOL-Failure flooding in specified interval. type: int more...
- eapol_logoff_flood - Enable/disable EAPOL-Logoff flooding (to AP) detection . type: str choices: enable, disable more...
- eapol_logoff_intv - The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). type: int more...
- eapol_logoff_thresh - The threshold value for EAPOL-Logoff flooding in specified interval. type: int more...
- eapol_pre_fail_flood - Enable/disable premature EAPOL-Failure flooding (to STA) detection . type: str choices: enable, disable more...
- eapol_pre_fail_intv - The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). type: int more...
- eapol_pre_fail_thresh - The threshold value for premature EAPOL-Failure flooding in specified interval. type: int more...
- eapol_pre_succ_flood - Enable/disable premature EAPOL-Success flooding (to STA) detection . type: str choices: enable, disable more...
- eapol_pre_succ_intv - The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). type: int more...
- eapol_pre_succ_thresh - The threshold value for premature EAPOL-Success flooding in specified interval. type: int more...
- eapol_start_flood - Enable/disable EAPOL-Start flooding (to AP) detection . type: str choices: enable, disable more...
- eapol_start_intv - The detection interval for EAPOL-Start flooding (1 - 3600 sec). type: int more...
- eapol_start_thresh - The threshold value for EAPOL-Start flooding in specified interval. type: int more...
- eapol_succ_flood - Enable/disable EAPOL-Success flooding (to AP) detection . type: str choices: enable, disable more...
- eapol_succ_intv - The detection interval for EAPOL-Success flooding (1 - 3600 sec). type: int more...
- eapol_succ_thresh - The threshold value for EAPOL-Success flooding in specified interval. type: int more...
- invalid_mac_oui - Enable/disable invalid MAC OUI detection. type: str choices: enable, disable more...
- long_duration_attack - Enable/disable long duration attack detection based on user configured threshold . type: str choices: enable, disable more...
- long_duration_thresh - Threshold value for long duration attack detection (1000 - 32767 usec). type: int more...
- name - WIDS profile name. type: str required: true more...
- null_ssid_probe_resp - Enable/disable null SSID probe response detection . type: str choices: enable, disable more...
- sensor_mode - Scan nearby WiFi stations . type: str choices: disable, foreign, both more...
- spoofed_deauth - Enable/disable spoofed de-authentication attack detection . type: str choices: enable, disable more...
- weak_wep_iv - Enable/disable weak WEP IV (Initialization Vector) detection . type: str choices: enable, disable more...
- wireless_bridge - Enable/disable wireless bridge detection . type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.