fmgd_wireless_widsprofile – Configure wireless intrusion detection system (WIDS) profiles.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • wireless_widsprofile - Configure wireless intrusion detection system type: dict
    • ap_auto_suppress (Alias name: ap-auto-suppress) Enable/disable on-wire rogue ap auto-suppression (default = disable). type: str choices: [disable, enable] more...
    • ap_bgscan_disable_schedules (Alias name: ap-bgscan-disable-schedules) Firewall schedules for turning off fortiap radio background scan. type: list more...
    • ap_bgscan_duration (Alias name: ap-bgscan-duration) Listen time on scanning a channel (10 - 1000 msec, default = 30). type: int more...
    • ap_bgscan_idle (Alias name: ap-bgscan-idle) Wait time for channel inactivity before scanning this channel (0 - 1000 msec, default = 20). type: int more...
    • ap_bgscan_intv (Alias name: ap-bgscan-intv) Period between successive channel scans (1 - 600 sec, default = 3). type: int more...
    • ap_bgscan_period (Alias name: ap-bgscan-period) Period between background scans (10 - 3600 sec, default = 600). type: int more...
    • ap_bgscan_report_intv (Alias name: ap-bgscan-report-intv) Period between background scan reports (15 - 600 sec, default = 30). type: int more...
    • ap_fgscan_report_intv (Alias name: ap-fgscan-report-intv) Period between foreground scan reports (15 - 600 sec, default = 15). type: int more...
    • ap_scan (Alias name: ap-scan) Enable/disable rogue ap detection. type: str choices: [disable, enable] more...
    • ap_scan_channel_list_2G_5G (Alias name: ap-scan-channel-list-2G-5G) Selected ap scan channel list for 2. type: list more...
    • ap_scan_channel_list_6G (Alias name: ap-scan-channel-list-6G) Selected ap scan channel list for 6g band. type: list more...
    • ap_scan_passive (Alias name: ap-scan-passive) Enable/disable passive scanning. type: str choices: [disable, enable] more...
    • ap_scan_threshold (Alias name: ap-scan-threshold) Minimum signal level/threshold in dbm required for the ap to report detected rogue ap (-95 to -20, default = -90). type: str more...
    • asleap_attack (Alias name: asleap-attack) Enable/disable asleap attack detection (default = disable). type: str choices: [disable, enable] more...
    • assoc_flood_thresh (Alias name: assoc-flood-thresh) The threshold value for association frame flooding. type: int more...
    • assoc_flood_time (Alias name: assoc-flood-time) Number of seconds after which a station is considered not connected. type: int more...
    • assoc_frame_flood (Alias name: assoc-frame-flood) Enable/disable association frame flooding detection (default = disable). type: str choices: [disable, enable] more...
    • auth_flood_thresh (Alias name: auth-flood-thresh) The threshold value for authentication frame flooding. type: int more...
    • auth_flood_time (Alias name: auth-flood-time) Number of seconds after which a station is considered not connected. type: int more...
    • auth_frame_flood (Alias name: auth-frame-flood) Enable/disable authentication frame flooding detection (default = disable). type: str choices: [disable, enable] more...
    • comment Comment. type: str more...
    • deauth_broadcast (Alias name: deauth-broadcast) Enable/disable broadcasting de-authentication detection (default = disable). type: str choices: [disable, enable] more...
    • deauth_unknown_src_thresh (Alias name: deauth-unknown-src-thresh) Threshold value per second to deauth unknown src for dos attack (0: no limit). type: int more...
    • eapol_fail_flood (Alias name: eapol-fail-flood) Enable/disable eapol-failure flooding (to ap) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_fail_intv (Alias name: eapol-fail-intv) The detection interval for eapol-failure flooding (1 - 3600 sec). type: int more...
    • eapol_fail_thresh (Alias name: eapol-fail-thresh) The threshold value for eapol-failure flooding in specified interval. type: int more...
    • eapol_logoff_flood (Alias name: eapol-logoff-flood) Enable/disable eapol-logoff flooding (to ap) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_logoff_intv (Alias name: eapol-logoff-intv) The detection interval for eapol-logoff flooding (1 - 3600 sec). type: int more...
    • eapol_logoff_thresh (Alias name: eapol-logoff-thresh) The threshold value for eapol-logoff flooding in specified interval. type: int more...
    • eapol_pre_fail_flood (Alias name: eapol-pre-fail-flood) Enable/disable premature eapol-failure flooding (to sta) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_pre_fail_intv (Alias name: eapol-pre-fail-intv) The detection interval for premature eapol-failure flooding (1 - 3600 sec). type: int more...
    • eapol_pre_fail_thresh (Alias name: eapol-pre-fail-thresh) The threshold value for premature eapol-failure flooding in specified interval. type: int more...
    • eapol_pre_succ_flood (Alias name: eapol-pre-succ-flood) Enable/disable premature eapol-success flooding (to sta) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_pre_succ_intv (Alias name: eapol-pre-succ-intv) The detection interval for premature eapol-success flooding (1 - 3600 sec). type: int more...
    • eapol_pre_succ_thresh (Alias name: eapol-pre-succ-thresh) The threshold value for premature eapol-success flooding in specified interval. type: int more...
    • eapol_start_flood (Alias name: eapol-start-flood) Enable/disable eapol-start flooding (to ap) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_start_intv (Alias name: eapol-start-intv) The detection interval for eapol-start flooding (1 - 3600 sec). type: int more...
    • eapol_start_thresh (Alias name: eapol-start-thresh) The threshold value for eapol-start flooding in specified interval. type: int more...
    • eapol_succ_flood (Alias name: eapol-succ-flood) Enable/disable eapol-success flooding (to ap) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_succ_intv (Alias name: eapol-succ-intv) The detection interval for eapol-success flooding (1 - 3600 sec). type: int more...
    • eapol_succ_thresh (Alias name: eapol-succ-thresh) The threshold value for eapol-success flooding in specified interval. type: int more...
    • invalid_mac_oui (Alias name: invalid-mac-oui) Enable/disable invalid mac oui detection. type: str choices: [disable, enable] more...
    • long_duration_attack (Alias name: long-duration-attack) Enable/disable long duration attack detection based on user configured threshold (default = disable). type: str choices: [disable, enable] more...
    • long_duration_thresh (Alias name: long-duration-thresh) Threshold value for long duration attack detection (1000 - 32767 usec, default = 8200). type: int more...
    • name Wids profile name. type: str more...
    • null_ssid_probe_resp (Alias name: null-ssid-probe-resp) Enable/disable null ssid probe response detection (default = disable). type: str choices: [disable, enable] more...
    • sensor_mode (Alias name: sensor-mode) Scan nearby wifi stations (default = disable). type: str choices: [disable, foreign, both] more...
    • spoofed_deauth (Alias name: spoofed-deauth) Enable/disable spoofed de-authentication attack detection (default = disable). type: str choices: [disable, enable] more...
    • weak_wep_iv (Alias name: weak-wep-iv) Enable/disable weak wep iv (initialization vector) detection (default = disable). type: str choices: [disable, enable] more...
    • wireless_bridge (Alias name: wireless-bridge) Enable/disable wireless bridge detection (default = disable). type: str choices: [disable, enable] more...
    • adhoc_network (Alias name: adhoc-network) Enable/disable adhoc network detection (default = disable). type: str choices: [disable, enable] more...
    • adhoc_valid_ssid (Alias name: adhoc-valid-ssid) Enable/disable adhoc using valid ssid detection (default = disable). type: str choices: [disable, enable] more...
    • air_jack (Alias name: air-jack) Enable/disable airjack detection (default = disable). type: str choices: [disable, enable] more...
    • ap_impersonation (Alias name: ap-impersonation) Enable/disable ap impersonation detection (default = disable). type: str choices: [disable, enable] more...
    • ap_spoofing (Alias name: ap-spoofing) Enable/disable ap spoofing detection (default = disable). type: str choices: [disable, enable] more...
    • bcn_flood (Alias name: bcn-flood) Enable/disable bcn flood detection (default = disable). type: str choices: [disable, enable] more...
    • bcn_flood_thresh (Alias name: bcn-flood-thresh) The threshold value for bcn flood. type: int more...
    • bcn_flood_time (Alias name: bcn-flood-time) Detection window period. type: int more...
    • beacon_wrong_channel (Alias name: beacon-wrong-channel) Enable/disable beacon wrong channel detection (default = disable). type: str choices: [disable, enable] more...
    • block_ack_flood (Alias name: block_ack-flood) Enable/disable block_ack flood detection (default = disable). type: str choices: [disable, enable] more...
    • block_ack_flood_thresh (Alias name: block_ack-flood-thresh) The threshold value for block_ack flood. type: int more...
    • block_ack_flood_time (Alias name: block_ack-flood-time) Detection window period. type: int more...
    • chan_based_mitm (Alias name: chan-based-mitm) Enable/disable channel based mitm detection (default = disable). type: str choices: [disable, enable] more...
    • client_flood (Alias name: client-flood) Enable/disable client flood detection (default = disable). type: str choices: [disable, enable] more...
    • client_flood_thresh (Alias name: client-flood-thresh) The threshold value for client flood. type: int more...
    • client_flood_time (Alias name: client-flood-time) Detection window period. type: int more...
    • cts_flood (Alias name: cts-flood) Enable/disable cts flood detection (default = disable). type: str choices: [disable, enable] more...
    • cts_flood_thresh (Alias name: cts-flood-thresh) The threshold value for cts flood. type: int more...
    • cts_flood_time (Alias name: cts-flood-time) Detection window period. type: int more...
    • disassoc_broadcast (Alias name: disassoc-broadcast) Enable/disable broadcast dis-association detection (default = disable). type: str choices: [disable, enable] more...
    • disconnect_station (Alias name: disconnect-station) Enable/disable disconnect station detection (default = disable). type: str choices: [disable, enable] more...
    • eapol_key_overflow (Alias name: eapol-key-overflow) Enable/disable overflow eapol key detection (default = disable). type: str choices: [disable, enable] more...
    • fata_jack (Alias name: fata-jack) Enable/disable fata-jack detection (default = disable). type: str choices: [disable, enable] more...
    • fuzzed_beacon (Alias name: fuzzed-beacon) Enable/disable fuzzed beacon detection (default = disable). type: str choices: [disable, enable] more...
    • fuzzed_probe_request (Alias name: fuzzed-probe-request) Enable/disable fuzzed probe request detection (default = disable). type: str choices: [disable, enable] more...
    • fuzzed_probe_response (Alias name: fuzzed-probe-response) Enable/disable fuzzed probe response detection (default = disable). type: str choices: [disable, enable] more...
    • hotspotter_attack (Alias name: hotspotter-attack) Enable/disable hotspotter attack detection (default = disable). type: str choices: [disable, enable] more...
    • ht_40mhz_intolerance (Alias name: ht-40mhz-intolerance) Enable/disable ht 40 mhz intolerance detection (default = disable). type: str choices: [disable, enable] more...
    • ht_greenfield (Alias name: ht-greenfield) Enable/disable ht greenfield detection (default = disable). type: str choices: [disable, enable] more...
    • invalid_addr_combination (Alias name: invalid-addr-combination) Enable/disable invalid address combination detection (default = disable). type: str choices: [disable, enable] more...
    • malformed_association (Alias name: malformed-association) Enable/disable malformed association request detection (default = disable). type: str choices: [disable, enable] more...
    • malformed_auth (Alias name: malformed-auth) Enable/disable malformed auth frame detection (default = disable). type: str choices: [disable, enable] more...
    • malformed_ht_ie (Alias name: malformed-ht-ie) Enable/disable malformed ht ie detection (default = disable). type: str choices: [disable, enable] more...
    • netstumbler Enable/disable netstumbler detection (default = disable). type: str choices: [disable, enable] more...
    • netstumbler_thresh (Alias name: netstumbler-thresh) The threshold value for netstumbler. type: int more...
    • netstumbler_time (Alias name: netstumbler-time) Detection window period. type: int more...
    • omerta_attack (Alias name: omerta-attack) Enable/disable omerta attack detection (default = disable). type: str choices: [disable, enable] more...
    • overflow_ie (Alias name: overflow-ie) Enable/disable overflow ie detection (default = disable). type: str choices: [disable, enable] more...
    • probe_flood (Alias name: probe-flood) Enable/disable probe flood detection (default = disable). type: str choices: [disable, enable] more...
    • probe_flood_thresh (Alias name: probe-flood-thresh) The threshold value for probe flood. type: int more...
    • probe_flood_time (Alias name: probe-flood-time) Detection window period. type: int more...
    • pspoll_flood (Alias name: pspoll-flood) Enable/disable pspoll flood detection (default = disable). type: str choices: [disable, enable] more...
    • pspoll_flood_thresh (Alias name: pspoll-flood-thresh) The threshold value for pspoll flood. type: int more...
    • pspoll_flood_time (Alias name: pspoll-flood-time) Detection window period. type: int more...
    • pwsave_dos_attack (Alias name: pwsave-dos-attack) Enable/disable power save dos attack detection (default = disable). type: str choices: [disable, enable] more...
    • reassoc_flood (Alias name: reassoc-flood) Enable/disable reassociation flood detection (default = disable). type: str choices: [disable, enable] more...
    • reassoc_flood_thresh (Alias name: reassoc-flood-thresh) The threshold value for reassociation flood. type: int more...
    • reassoc_flood_time (Alias name: reassoc-flood-time) Detection window period. type: int more...
    • risky_encryption (Alias name: risky-encryption) Enable/disable risky encryption detection (default = disable). type: str choices: [disable, enable] more...
    • rts_flood (Alias name: rts-flood) Enable/disable rts flood detection (default = disable). type: str choices: [disable, enable] more...
    • rts_flood_thresh (Alias name: rts-flood-thresh) The threshold value for rts flood. type: int more...
    • rts_flood_time (Alias name: rts-flood-time) Detection window period. type: int more...
    • unencrypted_valid (Alias name: unencrypted-valid) Enable/disable unencrypted valid detection (default = disable). type: str choices: [disable, enable] more...
    • valid_client_misassociation (Alias name: valid-client-misassociation) Enable/disable valid client misassociation detection (default = disable). type: str choices: [disable, enable] more...
    • valid_ssid_misuse (Alias name: valid-ssid-misuse) Enable/disable valid ssid misuse detection (default = disable). type: str choices: [disable, enable] more...
    • wellenreiter Enable/disable wellenreiter detection (default = disable). type: str choices: [disable, enable] more...
    • wellenreiter_thresh (Alias name: wellenreiter-thresh) The threshold value for wellenreiter. type: int more...
    • wellenreiter_time (Alias name: wellenreiter-time) Detection window period. type: int more...
    • windows_bridge (Alias name: windows-bridge) Enable/disable windows bridge detection (default = disable). type: str choices: [disable, enable] more...
    • wpa_ft_attack (Alias name: wpa-ft-attack) Enable/disable wpa ft attack detection (default = disable). type: str choices: [disable, enable] more...

Notes

Note

  • 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
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure wireless intrusion detection system
      fortinet.fmgdevice.fmgd_wireless_widsprofile:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        wireless_widsprofile:
          name: "your value" # Required variable, string
          # ap_auto_suppress: <value in [disable, enable]>
          # ap_bgscan_disable_schedules: <list or 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_channel_list_2G_5G: <list or string>
          # ap_scan_channel_list_6G: <list or string>
          # ap_scan_passive: <value in [disable, enable]>
          # ap_scan_threshold: <string>
          # 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>
          # 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]>
          # adhoc_network: <value in [disable, enable]>
          # adhoc_valid_ssid: <value in [disable, enable]>
          # air_jack: <value in [disable, enable]>
          # ap_impersonation: <value in [disable, enable]>
          # ap_spoofing: <value in [disable, enable]>
          # bcn_flood: <value in [disable, enable]>
          # bcn_flood_thresh: <integer>
          # bcn_flood_time: <integer>
          # beacon_wrong_channel: <value in [disable, enable]>
          # block_ack_flood: <value in [disable, enable]>
          # block_ack_flood_thresh: <integer>
          # block_ack_flood_time: <integer>
          # chan_based_mitm: <value in [disable, enable]>
          # client_flood: <value in [disable, enable]>
          # client_flood_thresh: <integer>
          # client_flood_time: <integer>
          # cts_flood: <value in [disable, enable]>
          # cts_flood_thresh: <integer>
          # cts_flood_time: <integer>
          # disassoc_broadcast: <value in [disable, enable]>
          # disconnect_station: <value in [disable, enable]>
          # eapol_key_overflow: <value in [disable, enable]>
          # fata_jack: <value in [disable, enable]>
          # fuzzed_beacon: <value in [disable, enable]>
          # fuzzed_probe_request: <value in [disable, enable]>
          # fuzzed_probe_response: <value in [disable, enable]>
          # hotspotter_attack: <value in [disable, enable]>
          # ht_40mhz_intolerance: <value in [disable, enable]>
          # ht_greenfield: <value in [disable, enable]>
          # invalid_addr_combination: <value in [disable, enable]>
          # malformed_association: <value in [disable, enable]>
          # malformed_auth: <value in [disable, enable]>
          # malformed_ht_ie: <value in [disable, enable]>
          # netstumbler: <value in [disable, enable]>
          # netstumbler_thresh: <integer>
          # netstumbler_time: <integer>
          # omerta_attack: <value in [disable, enable]>
          # overflow_ie: <value in [disable, enable]>
          # probe_flood: <value in [disable, enable]>
          # probe_flood_thresh: <integer>
          # probe_flood_time: <integer>
          # pspoll_flood: <value in [disable, enable]>
          # pspoll_flood_thresh: <integer>
          # pspoll_flood_time: <integer>
          # pwsave_dos_attack: <value in [disable, enable]>
          # reassoc_flood: <value in [disable, enable]>
          # reassoc_flood_thresh: <integer>
          # reassoc_flood_time: <integer>
          # risky_encryption: <value in [disable, enable]>
          # rts_flood: <value in [disable, enable]>
          # rts_flood_thresh: <integer>
          # rts_flood_time: <integer>
          # unencrypted_valid: <value in [disable, enable]>
          # valid_client_misassociation: <value in [disable, enable]>
          # valid_ssid_misuse: <value in [disable, enable]>
          # wellenreiter: <value in [disable, enable]>
          # wellenreiter_thresh: <integer>
          # wellenreiter_time: <integer>
          # windows_bridge: <value in [disable, enable]>
          # wpa_ft_attack: <value in [disable, 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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)