Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
To install it use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_widsprofile.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| adom string / required | the parameter (adom) in requested url | ||
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | ||
| state string / required |
| the directive to create, update or delete an object | |
| widsprofile dictionary | the top level parameters set | ||
| ap-auto-suppress string |
| Enable/disable on-wire rogue AP auto-suppression (default = disable). | |
| ap-bgscan-disable-day list / elements=string |
| no description | |
| ap-bgscan-disable-end string | End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning (default = 00:00). | ||
| ap-bgscan-disable-start string | Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning (default = 00:00). | ||
| ap-bgscan-duration integer | Listening time on a scanning channel (10 - 1000 msec, default = 20). | ||
| ap-bgscan-idle integer | Waiting time for channel inactivity before scanning this channel (0 - 1000 msec, default = 0). | ||
| ap-bgscan-intv integer | Period of time between scanning two channels (1 - 600 sec, default = 1). | ||
| ap-bgscan-period integer | Period of time between background scans (60 - 3600 sec, default = 600). | ||
| ap-bgscan-report-intv integer | Period of time between background scan reports (15 - 600 sec, default = 30). | ||
| ap-fgscan-report-intv integer | Period of time between foreground scan reports (15 - 600 sec, default = 15). | ||
| ap-scan string |
| Enable/disable rogue AP detection. | |
| ap-scan-passive string |
| Enable/disable passive scanning. Enable means do not send probe request on any channels (default = disable). | |
| asleap-attack string |
| Enable/disable asleap attack detection (default = disable). | |
| assoc-flood-thresh integer | The threshold value for association frame flooding. | ||
| assoc-flood-time integer | Number of seconds after which a station is considered not connected. | ||
| assoc-frame-flood string |
| Enable/disable association frame flooding detection (default = disable). | |
| auth-flood-thresh integer | The threshold value for authentication frame flooding. | ||
| auth-flood-time integer | Number of seconds after which a station is considered not connected. | ||
| auth-frame-flood string |
| Enable/disable authentication frame flooding detection (default = disable). | |
| comment string | Comment. | ||
| deauth-broadcast string |
| Enable/disable broadcasting de-authentication detection (default = disable). | |
| deauth-unknown-src-thresh integer | Threshold value per second to deauth unknown src for DoS attack (0: no limit). | ||
| eapol-fail-flood string |
| Enable/disable EAPOL-Failure flooding (to AP) detection (default = disable). | |
| eapol-fail-intv integer | The detection interval for EAPOL-Failure flooding (1 - 3600 sec). | ||
| eapol-fail-thresh integer | The threshold value for EAPOL-Failure flooding in specified interval. | ||
| eapol-logoff-flood string |
| Enable/disable EAPOL-Logoff flooding (to AP) detection (default = disable). | |
| eapol-logoff-intv integer | The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). | ||
| eapol-logoff-thresh integer | The threshold value for EAPOL-Logoff flooding in specified interval. | ||
| eapol-pre-fail-flood string |
| Enable/disable premature EAPOL-Failure flooding (to STA) detection (default = disable). | |
| eapol-pre-fail-intv integer | The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). | ||
| eapol-pre-fail-thresh integer | The threshold value for premature EAPOL-Failure flooding in specified interval. | ||
| eapol-pre-succ-flood string |
| Enable/disable premature EAPOL-Success flooding (to STA) detection (default = disable). | |
| eapol-pre-succ-intv integer | The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). | ||
| eapol-pre-succ-thresh integer | The threshold value for premature EAPOL-Success flooding in specified interval. | ||
| eapol-start-flood string |
| Enable/disable EAPOL-Start flooding (to AP) detection (default = disable). | |
| eapol-start-intv integer | The detection interval for EAPOL-Start flooding (1 - 3600 sec). | ||
| eapol-start-thresh integer | The threshold value for EAPOL-Start flooding in specified interval. | ||
| eapol-succ-flood string |
| Enable/disable EAPOL-Success flooding (to AP) detection (default = disable). | |
| eapol-succ-intv integer | The detection interval for EAPOL-Success flooding (1 - 3600 sec). | ||
| eapol-succ-thresh integer | The threshold value for EAPOL-Success flooding in specified interval. | ||
| invalid-mac-oui string |
| Enable/disable invalid MAC OUI detection. | |
| long-duration-attack string |
| Enable/disable long duration attack detection based on user configured threshold (default = disable). | |
| long-duration-thresh integer | Threshold value for long duration attack detection (1000 - 32767 usec, default = 8200). | ||
| name string | WIDS profile name. | ||
| null-ssid-probe-resp string |
| Enable/disable null SSID probe response detection (default = disable). | |
| sensor-mode string |
| Scan WiFi nearby stations (default = disable). | |
| spoofed-deauth string |
| Enable/disable spoofed de-authentication attack detection (default = disable). | |
| weak-wep-iv string |
| Enable/disable weak WEP IV (Initialization Vector) detection (default = disable). | |
| wireless-bridge string |
| Enable/disable wireless bridge detection (default = disable). | |
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | |
Note
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure wireless intrusion detection system (WIDS) profiles.
fmgr_widsprofile:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
widsprofile:
ap-auto-suppress: <value in [disable, enable]>
ap-bgscan-disable-day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
ap-bgscan-disable-end: <value of string>
ap-bgscan-disable-start: <value of string>
ap-bgscan-duration: <value of integer>
ap-bgscan-idle: <value of integer>
ap-bgscan-intv: <value of integer>
ap-bgscan-period: <value of integer>
ap-bgscan-report-intv: <value of integer>
ap-fgscan-report-intv: <value of integer>
ap-scan: <value in [disable, enable]>
ap-scan-passive: <value in [disable, enable]>
asleap-attack: <value in [disable, enable]>
assoc-flood-thresh: <value of integer>
assoc-flood-time: <value of integer>
assoc-frame-flood: <value in [disable, enable]>
auth-flood-thresh: <value of integer>
auth-flood-time: <value of integer>
auth-frame-flood: <value in [disable, enable]>
comment: <value of string>
deauth-broadcast: <value in [disable, enable]>
deauth-unknown-src-thresh: <value of integer>
eapol-fail-flood: <value in [disable, enable]>
eapol-fail-intv: <value of integer>
eapol-fail-thresh: <value of integer>
eapol-logoff-flood: <value in [disable, enable]>
eapol-logoff-intv: <value of integer>
eapol-logoff-thresh: <value of integer>
eapol-pre-fail-flood: <value in [disable, enable]>
eapol-pre-fail-intv: <value of integer>
eapol-pre-fail-thresh: <value of integer>
eapol-pre-succ-flood: <value in [disable, enable]>
eapol-pre-succ-intv: <value of integer>
eapol-pre-succ-thresh: <value of integer>
eapol-start-flood: <value in [disable, enable]>
eapol-start-intv: <value of integer>
eapol-start-thresh: <value of integer>
eapol-succ-flood: <value in [disable, enable]>
eapol-succ-intv: <value of integer>
eapol-succ-thresh: <value of integer>
invalid-mac-oui: <value in [disable, enable]>
long-duration-attack: <value in [disable, enable]>
long-duration-thresh: <value of integer>
name: <value of string>
null-ssid-probe-resp: <value in [disable, enable]>
sensor-mode: <value in [disable, foreign, both]>
spoofed-deauth: <value in [disable, enable]>
weak-wep-iv: <value in [disable, enable]>
wireless-bridge: <value in [disable, enable]>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_widsprofile_module.html