fortinet.fortios.fortios_log_disk_filter 模块 – 配置本地磁盘日志记录的过滤器。使用这些过滤器根据严重性和类型确定在 Fortinet 的 FortiOS 和 FortiGate 中记录的日志消息。

注意

此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

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

在 fortinet.fortios 2.0.0 中新增

概要

• 此模块能够通过允许用户设置和修改 log_disk 功能和过滤器类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值，需要在使用前调整为数据源。已使用 FOS v6.0.0 进行测试

要求

执行此模块的主机需要满足以下要求。

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 Fortigate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
log_disk_filter 字典	配置本地磁盘日志记录的过滤器。使用这些过滤器根据严重性和类型确定要记录的日志消息。
admin 字符串	启用/禁用管理员登录/注销日志记录。 选项 "enable" "disable"
anomaly 字符串	启用/禁用异常日志记录。 选项 "enable" "disable"
auth 字符串	启用/禁用防火墙身份验证日志记录。 选项 "enable" "disable"
cpu_memory_usage 字符串	启用/禁用每 5 分钟记录一次 CPU 和内存使用情况。 选项 "enable" "disable"
dhcp 字符串	启用/禁用 DHCP 服务消息日志记录。 选项 "enable" "disable"
dlp_archive 字符串	启用/禁用 DLP 存档日志记录。 选项 "enable" "disable"
dns 字符串	启用/禁用详细的 DNS 事件日志记录。 选项 "enable" "disable"
event 字符串	启用/禁用事件日志记录。 选项 "enable" "disable"
filter 字符串	磁盘日志过滤器。
filter_type 字符串	包括/排除与过滤器匹配的日志。 选项 "include" "exclude"
forti_switch 字符串	启用/禁用 Forti-Switch 日志记录。 选项 "enable" "disable"
forward_traffic 字符串	启用/禁用转发流量日志记录。 选项 "enable" "disable"
free_style 列表 / 元素=字典	自由风格的过滤器。
category 字符串	日志类别。 选项 "traffic" "event" "virus" "webfilter" "attack" "spam" "anomaly" "voip" "dlp" "app-ctrl" "waf" "gtp" "dns" "ssh" "ssl" "file-filter" "icap" "virtual-patch" "ztna"
filter 字符串	自由风格的过滤器字符串。
filter_type 字符串	包括/排除与过滤器匹配的日志。 选项 "include" "exclude"
id 整数 / 必需	条目 ID。请参阅 <a href=’#notes’>注释</a>。
gtp 字符串	启用/禁用 GTP 消息日志记录。 选项 "enable" "disable"
ha 字符串	启用/禁用 HA 日志记录。 选项 "enable" "disable"
http_transaction 字符串	启用/禁用日志 HTTP 事务消息。 选项 "enable" "disable"
ipsec 字符串	启用/禁用 IPsec 协商消息日志记录。 选项 "enable" "disable"
ldb_monitor 字符串	启用/禁用 VIP 真实服务器健康监控日志记录。 选项 "enable" "disable"
local_traffic 字符串	启用/禁用本地传入或传出流量日志记录。 选项 "enable" "disable"
multicast_traffic 字符串	启用/禁用多播流量日志记录。 选项 "enable" "disable"
netscan_discovery 字符串	启用/禁用 netscan 发现事件日志记录。
netscan_vulnerability 字符串	启用/禁用 netscan 漏洞事件日志记录。
notification 字符串	启用/禁用通知消息日志记录。 选项 "enable" "disable"
pattern 字符串	启用/禁用模式更新日志记录。 选项 "enable" "disable"
ppp 字符串	启用/禁用 L2TP/PPTP/PPPoE 日志记录。 选项 "enable" "disable"
radius 字符串	启用/禁用 RADIUS 消息日志记录。 选项 "enable" "disable"
severity 字符串	记录高于和包括此严重性级别的每个消息到磁盘。 选项 "emergency" "alert" "critical" "error" "warning" "notification" "information" "debug"
sniffer_traffic 字符串	启用/禁用嗅探器流量日志记录。 选项 "enable" "disable"
ssh 字符串	启用/禁用 SSH 日志记录。 选项 "enable" "disable"
sslvpn_log_adm 字符串	启用/禁用 SSL 管理员登录日志记录。 选项 "enable" "disable"
sslvpn_log_auth 字符串	启用/禁用 SSL 用户身份验证日志记录。 选项 "enable" "disable"
sslvpn_log_session 字符串	启用/禁用 SSL 会话日志记录。 选项 "enable" "disable"
system 字符串	启用/禁用系统活动日志记录。 选项 "enable" "disable"
vip_ssl 字符串	启用/禁用 VIP SSL 日志记录。 选项 "enable" "disable"
voip 字符串	启用/禁用 VoIP 日志记录。 选项 "enable" "disable"
wan_opt 字符串	启用/禁用 WAN 优化事件日志记录。 选项 "enable" "disable"
wireless_activity 字符串	启用/禁用无线活动事件日志记录。 选项 "enable" "disable"
ztna_traffic 字符串	启用/禁用 ztna 流量日志记录。 选项 "enable" "disable"
member_path 字符串	要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标记为 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 当指定 member_state 时，将忽略 state 选项。 选项 “present” (存在) “absent” (不存在)
vdom 字符串	虚拟域，在之前定义的那些之中。一个 vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。 默认值: "root"

备注

注意

• 旧的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type.
  fortinet.fortios.fortios_log_disk_filter:
      vdom: "{{ vdom }}"
      log_disk_filter:
          admin: "enable"
          anomaly: "enable"
          auth: "enable"
          cpu_memory_usage: "enable"
          dhcp: "enable"
          dlp_archive: "enable"
          dns: "enable"
          event: "enable"
          filter: "<your_own_value>"
          filter_type: "include"
          forti_switch: "enable"
          forward_traffic: "enable"
          free_style:
              -
                  category: "traffic"
                  filter: "<your_own_value>"
                  filter_type: "include"
                  id: "19"
          gtp: "enable"
          ha: "enable"
          http_transaction: "enable"
          ipsec: "enable"
          ldb_monitor: "enable"
          local_traffic: "enable"
          multicast_traffic: "enable"
          netscan_discovery: "<your_own_value>"
          netscan_vulnerability: "<your_own_value>"
          notification: "enable"
          pattern: "enable"
          ppp: "enable"
          radius: "enable"
          severity: "emergency"
          sniffer_traffic: "enable"
          ssh: "enable"
          sslvpn_log_adm: "enable"
          sslvpn_log_auth: "enable"
          sslvpn_log_session: "enable"
          system: "enable"
          vip_ssl: "enable"
          voip: "enable"
          wan_opt: "enable"
          wireless_activity: "enable"
          ztna_traffic: "enable"

返回值

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

键	描述
build 字符串	FortiGate 镜像的版本号 返回值: 总是返回 示例: "1547"
http_method 字符串	上次将内容配置到 FortiGate 中使用的方法 返回值: 总是返回 示例: "PUT"
http_status 字符串	上次应用操作后，FortiGate 给出的最后结果 返回值: 总是返回 示例: "200"
mkey 字符串	上次调用 FortiGate 时使用的主键 (id) 返回值: 成功时返回 示例: "id"
name 字符串	用于满足请求的表名 返回值: 总是返回 示例: "urlfilter"
path 字符串	用于满足请求的表路径 返回值: 总是返回 示例: "webfilter"
revision 字符串	内部修订版本号 返回值: 总是返回 示例: "17.0.2.10658"
serial 字符串	设备的序列号 返回值: 总是返回 示例: "FGVMEVYYQT3AB5352"
status 字符串	操作结果的指示 返回值: 总是返回 示例: "success"
vdom 字符串	使用的虚拟域 返回值: 总是返回 示例: "root"
version 字符串	FortiGate 的版本 返回值: 总是返回 示例: "v5.6.3"

作者

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)