fortinet.fortimanager.fmgr_widsprofile 模块 – 配置无线入侵检测系统

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_widsprofile。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包含所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

widsprofile

字典

设置的顶级参数。

ap_auto_suppress

别名：ap-auto-suppress

字符串

启用/禁用在线恶意 AP 自动抑制

选项

  • "disable"

  • "enable"

ap_bgscan_disable_day

别名：ap-bgscan-disable-day

列表 / 元素=字符串

可以选择关闭一周中一到多天的扫描。

选项

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

ap_bgscan_disable_end

别名：ap-bgscan-disable-end

字符串

结束时间，使用 24 小时制，格式为 hh

ap_bgscan_disable_schedules

别名：ap-bgscan-disable-schedules

任意

(列表或字符串) 用于关闭 FortiAP 无线背景扫描的防火墙计划。

ap_bgscan_disable_start

别名：ap-bgscan-disable-start

字符串

开始时间，使用 24 小时制，格式为 hh

ap_bgscan_duration

别名：ap-bgscan-duration

整数

扫描信道上的侦听时间

ap_bgscan_idle

别名：ap-bgscan-idle

整数

扫描此信道之前等待信道空闲的时间

ap_bgscan_intv

别名：ap-bgscan-intv

整数

扫描两个信道之间的时间段

ap_bgscan_period

别名：ap-bgscan-period

整数

两次背景扫描之间的时间段

ap_bgscan_report_intv

别名：ap-bgscan-report-intv

整数

两次背景扫描报告之间的时间段

ap_fgscan_report_intv

别名：ap-fgscan-report-intv

整数

两次前台扫描报告之间的时间段

ap_scan

别名：ap-scan

字符串

启用/禁用恶意 AP 检测。

选项

  • "disable"

  • "enable"

ap_scan_channel_list_2G_5G

别名：ap-scan-channel-list-2G-5G

任意

(列表) 为 2G 选择的 AP 扫描信道列表。

ap_scan_channel_list_6G

别名：ap-scan-channel-list-6G

任意

(列表) 为 6G 频段选择的 AP 扫描信道列表。

ap_scan_passive

别名：ap-scan-passive

字符串

启用/禁用被动扫描。

选项

  • "disable"

  • "enable"

ap_scan_threshold

别名：ap-scan-threshold

字符串

AP 报告检测到的恶意 AP 所需的最小信号电平/阈值（单位：dBm）

asleap_attack

别名：asleap-attack

字符串

启用/禁用 asleap 攻击检测

选项

  • "disable"

  • "enable"

assoc_flood_thresh

别名：assoc-flood-thresh

整数

关联帧泛洪的阈值。

assoc_flood_time

别名：assoc-flood-time

整数

认为站点未连接的秒数。

assoc_frame_flood

别名：assoc-frame-flood

字符串

启用/禁用关联帧泛洪检测

选项

  • "disable"

  • "enable"

auth_flood_thresh

别名：auth-flood-thresh

整数

身份验证帧泛洪的阈值。

auth_flood_time

别名：auth-flood-time

整数

认为站点未连接的秒数。

auth_frame_flood

别名：auth-frame-flood

字符串

启用/禁用身份验证帧泛洪检测

选项

  • "disable"

  • "enable"

comment

字符串

注释。

deauth_broadcast

别名：deauth-broadcast

字符串

启用/禁用广播去认证检测

选项

  • "disable"

  • "enable"

deauth_unknown_src_thresh

别名：deauth-unknown-src-thresh

整数

每秒针对DoS攻击去认证未知源的阈值

eapol_fail_flood

别名：eapol-fail-flood

字符串

启用/禁用EAPOL失败泛洪

选项

  • "disable"

  • "enable"

eapol_fail_intv

别名：eapol-fail-intv

整数

EAPOL失败泛洪的检测间隔

eapol_fail_thresh

别名：eapol-fail-thresh

整数

指定间隔内EAPOL失败泛洪的阈值。

eapol_logoff_flood

别名：eapol-logoff-flood

字符串

启用/禁用EAPOL注销泛洪

选项

  • "disable"

  • "enable"

eapol_logoff_intv

别名：eapol-logoff-intv

整数

EAPOL注销泛洪的检测间隔

eapol_logoff_thresh

别名：eapol-logoff-thresh

整数

指定间隔内EAPOL注销泛洪的阈值。

eapol_pre_fail_flood

别名：eapol-pre-fail-flood

字符串

启用/禁用过早EAPOL失败泛洪

选项

  • "disable"

  • "enable"

eapol_pre_fail_intv

别名：eapol-pre-fail-intv

整数

过早EAPOL失败泛洪的检测间隔

eapol_pre_fail_thresh

别名：eapol-pre-fail-thresh

整数

指定间隔内过早EAPOL失败泛洪的阈值。

eapol_pre_succ_flood

别名：eapol-pre-succ-flood

字符串

启用/禁用过早EAPOL成功泛洪

选项

  • "disable"

  • "enable"

eapol_pre_succ_intv

别名：eapol-pre-succ-intv

整数

过早EAPOL成功泛洪的检测间隔

eapol_pre_succ_thresh

别名：eapol-pre-succ-thresh

整数

指定间隔内过早EAPOL成功泛洪的阈值。

eapol_start_flood

别名：eapol-start-flood

字符串

启用/禁用EAPOL启动泛洪

选项

  • "disable"

  • "enable"

eapol_start_intv

别名：eapol-start-intv

整数

EAPOL启动泛洪的检测间隔

eapol_start_thresh

别名：eapol-start-thresh

整数

指定间隔内EAPOL启动泛洪的阈值。

eapol_succ_flood

别名：eapol-succ-flood

字符串

启用/禁用EAPOL成功泛洪

选项

  • "disable"

  • "enable"

eapol_succ_intv

别名：eapol-succ-intv

整数

EAPOL成功泛洪的检测间隔

eapol_succ_thresh

别名：eapol-succ-thresh

整数

指定间隔内EAPOL成功泛洪的阈值。

invalid_mac_oui

别名：invalid-mac-oui

字符串

启用/禁用无效MAC OUI检测。

选项

  • "disable"

  • "enable"

long_duration_attack

别名：long-duration-attack

字符串

基于用户配置的阈值启用/禁用长时间攻击检测

选项

  • "disable"

  • "enable"

long_duration_thresh

别名：long-duration-thresh

整数

长时间攻击检测的阈值

名称

字符串 / 必需

WIDS配置文件名称。

null_ssid_probe_resp

别名：null-ssid-probe-resp

字符串

启用/禁用空SSID探测响应检测

选项

  • "disable"

  • "enable"

rogue_scan

别名：rogue-scan

字符串

启用/禁用恶意AP在线扫描。

选项

  • "disable"

  • "enable"

sensor_mode

别名：sensor-mode

字符串

扫描附近的WiFi站点

选项

  • "disable"

  • "foreign"

  • "both"

spoofed_deauth

别名：spoofed-deauth

字符串

启用/禁用伪造去认证攻击检测

选项

  • "disable"

  • "enable"

weak_wep_iv

别名：weak-wep-iv

字符串

启用/禁用弱WEP IV

选项

  • "disable"

  • "enable"

wireless_bridge

别名：wireless-bridge

字符串

启用/禁用无线桥接检测

选项

  • "disable"

  • "enable"

workspace_locking_adom

字符串

在工作区模式下运行FortiManager时要锁定的ADOM，值可以是global和其他包括root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

注释

注意

  • 从2.4.0版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以在ansible.cfg中设置deprecation_warnings=False来忽略此警告。

  • 此FortiManager模块支持在工作区锁定模式下运行，顶级参数workspace_locking_adom和workspace_locking_timeout有助于完成此工作。

  • 要创建或更新对象，请使用state present指令。

  • 要删除对象，请使用state absent指令。

  • 通常，当返回非零rc时，运行一个模块可能会失败。您还可以使用参数rc_failed和rc_succeeded覆盖失败或成功的条件。

示例

- 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>

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回：始终

request_url

字符串

请求的完整URL。

返回：始终

示例： "/sys/login/user"

response_code

整数

API请求的状态。

返回：始终

示例： 0

response_data

列表 / 元素=字符串

API响应。

返回：始终

response_message

字符串

API响应的描述性消息。

返回：始终

示例： "OK."

system_information

字典

目标系统的信息。

返回：始终

rc

整数

请求的状态。

返回：始终

示例： 0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。

返回：复杂

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑林 (@chillancezen)

  • 沈方 (@fshen01)

  • 卢宏斌 (@fgtdev-hblu)