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

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
widsprofile yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • widsprofile - no description type: dict
    • ap-auto-suppress - Enable/disable on-wire rogue AP auto-suppression (default = disable). type: str choices: [disable, enable] more...
    • ap-bgscan-disable-day - Ap-Bgscan-Disable-Day. type: array choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
    • ap-bgscan-disable-end - End time, using a 24-hour clock in the format of hh:mm, for disabling background scanning (default = 00:00). type: str more...
    • ap-bgscan-disable-start - Start time, using a 24-hour clock in the format of hh:mm, for disabling background scanning (default = 00:00). type: str more...
    • ap-bgscan-duration - Listening time on a scanning channel (10 - 1000 msec, default = 20). type: int more...
    • ap-bgscan-idle - Waiting time for channel inactivity before scanning this channel (0 - 1000 msec, default = 0). type: int more...
    • ap-bgscan-intv - Period of time between scanning two channels (1 - 600 sec, default = 1). type: int more...
    • ap-bgscan-period - Period of time between background scans (60 - 3600 sec, default = 600). type: int more...
    • ap-bgscan-report-intv - Period of time between background scan reports (15 - 600 sec, default = 30). type: int more...
    • ap-fgscan-report-intv - Period of time between foreground scan reports (15 - 600 sec, default = 15). type: int more...
    • ap-scan - Enable/disable rogue AP detection. type: str choices: [disable, enable] more...
    • ap-scan-passive - Enable/disable passive scanning. type: str choices: [disable, enable] more...
    • asleap-attack - Enable/disable asleap attack detection (default = disable). type: str choices: [disable, enable] more...
    • assoc-flood-thresh - The threshold value for association frame flooding. type: int more...
    • assoc-flood-time - Number of seconds after which a station is considered not connected. type: int more...
    • assoc-frame-flood - Enable/disable association frame flooding detection (default = disable). type: str choices: [disable, enable] more...
    • auth-flood-thresh - The threshold value for authentication frame flooding. type: int more...
    • auth-flood-time - Number of seconds after which a station is considered not connected. type: int more...
    • auth-frame-flood - Enable/disable authentication frame flooding detection (default = disable). type: str choices: [disable, enable] more...
    • comment - Comment. type: str more...
    • deauth-broadcast - Enable/disable broadcasting de-authentication detection (default = disable). type: str choices: [disable, enable] more...
    • deauth-unknown-src-thresh - Threshold value per second to deauth unknown src for DoS attack (0: no limit). type: int more...
    • eapol-fail-flood - Enable/disable EAPOL-Failure flooding (to AP) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol-fail-intv - The detection interval for EAPOL-Failure flooding (1 - 3600 sec). type: int more...
    • eapol-fail-thresh - The threshold value for EAPOL-Failure flooding in specified interval. type: int more...
    • eapol-logoff-flood - Enable/disable EAPOL-Logoff flooding (to AP) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol-logoff-intv - The detection interval for EAPOL-Logoff flooding (1 - 3600 sec). type: int more...
    • eapol-logoff-thresh - The threshold value for EAPOL-Logoff flooding in specified interval. type: int more...
    • 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 - The detection interval for premature EAPOL-Failure flooding (1 - 3600 sec). type: int more...
    • eapol-pre-fail-thresh - The threshold value for premature EAPOL-Failure flooding in specified interval. type: int more...
    • 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 - The detection interval for premature EAPOL-Success flooding (1 - 3600 sec). type: int more...
    • eapol-pre-succ-thresh - The threshold value for premature EAPOL-Success flooding in specified interval. type: int more...
    • eapol-start-flood - Enable/disable EAPOL-Start flooding (to AP) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol-start-intv - The detection interval for EAPOL-Start flooding (1 - 3600 sec). type: int more...
    • eapol-start-thresh - The threshold value for EAPOL-Start flooding in specified interval. type: int more...
    • eapol-succ-flood - Enable/disable EAPOL-Success flooding (to AP) detection (default = disable). type: str choices: [disable, enable] more...
    • eapol-succ-intv - The detection interval for EAPOL-Success flooding (1 - 3600 sec). type: int more...
    • eapol-succ-thresh - The threshold value for EAPOL-Success flooding in specified interval. type: int more...
    • invalid-mac-oui - Enable/disable invalid MAC OUI detection. type: str choices: [disable, enable] more...
    • 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 - 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 - Enable/disable null SSID probe response detection (default = disable). type: str choices: [disable, enable] more...
    • sensor-mode - Scan WiFi nearby stations (default = disable). type: str choices: [disable, foreign, both] more...
    • spoofed-deauth - Enable/disable spoofed de-authentication attack detection (default = disable). type: str choices: [disable, enable] more...
    • weak-wep-iv - Enable/disable weak WEP IV (Initialization Vector) detection (default = disable). type: str choices: [disable, enable] more...
    • wireless-bridge - Enable/disable wireless bridge detection (default = disable). type: str choices: [disable, enable] more...
    • ap-bgscan-disable-schedules - Firewall schedules for turning off FortiAP radio background scan. type: str more...
    • 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...

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

- 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: no description
     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]>
           ap-bgscan-disable-schedules: <value of string>
           ap-scan-threshold: <value of string>

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.