fortinet.fortimanager.fmgr_widsprofile module – Configure wireless intrusion detection system

Note

This module is part of the fortinet.fortimanager collection (version 2.7.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

access_token

string

The token to access FortiManager without using username and password.

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.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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.

Choices:

  • "present"

  • "absent"

widsprofile

dictionary

The top level parameters set.

ap-auto-suppress

string

Deprecated, please rename it to ap_auto_suppress. Enable/disable on-wire rogue AP auto-suppression

Choices:

  • "disable"

  • "enable"

ap-bgscan-disable-day

list / elements=string

Deprecated, please rename it to ap_bgscan_disable_day. Optionally turn off scanning for one or more days of the week.

Choices:

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

ap-bgscan-disable-end

string

Deprecated, please rename it to ap_bgscan_disable_end. End time, using a 24-hour clock in the format of hh

ap-bgscan-disable-schedules

any

(list or str) Deprecated, please rename it to ap_bgscan_disable_schedules. Firewall schedules for turning off FortiAP radi…

ap-bgscan-disable-start

string

Deprecated, please rename it to ap_bgscan_disable_start. Start time, using a 24-hour clock in the format of hh

ap-bgscan-duration

integer

Deprecated, please rename it to ap_bgscan_duration. Listening time on a scanning channel

ap-bgscan-idle

integer

Deprecated, please rename it to ap_bgscan_idle. Waiting time for channel inactivity before scanning this channel

ap-bgscan-intv

integer

Deprecated, please rename it to ap_bgscan_intv. Period of time between scanning two channels

ap-bgscan-period

integer

Deprecated, please rename it to ap_bgscan_period. Period of time between background scans

ap-bgscan-report-intv

integer

Deprecated, please rename it to ap_bgscan_report_intv. Period of time between background scan reports

ap-fgscan-report-intv

integer

Deprecated, please rename it to ap_fgscan_report_intv. Period of time between foreground scan reports

ap-scan

string

Deprecated, please rename it to ap_scan. Enable/disable rogue AP detection.

Choices:

  • "disable"

  • "enable"

ap-scan-channel-list-2G-5G

any

(list) Deprecated, please rename it to ap_scan_channel_list_2G_5G. Selected ap scan channel list for 2.

ap-scan-channel-list-6G

any

(list) Deprecated, please rename it to ap_scan_channel_list_6G. Selected ap scan channel list for 6G band.

ap-scan-passive

string

Deprecated, please rename it to ap_scan_passive. Enable/disable passive scanning.

Choices:

  • "disable"

  • "enable"

ap-scan-threshold

string

Deprecated, please rename it to ap_scan_threshold. Minimum signal level/threshold in dBm required for the AP to report det…

asleap-attack

string

Deprecated, please rename it to asleap_attack. Enable/disable asleap attack detection

Choices:

  • "disable"

  • "enable"

assoc-flood-thresh

integer

Deprecated, please rename it to assoc_flood_thresh. The threshold value for association frame flooding.

assoc-flood-time

integer

Deprecated, please rename it to assoc_flood_time. Number of seconds after which a station is considered not connected.

assoc-frame-flood

string

Deprecated, please rename it to assoc_frame_flood. Enable/disable association frame flooding detection

Choices:

  • "disable"

  • "enable"

auth-flood-thresh

integer

Deprecated, please rename it to auth_flood_thresh. The threshold value for authentication frame flooding.

auth-flood-time

integer

Deprecated, please rename it to auth_flood_time. Number of seconds after which a station is considered not connected.

auth-frame-flood

string

Deprecated, please rename it to auth_frame_flood. Enable/disable authentication frame flooding detection

Choices:

  • "disable"

  • "enable"

comment

string

Comment.

deauth-broadcast

string

Deprecated, please rename it to deauth_broadcast. Enable/disable broadcasting de-authentication detection

Choices:

  • "disable"

  • "enable"

deauth-unknown-src-thresh

integer

Deprecated, please rename it to deauth_unknown_src_thresh. Threshold value per second to deauth unknown src for DoS attack

eapol-fail-flood

string

Deprecated, please rename it to eapol_fail_flood. Enable/disable EAPOL-Failure flooding

Choices:

  • "disable"

  • "enable"

eapol-fail-intv

integer

Deprecated, please rename it to eapol_fail_intv. The detection interval for EAPOL-Failure flooding

eapol-fail-thresh

integer

Deprecated, please rename it to eapol_fail_thresh. The threshold value for EAPOL-Failure flooding in specified interval.

eapol-logoff-flood

string

Deprecated, please rename it to eapol_logoff_flood. Enable/disable EAPOL-Logoff flooding

Choices:

  • "disable"

  • "enable"

eapol-logoff-intv

integer

Deprecated, please rename it to eapol_logoff_intv. The detection interval for EAPOL-Logoff flooding

eapol-logoff-thresh

integer

Deprecated, please rename it to eapol_logoff_thresh. The threshold value for EAPOL-Logoff flooding in specified interval.

eapol-pre-fail-flood

string

Deprecated, please rename it to eapol_pre_fail_flood. Enable/disable premature EAPOL-Failure flooding

Choices:

  • "disable"

  • "enable"

eapol-pre-fail-intv

integer

Deprecated, please rename it to eapol_pre_fail_intv. The detection interval for premature EAPOL-Failure flooding

eapol-pre-fail-thresh

integer

Deprecated, please rename it to eapol_pre_fail_thresh. The threshold value for premature EAPOL-Failure flooding in specifi…

eapol-pre-succ-flood

string

Deprecated, please rename it to eapol_pre_succ_flood. Enable/disable premature EAPOL-Success flooding

Choices:

  • "disable"

  • "enable"

eapol-pre-succ-intv

integer

Deprecated, please rename it to eapol_pre_succ_intv. The detection interval for premature EAPOL-Success flooding

eapol-pre-succ-thresh

integer

Deprecated, please rename it to eapol_pre_succ_thresh. The threshold value for premature EAPOL-Success flooding in specifi…

eapol-start-flood

string

Deprecated, please rename it to eapol_start_flood. Enable/disable EAPOL-Start flooding

Choices:

  • "disable"

  • "enable"

eapol-start-intv

integer

Deprecated, please rename it to eapol_start_intv. The detection interval for EAPOL-Start flooding

eapol-start-thresh

integer

Deprecated, please rename it to eapol_start_thresh. The threshold value for EAPOL-Start flooding in specified interval.

eapol-succ-flood

string

Deprecated, please rename it to eapol_succ_flood. Enable/disable EAPOL-Success flooding

Choices:

  • "disable"

  • "enable"

eapol-succ-intv

integer

Deprecated, please rename it to eapol_succ_intv. The detection interval for EAPOL-Success flooding

eapol-succ-thresh

integer

Deprecated, please rename it to eapol_succ_thresh. The threshold value for EAPOL-Success flooding in specified interval.

invalid-mac-oui

string

Deprecated, please rename it to invalid_mac_oui. Enable/disable invalid MAC OUI detection.

Choices:

  • "disable"

  • "enable"

long-duration-attack

string

Deprecated, please rename it to long_duration_attack. Enable/disable long duration attack detection based on user configur…

Choices:

  • "disable"

  • "enable"

long-duration-thresh

integer

Deprecated, please rename it to long_duration_thresh. Threshold value for long duration attack detection

name

string / required

WIDS profile name.

null-ssid-probe-resp

string

Deprecated, please rename it to null_ssid_probe_resp. Enable/disable null SSID probe response detection

Choices:

  • "disable"

  • "enable"

rogue-scan

string

Deprecated, please rename it to rogue_scan. Enable/disable rogue AP on-wire scan.

Choices:

  • "disable"

  • "enable"

sensor-mode

string

Deprecated, please rename it to sensor_mode. Scan WiFi nearby stations

Choices:

  • "disable"

  • "foreign"

  • "both"

spoofed-deauth

string

Deprecated, please rename it to spoofed_deauth. Enable/disable spoofed de-authentication attack detection

Choices:

  • "disable"

  • "enable"

weak-wep-iv

string

Deprecated, please rename it to weak_wep_iv. Enable/disable weak WEP IV

Choices:

  • "disable"

  • "enable"

wireless-bridge

string

Deprecated, please rename it to wireless_bridge. Enable/disable wireless bridge detection

Choices:

  • "disable"

  • "enable"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

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

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)