fortios_wireless_controller_wids_profile – Configure wireless intrusion detection system (WIDS) profiles in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- wireless_controller_wids_profile - Configure wireless intrusion detection system (WIDS) profiles. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- ap_auto_suppress - Enable/disable on-wire rogue AP auto-suppression . type: str choices: enable, disable
- 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
- ap_bgscan_disable_end - End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . type: str
- ap_bgscan_disable_start - Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning . type: str
- ap_bgscan_duration - Listening time on a scanning channel (10 - 1000 msec). type: int
- ap_bgscan_idle - Waiting time for channel inactivity before scanning this channel (0 - 1000 msec). type: int
- ap_bgscan_intv - Period of time between scanning two channels (1 - 600 sec). type: int
- ap_bgscan_period - Period of time between background scans (60 - 3600 sec). type: int
- ap_bgscan_report_intv - Period of time between background scan reports (15 - 600 sec). type: int
- ap_fgscan_report_intv - Period of time between foreground scan reports (15 - 600 sec). type: int
- ap_scan - Enable/disable rogue AP detection. type: str choices: disable, enable
- ap_scan_passive - Enable/disable passive scanning. Enable means do not send probe request on any channels . type: str choices: enable, disable
- asleap_attack - Enable/disable asleap attack detection . type: str choices: enable, disable
- assoc_flood_thresh - The threshold value for association frame flooding. type: int
- assoc_flood_time - Number of seconds after which a station is considered not connected. type: int
- assoc_frame_flood - Enable/disable association frame flooding detection . type: str choices: enable, disable
- auth_flood_thresh - The threshold value for authentication frame flooding. type: int
- auth_flood_time - Number of seconds after which a station is considered not connected. type: int
- auth_frame_flood - Enable/disable authentication frame flooding detection . type: str choices: enable, disable
- comment - Comment. type: str
- deauth_broadcast - Enable/disable broadcasting de-authentication detection . type: str choices: enable, disable
- deauth_unknown_src_thresh - Threshold value per second to deauth unknown src for DoS attack (0: no limit). type: int
- eapol_fail_flood - Enable/disable EAPOL-Failure flooding (to AP) detection . type: str choices: enable, disable
- eapol_fail_intv - The detection interval for EAPOL-Failure flooding (1 - 3600 sec). type: int
- eapol_fail_thresh - The threshold value for EAPOL-Failure flooding in specified interval. type: int
- eapol_logoff_flood - Enable/disable EAPOL-Logoff flooding (to AP) detection . type: str choices: enable, disable
- eapol_logoff_intv - The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). type: int
- eapol_logoff_thresh - The threshold value for EAPOL-Logoff flooding in specified interval. type: int
- eapol_pre_fail_flood - Enable/disable premature EAPOL-Failure flooding (to STA) detection . type: str choices: enable, disable
- eapol_pre_fail_intv - The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). type: int
- eapol_pre_fail_thresh - The threshold value for premature EAPOL-Failure flooding in specified interval. type: int
- eapol_pre_succ_flood - Enable/disable premature EAPOL-Success flooding (to STA) detection . type: str choices: enable, disable
- eapol_pre_succ_intv - The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). type: int
- eapol_pre_succ_thresh - The threshold value for premature EAPOL-Success flooding in specified interval. type: int
- eapol_start_flood - Enable/disable EAPOL-Start flooding (to AP) detection . type: str choices: enable, disable
- eapol_start_intv - The detection interval for EAPOL-Start flooding (1 - 3600 sec). type: int
- eapol_start_thresh - The threshold value for EAPOL-Start flooding in specified interval. type: int
- eapol_succ_flood - Enable/disable EAPOL-Success flooding (to AP) detection . type: str choices: enable, disable
- eapol_succ_intv - The detection interval for EAPOL-Success flooding (1 - 3600 sec). type: int
- eapol_succ_thresh - The threshold value for EAPOL-Success flooding in specified interval. type: int
- invalid_mac_oui - Enable/disable invalid MAC OUI detection. type: str choices: enable, disable
- long_duration_attack - Enable/disable long duration attack detection based on user configured threshold . type: str choices: enable, disable
- long_duration_thresh - Threshold value for long duration attack detection (1000 - 32767 usec). type: int
- name - WIDS profile name. type: str required: True
- null_ssid_probe_resp - Enable/disable null SSID probe response detection . type: str choices: enable, disable
- sensor_mode - Scan WiFi nearby stations . type: str choices: disable, foreign, both
- spoofed_deauth - Enable/disable spoofed de-authentication attack detection . type: str choices: enable, disable
- weak_wep_iv - Enable/disable weak WEP IV (Initialization Vector) detection . type: str choices: enable, disable
- wireless_bridge - Enable/disable wireless bridge detection . type: str choices: enable, disable
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure wireless intrusion detection system (WIDS) profiles.
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_start: "<your_own_value>"
ap_bgscan_duration: "7"
ap_bgscan_idle: "8"
ap_bgscan_intv: "9"
ap_bgscan_period: "10"
ap_bgscan_report_intv: "11"
ap_fgscan_report_intv: "12"
ap_scan: "disable"
ap_scan_passive: "enable"
asleap_attack: "enable"
assoc_flood_thresh: "16"
assoc_flood_time: "17"
assoc_frame_flood: "enable"
auth_flood_thresh: "19"
auth_flood_time: "20"
auth_frame_flood: "enable"
comment: "Comment."
deauth_broadcast: "enable"
deauth_unknown_src_thresh: "24"
eapol_fail_flood: "enable"
eapol_fail_intv: "26"
eapol_fail_thresh: "27"
eapol_logoff_flood: "enable"
eapol_logoff_intv: "29"
eapol_logoff_thresh: "30"
eapol_pre_fail_flood: "enable"
eapol_pre_fail_intv: "32"
eapol_pre_fail_thresh: "33"
eapol_pre_succ_flood: "enable"
eapol_pre_succ_intv: "35"
eapol_pre_succ_thresh: "36"
eapol_start_flood: "enable"
eapol_start_intv: "38"
eapol_start_thresh: "39"
eapol_succ_flood: "enable"
eapol_succ_intv: "41"
eapol_succ_thresh: "42"
invalid_mac_oui: "enable"
long_duration_attack: "enable"
long_duration_thresh: "45"
name: "default_name_46"
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