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。您需要其他需求才能使用此模块，请参阅 需求 以了解详细信息。
要在 playbook 中使用它，请指定： fortinet.fortios.fortios_log_setting。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改日志功能和设置类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，使用前需要将值调整到数据源。在 FOS v6.0.0 上测试。
需求
以下是执行此模块的主机所需的配置。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 FortiGate 的 GUI 生成。 |
|
启用/禁用任务的日志记录。 选项
|
|
配置通用日志设置。 |
|
用户名匿名化哈希盐。 |
|
启用/禁用简短格式的流量日志记录。 选项
|
|
要附加到所有日志消息的自定义字段。 |
|
自定义日志字段。来源 log.custom-field.id。 |
|
启用/禁用守护进程日志记录。 选项
|
|
启用/禁用显式代理防火墙隐式策略日志记录。 选项
|
|
启用/禁用扩展流量日志记录。 选项
|
|
启用/禁用扩展 UTM 日志记录。 选项
|
|
启用/禁用覆盖 FortiAnalyzer 设置。 选项
|
|
启用/禁用 FortiView 每周数据。 选项
|
|
启用/禁用隐式防火墙策略 6 日志记录。 选项
|
|
启用/禁用隐式防火墙策略日志记录。 选项
|
|
启用/禁用 local-in-allow 日志记录。 选项
|
|
启用/禁用 local-in-deny-broadcast 日志记录。 选项
|
|
启用/禁用 local-in-deny-unicast 日志记录。 选项
|
|
启用/禁用 local-in-policy 日志记录。 选项
|
|
启用/禁用 local-out 日志记录。 选项
|
|
启用/禁用 local-out 流量 IoC 检测。需要启用 local-out。 选项
|
|
启用/禁用无效数据包流量日志记录。 选项
|
|
启用/禁用将策略注释插入流量日志。 选项
|
|
启用/禁用将策略名称插入流量日志。 选项
|
|
启用/禁用带有 user-in-upper 的日志。 选项
|
|
启用/禁用长期会话统计日志记录。 选项
|
|
启用/禁用邻居事件日志记录。 选项
|
|
启用/禁用（如果可能）将解析的域名添加到流量日志。 选项
|
|
启用/禁用将解析的服务名称添加到流量日志。 选项
|
|
启用/禁用 REST API GET 请求日志记录。 选项
|
|
启用/禁用 REST API POST/PUT/DELETE 请求日志记录。 选项
|
|
启用/禁用覆盖 Syslog 设置。 选项
|
|
启用/禁用匿名化日志消息中的用户名。 选项
|
|
要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项
|
|
虚拟域，在先前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认： |
备注
注意
旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式。
示例
- 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"
返回值
常见的返回值已在此处记录 此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
FortiGate 镜像的内部版本号 返回： 始终 示例： |
|
最后用于将内容置备到 FortiGate 的方法 返回： 始终 示例： |
|
FortiGate上次操作的最后结果 返回： 始终 示例： |
|
上次调用FortiGate时使用的主密钥 (ID) 返回： 成功 示例： |
|
用于完成请求的表名 返回： 始终 示例： |
|
用于完成请求的表路径 返回： 始终 示例： |
|
内部版本号 返回： 始终 示例： |
|
设备序列号 返回： 始终 示例： |
|
操作结果指示 返回： 始终 示例： |
|
使用的虚拟域 返回： 始终 示例： |
|
FortiGate版本 返回： 始终 示例： |