fortinet.fortios.fortios_log_fact 模块 – 获取 fortios 日志对象的日志数据。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_log_fact。

fortinet.fortios 2.1.0 中的新增功能

概要

  • 检索与磁盘、内存、FortiAnalyzer 和 FortiCloud 相关的日志。

要求

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

  • 安装 galaxy 集合 fortinet.fortios >= 2.1.0。

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

filters

列表 / 元素=字符串

用于筛选返回结果的表达式列表。

列表项使用与运算符进行逻辑与组合。

一个项本身可以使用逗号进行逻辑或连接。

formatters

列表 / 元素=字符串

用于显示返回结果的字段列表。

params

字典

每个选择器的参数，请参见上述列表中的定义。

selector

字符串

检索的日志类型的选择器

选项

  • "disk_virus_archive"

  • "memory_virus_archive"

  • "fortianalyzer_virus_archive"

  • "forticloud_virus_archive"

  • "disk_ips_archive"

  • "disk_app-ctrl_archive"

  • "memory_ips_archive"

  • "memory_app-ctrl_archive"

  • "fortianalyzer_ips_archive"

  • "fortianalyzer_app-ctrl_archive"

  • "forticloud_ips_archive"

  • "forticloud_app-ctrl_archive"

  • "disk_ips_archive-download"

  • "disk_app-ctrl_archive-download"

  • "memory_ips_archive-download"

  • "memory_app-ctrl_archive-download"

  • "fortianalyzer_ips_archive-download"

  • "fortianalyzer_app-ctrl_archive-download"

  • "forticloud_ips_archive-download"

  • "forticloud_app-ctrl_archive-download"

  • "disk_virus_raw"

  • "disk_webfilter_raw"

  • "disk_waf_raw"

  • "disk_ips_raw"

  • "disk_anomaly_raw"

  • "disk_app-ctrl_raw"

  • "disk_cifs_raw"

  • "disk_emailfilter_raw"

  • "disk_dlp_raw"

  • "disk_voip_raw"

  • "disk_gtp_raw"

  • "disk_dns_raw"

  • "disk_ssh_raw"

  • "disk_ssl_raw"

  • "disk_file-filter_raw"

  • "memory_virus_raw"

  • "memory_webfilter_raw"

  • "memory_waf_raw"

  • "memory_ips_raw"

  • "memory_anomaly_raw"

  • "memory_app-ctrl_raw"

  • "memory_cifs_raw"

  • "memory_emailfilter_raw"

  • "memory_dlp_raw"

  • "memory_voip_raw"

  • "memory_gtp_raw"

  • "memory_dns_raw"

  • "memory_ssh_raw"

  • "memory_ssl_raw"

  • "memory_file-filter_raw"

  • "fortianalyzer_virus_raw"

  • "fortianalyzer_webfilter_raw"

  • "fortianalyzer_waf_raw"

  • "fortianalyzer_ips_raw"

  • "fortianalyzer_anomaly_raw"

  • "fortianalyzer_app-ctrl_raw"

  • "fortianalyzer_cifs_raw"

  • "fortianalyzer_emailfilter_raw"

  • "fortianalyzer_dlp_raw"

  • "fortianalyzer_voip_raw"

  • "fortianalyzer_gtp_raw"

  • "fortianalyzer_dns_raw"

  • "fortianalyzer_ssh_raw"

  • "fortianalyzer_ssl_raw"

  • "fortianalyzer_file-filter_raw"

  • "forticloud_virus_raw"

  • "forticloud_webfilter_raw"

  • "forticloud_waf_raw"

  • "forticloud_ips_raw"

  • "forticloud_anomaly_raw"

  • "forticloud_app-ctrl_raw"

  • "forticloud_cifs_raw"

  • "forticloud_emailfilter_raw"

  • "forticloud_dlp_raw"

  • "forticloud_voip_raw"

  • "forticloud_gtp_raw"

  • "forticloud_dns_raw"

  • "forticloud_ssh_raw"

  • "forticloud_ssl_raw"

  • "forticloud_file-filter_raw"

  • "disk_event_vpn"

  • "disk_event_user"

  • "disk_event_router"

  • "disk_event_wireless"

  • "disk_event_wad"

  • "disk_event_endpoint"

  • "disk_event_ha"

  • "disk_event_compliance-check"

  • "disk_event_system"

  • "disk_event_connector"

  • "disk_event_security-rating"

  • "disk_event_fortiextender"

  • "disk_traffic_forward"

  • "disk_traffic_local"

  • "disk_traffic_multicast"

  • "disk_traffic_sniffer"

  • "disk_traffic_fortiview"

  • "disk_traffic_threat"

  • "memory_event_vpn"

  • "memory_event_user"

  • "memory_event_router"

  • "memory_event_wireless"

  • "memory_event_wad"

  • "memory_event_endpoint"

  • "memory_event_ha"

  • "memory_event_compliance-check"

  • "memory_event_system"

  • "memory_event_connector"

  • "memory_event_security-rating"

  • "memory_event_fortiextender"

  • "memory_traffic_forward"

  • "memory_traffic_local"

  • "memory_traffic_multicast"

  • "memory_traffic_sniffer"

  • "memory_traffic_fortiview"

  • "memory_traffic_threat"

  • "fortianalyzer_event_vpn"

  • "fortianalyzer_event_user"

  • "fortianalyzer_event_router"

  • "fortianalyzer_event_wireless"

  • "fortianalyzer_event_wad"

  • "fortianalyzer_event_endpoint"

  • "fortianalyzer_event_ha"

  • "fortianalyzer_event_compliance-check"

  • "fortianalyzer_event_system"

  • "fortianalyzer_event_connector"

  • "fortianalyzer_event_security-rating"

  • "fortianalyzer_event_fortiextender"

  • "fortianalyzer_traffic_forward"

  • "fortianalyzer_traffic_local"

  • "fortianalyzer_traffic_multicast"

  • "fortianalyzer_traffic_sniffer"

  • "fortianalyzer_traffic_fortiview"

  • "fortianalyzer_traffic_threat"

  • "forticloud_event_vpn"

  • "forticloud_event_user"

  • "forticloud_event_router"

  • "forticloud_event_wireless"

  • "forticloud_event_wad"

  • "forticloud_event_endpoint"

  • "forticloud_event_ha"

  • "forticloud_event_compliance-check"

  • "forticloud_event_system"

  • "forticloud_event_connector"

  • "forticloud_event_security-rating"

  • "forticloud_event_fortiextender"

  • "forticloud_traffic_forward"

  • "forticloud_traffic_local"

  • "forticloud_traffic_multicast"

  • "forticloud_traffic_sniffer"

  • "forticloud_traffic_fortiview"

  • "forticloud_traffic_threat"

selectors

列表 / 元素=字典

用于检索日志类型的选择器列表。

filters

列表 / 元素=字符串

用于筛选返回结果的表达式列表。

列表项使用与运算符进行逻辑与组合。

一个项本身可以使用逗号进行逻辑或连接。

formatters

列表 / 元素=字符串

用于显示返回结果的字段列表。

params

字典

每个选择器的参数，请参见上述列表中的定义。

selector

字符串 / 必填

检索的日志类型的选择器

选项

  • "disk_virus_archive"

  • "memory_virus_archive"

  • "fortianalyzer_virus_archive"

  • "forticloud_virus_archive"

  • "disk_ips_archive"

  • "disk_app-ctrl_archive"

  • "memory_ips_archive"

  • "memory_app-ctrl_archive"

  • "fortianalyzer_ips_archive"

  • "fortianalyzer_app-ctrl_archive"

  • "forticloud_ips_archive"

  • "forticloud_app-ctrl_archive"

  • "disk_ips_archive-download"

  • "disk_app-ctrl_archive-download"

  • "memory_ips_archive-download"

  • "memory_app-ctrl_archive-download"

  • "fortianalyzer_ips_archive-download"

  • "fortianalyzer_app-ctrl_archive-download"

  • "forticloud_ips_archive-download"

  • "forticloud_app-ctrl_archive-download"

  • "disk_virus_raw"

  • "disk_webfilter_raw"

  • "disk_waf_raw"

  • "disk_ips_raw"

  • "disk_anomaly_raw"

  • "disk_app-ctrl_raw"

  • "disk_cifs_raw"

  • "disk_emailfilter_raw"

  • "disk_dlp_raw"

  • "disk_voip_raw"

  • "disk_gtp_raw"

  • "disk_dns_raw"

  • "disk_ssh_raw"

  • "disk_ssl_raw"

  • "disk_file-filter_raw"

  • "memory_virus_raw"

  • "memory_webfilter_raw"

  • "memory_waf_raw"

  • "memory_ips_raw"

  • "memory_anomaly_raw"

  • "memory_app-ctrl_raw"

  • "memory_cifs_raw"

  • "memory_emailfilter_raw"

  • "memory_dlp_raw"

  • "memory_voip_raw"

  • "memory_gtp_raw"

  • "memory_dns_raw"

  • "memory_ssh_raw"

  • "memory_ssl_raw"

  • "memory_file-filter_raw"

  • "fortianalyzer_virus_raw"

  • "fortianalyzer_webfilter_raw"

  • "fortianalyzer_waf_raw"

  • "fortianalyzer_ips_raw"

  • "fortianalyzer_anomaly_raw"

  • "fortianalyzer_app-ctrl_raw"

  • "fortianalyzer_cifs_raw"

  • "fortianalyzer_emailfilter_raw"

  • "fortianalyzer_dlp_raw"

  • "fortianalyzer_voip_raw"

  • "fortianalyzer_gtp_raw"

  • "fortianalyzer_dns_raw"

  • "fortianalyzer_ssh_raw"

  • "fortianalyzer_ssl_raw"

  • "fortianalyzer_file-filter_raw"

  • "forticloud_virus_raw"

  • "forticloud_webfilter_raw"

  • "forticloud_waf_raw"

  • "forticloud_ips_raw"

  • "forticloud_anomaly_raw"

  • "forticloud_app-ctrl_raw"

  • "forticloud_cifs_raw"

  • "forticloud_emailfilter_raw"

  • "forticloud_dlp_raw"

  • "forticloud_voip_raw"

  • "forticloud_gtp_raw"

  • "forticloud_dns_raw"

  • "forticloud_ssh_raw"

  • "forticloud_ssl_raw"

  • "forticloud_file-filter_raw"

  • "disk_event_vpn"

  • "disk_event_user"

  • "disk_event_router"

  • "disk_event_wireless"

  • "disk_event_wad"

  • "disk_event_endpoint"

  • "disk_event_ha"

  • "disk_event_compliance-check"

  • "disk_event_system"

  • "disk_event_connector"

  • "disk_event_security-rating"

  • "disk_event_fortiextender"

  • "disk_traffic_forward"

  • "disk_traffic_local"

  • "disk_traffic_multicast"

  • "disk_traffic_sniffer"

  • "disk_traffic_fortiview"

  • "disk_traffic_threat"

  • "memory_event_vpn"

  • "memory_event_user"

  • "memory_event_router"

  • "memory_event_wireless"

  • "memory_event_wad"

  • "memory_event_endpoint"

  • "memory_event_ha"

  • "memory_event_compliance-check"

  • "memory_event_system"

  • "memory_event_connector"

  • "memory_event_security-rating"

  • "memory_event_fortiextender"

  • "memory_traffic_forward"

  • "memory_traffic_local"

  • "memory_traffic_multicast"

  • "memory_traffic_sniffer"

  • "memory_traffic_fortiview"

  • "memory_traffic_threat"

  • "fortianalyzer_event_vpn"

  • "fortianalyzer_event_user"

  • "fortianalyzer_event_router"

  • "fortianalyzer_event_wireless"

  • "fortianalyzer_event_wad"

  • "fortianalyzer_event_endpoint"

  • "fortianalyzer_event_ha"

  • "fortianalyzer_event_compliance-check"

  • "fortianalyzer_event_system"

  • "fortianalyzer_event_connector"

  • "fortianalyzer_event_security-rating"

  • "fortianalyzer_event_fortiextender"

  • "fortianalyzer_traffic_forward"

  • "fortianalyzer_traffic_local"

  • "fortianalyzer_traffic_multicast"

  • "fortianalyzer_traffic_sniffer"

  • "fortianalyzer_traffic_fortiview"

  • "fortianalyzer_traffic_threat"

  • "forticloud_event_vpn"

  • "forticloud_event_user"

  • "forticloud_event_router"

  • "forticloud_event_wireless"

  • "forticloud_event_wad"

  • "forticloud_event_endpoint"

  • "forticloud_event_ha"

  • "forticloud_event_compliance-check"

  • "forticloud_event_system"

  • "forticloud_event_connector"

  • "forticloud_event_security-rating"

  • "forticloud_event_fortiextender"

  • "forticloud_traffic_forward"

  • "forticloud_traffic_local"

  • "forticloud_traffic_multicast"

  • "forticloud_traffic_sniffer"

  • "forticloud_traffic_fortiview"

  • "forticloud_traffic_threat"

排序器

列表 / 元素=字符串

用于对返回结果进行排序的表达式列表。

列表项按升序排列，运算符为 & 符号。

一个列表项本身可以使用逗号分隔，表示降序。

排序器

列表 / 元素=字符串

用于对返回结果进行排序的表达式列表。

列表项按升序排列，运算符为 & 符号。

一个列表项本身可以使用逗号分隔，表示降序。

vdom

字符串

虚拟域，在之前定义的虚拟域中选择。vdom 是 FortiGate 的一个虚拟实例，可以配置并用作不同的单元。

默认值: "root"

注意

注意

  • 不同的选择器可能有不同的参数，用户应该查找特定选择器的参数。

  • 对于某些选择器，对象是全局的，不允许出现参数。

  • 并非所有参数都是选择器必需的。

  • 此模块专门用于 FortiOS 日志 API。

示例

- name: get disk event user and memory event user at once.
  fortinet.fortios.fortios_log_fact:
      access_token: "you_own_value"
      selectors:
          - selector: disk_event_user
            filters:
                - log_id==41000
          - selector: memory_event_user

返回值

通用返回值记录在此处，以下是此模块特有的字段

键

描述

build

字符串

FortiGate 镜像的构建号

返回: 始终

示例: "1547"

rows

整数

要返回的行数

返回: 始终

示例: 400

serial

字符串

设备的序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

session_id

整数

请求的会话 ID

返回: 始终

示例: 7

start

整数

要返回的第一行的行号

返回: 始终

示例: 0

status

字符串

操作结果的指示

返回: 始终

示例: "success"

subcategory

字符串

可以检索的日志类型

返回: 始终

示例: "system"

total_lines

整数

从结果返回的总行数

返回: 始终

示例: 510

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

version

字符串

FortiGate 的版本

返回: 始终

示例: "v5.6.3"

作者

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@fshen01)