New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
Default: "root"
|
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.
|
|
wireless_controller_wids_profile
-
|
Default: null
|
Configure wireless intrusion detection system (WIDS) profiles.
|
|
ap-auto-suppress
-
|
|
Enable/disable on-wire rogue AP auto-suppression (default = 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.
|
|
ap-bgscan-disable-end
-
|
End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning (default = 00:00).
|
||
ap-bgscan-disable-start
-
|
Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning (default = 00:00).
|
||
ap-bgscan-duration
-
|
Listening time on a scanning channel (10 - 1000 msec, default = 20).
|
||
ap-bgscan-idle
-
|
Waiting time for channel inactivity before scanning this channel (0 - 1000 msec, default = 0).
|
||
ap-bgscan-intv
-
|
Period of time between scanning two channels (1 - 600 sec, default = 1).
|
||
ap-bgscan-period
-
|
Period of time between background scans (60 - 3600 sec, default = 600).
|
||
ap-bgscan-report-intv
-
|
Period of time between background scan reports (15 - 600 sec, default = 30).
|
||
ap-fgscan-report-intv
-
|
Period of time between foreground scan reports (15 - 600 sec, default = 15).
|
||
ap-scan
-
|
|
Enable/disable rogue AP detection.
|
|
ap-scan-passive
-
|
|
Enable/disable passive scanning. Enable means do not send probe request on any channels (default = disable).
|
|
asleap-attack
-
|
|
Enable/disable asleap attack detection (default = disable).
|
|
assoc-flood-thresh
-
|
The threshold value for association frame flooding.
|
||
assoc-flood-time
-
|
Number of seconds after which a station is considered not connected.
|
||
assoc-frame-flood
-
|
|
Enable/disable association frame flooding detection (default = disable).
|
|
auth-flood-thresh
-
|
The threshold value for authentication frame flooding.
|
||
auth-flood-time
-
|
Number of seconds after which a station is considered not connected.
|
||
auth-frame-flood
-
|
|
Enable/disable authentication frame flooding detection (default = disable).
|
|
comment
-
|
Comment.
|
||
deauth-broadcast
-
|
|
Enable/disable broadcasting de-authentication detection (default = disable).
|
|
deauth-unknown-src-thresh
-
|
Threshold value per second to deauth unknown src for DoS attack (0: no limit).
|
||
eapol-fail-flood
-
|
|
Enable/disable EAPOL-Failure flooding (to AP) detection (default = disable).
|
|
eapol-fail-intv
-
|
The detection interval for EAPOL-Failure flooding (1 - 3600 sec).
|
||
eapol-fail-thresh
-
|
The threshold value for EAPOL-Failure flooding in specified interval.
|
||
eapol-logoff-flood
-
|
|
Enable/disable EAPOL-Logoff flooding (to AP) detection (default = disable).
|
|
eapol-logoff-intv
-
|
The detection interval for EAPOL-Logoff flooding (1 - 3600 sec).
|
||
eapol-logoff-thresh
-
|
The threshold value for EAPOL-Logoff flooding in specified interval.
|
||
eapol-pre-fail-flood
-
|
|
Enable/disable premature EAPOL-Failure flooding (to STA) detection (default = disable).
|
|
eapol-pre-fail-intv
-
|
The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec).
|
||
eapol-pre-fail-thresh
-
|
The threshold value for premature EAPOL-Failure flooding in specified interval.
|
||
eapol-pre-succ-flood
-
|
|
Enable/disable premature EAPOL-Success flooding (to STA) detection (default = disable).
|
|
eapol-pre-succ-intv
-
|
The detection interval for premature EAPOL-Success flooding (1 - 3600 sec).
|
||
eapol-pre-succ-thresh
-
|
The threshold value for premature EAPOL-Success flooding in specified interval.
|
||
eapol-start-flood
-
|
|
Enable/disable EAPOL-Start flooding (to AP) detection (default = disable).
|
|
eapol-start-intv
-
|
The detection interval for EAPOL-Start flooding (1 - 3600 sec).
|
||
eapol-start-thresh
-
|
The threshold value for EAPOL-Start flooding in specified interval.
|
||
eapol-succ-flood
-
|
|
Enable/disable EAPOL-Success flooding (to AP) detection (default = disable).
|
|
eapol-succ-intv
-
|
The detection interval for EAPOL-Success flooding (1 - 3600 sec).
|
||
eapol-succ-thresh
-
|
The threshold value for EAPOL-Success flooding in specified interval.
|
||
invalid-mac-oui
-
|
|
Enable/disable invalid MAC OUI detection.
|
|
long-duration-attack
-
|
|
Enable/disable long duration attack detection based on user configured threshold (default = disable).
|
|
long-duration-thresh
-
|
Threshold value for long duration attack detection (1000 - 32767 usec, default = 8200).
|
||
name
-
/ required
|
WIDS profile name.
|
||
null-ssid-probe-resp
-
|
|
Enable/disable null SSID probe response detection (default = disable).
|
|
sensor-mode
-
|
|
Scan WiFi nearby stations (default = disable).
|
|
spoofed-deauth
-
|
|
Enable/disable spoofed de-authentication attack detection (default = disable).
|
|
state
-
|
|
Indicates whether to create or remove the object
|
|
weak-wep-iv
-
|
|
Enable/disable weak WEP IV (Initialization Vector) detection (default = disable).
|
|
wireless-bridge
-
|
|
Enable/disable wireless bridge detection (default = disable).
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure wireless intrusion detection system (WIDS) profiles.
fortios_wireless_controller_wids_profile:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
wireless_controller_wids_profile:
state: "present"
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"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
status
string
|
always |
Indication of the operation's result
Sample:
success
|
vdom
string
|
always |
Virtual domain used
Sample:
root
|
version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.