fortinet.fortios.fortios_log_setting 模块 – 在 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_setting。

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

• ansible>=2.15

参数

参数	注释
access_token 字符串	基于令牌的身份验证。从 Fortigate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ←（默认） true
log_setting 字典	配置常规日志设置。
anonymization_hash 字符串	用户名匿名化哈希盐。
brief_traffic_format 字符串	启用/禁用简短格式的流量日志记录。 选项 “启用” “禁用”
custom_log_fields 列表 / 元素=字典	要附加到所有日志消息的自定义字段。
field_id 字符串 / 必需	自定义日志字段。源 log.custom-field.id。
daemon_log 字符串	启用/禁用守护程序日志记录。 选项 “启用” “禁用”
expolicy_implicit_log 字符串	启用/禁用显式代理防火墙隐式策略日志记录。 选项 “启用” “禁用”
extended_log 字符串	启用/禁用扩展流量日志记录。 选项 “启用” “禁用”
extended_utm_log 字符串	启用/禁用扩展 UTM 日志记录。 选项 “启用” “禁用”
faz_override 字符串	启用/禁用覆盖 FortiAnalyzer 设置。 选项 “启用” “禁用”
fortiview_weekly_data 字符串	启用/禁用 FortiView 每周数据。 选项 “启用” “禁用”
fwpolicy6_implicit_log 字符串	启用/禁用隐式防火墙策略 6 日志记录。 选项 “启用” “禁用”
fwpolicy_implicit_log 字符串	启用/禁用隐式防火墙策略日志记录。 选项 “启用” “禁用”
local_in_allow 字符串	启用/禁用 local-in-allow 日志记录。 选项 “启用” “禁用”
local_in_deny_broadcast 字符串	启用/禁用 local-in-deny-broadcast 日志记录。 选项 “启用” “禁用”
local_in_deny_unicast 字符串	启用/禁用 local-in-deny-unicast 日志记录。 选项 “启用” “禁用”
local_in_policy_log 字符串	启用/禁用 local-in-policy 日志记录。 选项 “启用” “禁用”
local_out 字符串	启用/禁用 local-out 日志记录。 选项 “启用” “禁用”
local_out_ioc_detection 字符串	启用/禁用 local-out 流量 IoC 检测。需要启用 local-out。 选项 “启用” “禁用”
log_invalid_packet 字符串	启用/禁用无效数据包流量日志记录。 选项 “启用” “禁用”
log_policy_comment 字符串	启用/禁用将策略注释插入到流量日志中。 选项 “启用” “禁用”
log_policy_name 字符串	启用/禁用将策略名称插入到流量日志中。 选项 “启用” “禁用”
log_user_in_upper 字符串	启用/禁用带有 user-in-upper 的日志。 选项 “启用” “禁用”
long_live_session_stat 字符串	启用/禁用长寿命会话统计日志记录。 选项 “启用” “禁用”
neighbor_event 字符串	启用/禁用邻居事件日志记录。 选项 “启用” “禁用”
resolve_ip 字符串	启用/禁用在可能的情况下向流量日志添加已解析的域名。 选项 “启用” “禁用”
resolve_port 字符串	启用/禁用将已解析的服务名称添加到流量日志中。 选项 “启用” “禁用”
rest_api_get 字符串	启用/禁用 REST API GET 请求日志记录。 选项 “启用” “禁用”
rest_api_set 字符串	启用/禁用 REST API POST/PUT/DELETE 请求日志记录。 选项 “启用” “禁用”
syslog_override 字符串	启用/禁用覆盖 Syslog 设置。 选项 “启用” “禁用”
user_anonymize 字符串	启用/禁用在日志消息中匿名化用户名。 选项 “启用” “禁用”
member_path 字符串	要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项 “present” “absent”
vdom 字符串	虚拟域，在之前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： "root"

注释

注意

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

示例

- name: Configure general log settings.
  fortinet.fortios.fortios_log_setting:
      vdom: "{{ vdom }}"
      log_setting:
          anonymization_hash: "<your_own_value>"
          brief_traffic_format: "enable"
          custom_log_fields:
              -
                  field_id: "<your_own_value> (source log.custom-field.id)"
          daemon_log: "enable"
          expolicy_implicit_log: "enable"
          extended_log: "enable"
          extended_utm_log: "enable"
          faz_override: "enable"
          fortiview_weekly_data: "enable"
          fwpolicy_implicit_log: "enable"
          fwpolicy6_implicit_log: "enable"
          local_in_allow: "enable"
          local_in_deny_broadcast: "enable"
          local_in_deny_unicast: "enable"
          local_in_policy_log: "enable"
          local_out: "enable"
          local_out_ioc_detection: "enable"
          log_invalid_packet: "enable"
          log_policy_comment: "enable"
          log_policy_name: "enable"
          log_user_in_upper: "enable"
          long_live_session_stat: "enable"
          neighbor_event: "enable"
          resolve_ip: "enable"
          resolve_port: "enable"
          rest_api_get: "enable"
          rest_api_set: "enable"
          syslog_override: "enable"
          user_anonymize: "enable"

返回值

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

键	描述
build 字符串	FortiGate 映像的构建号 已返回： 始终 示例： "1547"
http_method 字符串	上次用于将内容配置到 FortiGate 中的方法 已返回： 始终 示例： "PUT"
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果 已返回： 始终 示例: "200"
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (id) 返回: success 示例: "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)

集合链接

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