fortinet.fortimanager.fmgr_widsprofile module – Configure wireless intrusion detection system
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
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.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_widsprofile.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Enable/disable on-wire rogue AP auto-suppression Choices:
|
|
Optionally turn off scanning for one or more days of the week. Choices:
|
|
End time, using a 24-hour clock in the format of hh |
|
(list or str) Firewall schedules for turning off FortiAP radio background scan. |
|
Start time, using a 24-hour clock in the format of hh |
|
Listening time on a scanning channel |
|
Waiting time for channel inactivity before scanning this channel |
|
Period of time between scanning two channels |
|
Period of time between background scans |
|
Period of time between background scan reports |
|
Period of time between foreground scan reports |
|
Enable/disable rogue AP detection. Choices:
|
|
(list) Selected ap scan channel list for 2. |
|
(list) Selected ap scan channel list for 6G band. |
|
Enable/disable passive scanning. Choices:
|
|
Minimum signal level/threshold in dBm required for the AP to report detected rogue AP |
|
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 |
|
Enable/disable EAPOL-Failure flooding Choices:
|
|
The detection interval for EAPOL-Failure flooding |
|
The threshold value for EAPOL-Failure flooding in specified interval. |
|
Enable/disable EAPOL-Logoff flooding Choices:
|
|
The detection interval for EAPOL-Logoff flooding |
|
The threshold value for EAPOL-Logoff flooding in specified interval. |
|
Enable/disable premature EAPOL-Failure flooding Choices:
|
|
The detection interval for premature EAPOL-Failure flooding |
|
The threshold value for premature EAPOL-Failure flooding in specified interval. |
|
Enable/disable premature EAPOL-Success flooding Choices:
|
|
The detection interval for premature EAPOL-Success flooding |
|
The threshold value for premature EAPOL-Success flooding in specified interval. |
|
Enable/disable EAPOL-Start flooding Choices:
|
|
The detection interval for EAPOL-Start flooding |
|
The threshold value for EAPOL-Start flooding in specified interval. |
|
Enable/disable EAPOL-Success flooding Choices:
|
|
The detection interval for EAPOL-Success flooding |
|
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 |
|
WIDS profile name. |
|
Enable/disable null SSID probe response detection Choices:
|
|
Enable/disable rogue AP on-wire scan. Choices:
|
|
Scan WiFi nearby stations Choices:
|
|
Enable/disable spoofed de-authentication attack detection Choices:
|
|
Enable/disable weak WEP IV Choices:
|
|
Enable/disable wireless bridge detection Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure wireless intrusion detection system
fortinet.fortimanager.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: present # <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: <string>
ap_bgscan_disable_start: <string>
ap_bgscan_duration: <integer>
ap_bgscan_idle: <integer>
ap_bgscan_intv: <integer>
ap_bgscan_period: <integer>
ap_bgscan_report_intv: <integer>
ap_fgscan_report_intv: <integer>
ap_scan: <value in [disable, enable]>
ap_scan_passive: <value in [disable, enable]>
asleap_attack: <value in [disable, enable]>
assoc_flood_thresh: <integer>
assoc_flood_time: <integer>
assoc_frame_flood: <value in [disable, enable]>
auth_flood_thresh: <integer>
auth_flood_time: <integer>
auth_frame_flood: <value in [disable, enable]>
comment: <string>
deauth_broadcast: <value in [disable, enable]>
deauth_unknown_src_thresh: <integer>
eapol_fail_flood: <value in [disable, enable]>
eapol_fail_intv: <integer>
eapol_fail_thresh: <integer>
eapol_logoff_flood: <value in [disable, enable]>
eapol_logoff_intv: <integer>
eapol_logoff_thresh: <integer>
eapol_pre_fail_flood: <value in [disable, enable]>
eapol_pre_fail_intv: <integer>
eapol_pre_fail_thresh: <integer>
eapol_pre_succ_flood: <value in [disable, enable]>
eapol_pre_succ_intv: <integer>
eapol_pre_succ_thresh: <integer>
eapol_start_flood: <value in [disable, enable]>
eapol_start_intv: <integer>
eapol_start_thresh: <integer>
eapol_succ_flood: <value in [disable, enable]>
eapol_succ_intv: <integer>
eapol_succ_thresh: <integer>
invalid_mac_oui: <value in [disable, enable]>
long_duration_attack: <value in [disable, enable]>
long_duration_thresh: <integer>
name: <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]>
ap_bgscan_disable_schedules: <list or string>
rogue_scan: <value in [disable, enable]>
ap_scan_threshold: <string>
ap_scan_channel_list_2G_5G: <list or string>
ap_scan_channel_list_6G: <list or string>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |