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

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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 v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> 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
  • adom - The parameter in requested url type: str required: true
  • 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_day (Alias name: ap-bgscan-disable-day) Ap-bgscan-disable-day. type: list choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
    • ap_bgscan_disable_end (Alias name: 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 (Alias name: 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 (Alias name: ap-bgscan-duration) Listening time on a scanning channel (10 - 1000 msec, default = 20). type: int more...
    • ap_bgscan_idle (Alias name: ap-bgscan-idle) Waiting time for channel inactivity before scanning this channel (0 - 1000 msec, default = 0). type: int more...
    • ap_bgscan_intv (Alias name: ap-bgscan-intv) Period of time between scanning two channels (1 - 600 sec, default = 1). type: int more...
    • ap_bgscan_period (Alias name: ap-bgscan-period) Period of time between background scans (60 - 3600 sec, default = 600). type: int more...
    • ap_bgscan_report_intv (Alias name: ap-bgscan-report-intv) Period of time between background scan reports (15 - 600 sec, default = 30). type: int more...
    • ap_fgscan_report_intv (Alias name: ap-fgscan-report-intv) Period of time 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_passive (Alias name: ap-scan-passive) Enable/disable passive scanning. type: str choices: [disable, enable] 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 wifi nearby 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...
    • ap_bgscan_disable_schedules (Alias name: ap-bgscan-disable-schedules) Firewall schedules for turning off fortiap radio background scan. type: list or str more...
    • rogue_scan (Alias name: rogue-scan) Enable/disable rogue ap on-wire scan. 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...
    • ap_scan_channel_list_2G_5G (Alias name: ap-scan-channel-list-2G-5G) type: list more...
    • ap_scan_channel_list_6G (Alias name: ap-scan-channel-list-6G) type: list 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
  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: 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)