fortinet.fortios.fortios_log_disk_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_disk_setting。

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_setting 字典	本地磁盘日志的设置。
diskfull 字符串	磁盘已满时采取的操作。当磁盘已满时，系统可以覆盖最旧的日志消息或停止日志记录。 选项 "overwrite" "nolog"
dlp_archive_quota 整数	DLP 存档配额 (MB)。
full_final_warning_threshold 整数	日志已满最终警告阈值，以百分比表示 (3 - 100)。
full_first_warning_threshold 整数	日志已满第一个警告阈值，以百分比表示 (1 - 98)。
full_second_warning_threshold 整数	日志已满第二个警告阈值，以百分比表示 (2 - 99)。
interface 字符串	指定用于访问服务器的传出接口。源 system.interface.name。
interface_select_method 字符串	指定如何选择用于访问服务器的传出接口。 选项 "auto" "sdwan" "specify"
ips_archive 字符串	启用/禁用将 IPS 数据包存档到本地磁盘。 选项 "enable" "disable"
log_quota 整数	磁盘日志配额 (MB)。
max_log_file_size 整数	滚动之前的最大日志文件大小 (1 - 100 Mbytes)。
max_policy_packet_capture_size 整数	策略嗅探器的最大大小（MB），0 表示无限制。
maximum_log_age 整数	删除早于（天）的日志文件。
report_quota 整数	报告数据库配额 (MB)。
roll_day 列表 / 元素=字符串	滚动日志文件的星期几。 选项 "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
roll_schedule 字符串	检查日志文件是否滚动的频率。 选项 "daily" "weekly"
roll_time 字符串	滚动日志文件的时间（hh:mm）。
source_ip 字符串	用于上传磁盘日志文件的源 IP 地址。
status 字符串	启用/禁用本地磁盘日志记录。 选项 "enable" "disable"
upload 字符串	启用/禁用在滚动日志文件时上传它们。 选项 "enable" "disable"
upload_delete_files 字符串	上传后删除日志文件。 选项 "enable" "disable"
upload_destination 字符串	上传日志文件的服务器类型。目前仅支持 FTP。 选项 "ftp-server"
upload_ssl_conn 字符串	启用/禁用加密的 FTPS 通信以上传日志文件。 选项 "default" "high" "low" "disable"
uploaddir 字符串	FTP 服务器上用于上传日志文件的远程目录。
uploadip 字符串	用于上传日志文件的 FTP 服务器的 IP 地址。
uploadpass 字符串	登录 FTP 服务器以上传磁盘日志文件所需的密码。
uploadport 整数	用于与 FTP 服务器通信的 TCP 端口。
uploadsched 字符串	设置将日志文件上传到 FTP 服务器的计划。 选项 "disable" "enable"
uploadtime 字符串	如果启用了 uploadsched，则上传日志文件的时间（hh:mm 或 hh）。
uploadtype 列表 / 元素=字符串	要上传的日志文件类型。用空格分隔多个条目。 选项 "traffic" "event" "virus" "webfilter" "IPS" "emailfilter" "dlp-archive" "anomaly" "voip" "dlp" "app-ctrl" "waf" "gtp" "dns" "ssh" "ssl" "file-filter" "icap" "virtual-patch" "ztna" "cifs" "spamfilter" "netscan"
uploaduser 字符串	登录 FTP 服务器以上传磁盘日志文件所需的用户名。
member_path 字符串	要操作的成员属性路径。 如果存在多个属性，则用斜杠字符分隔。 标记有 member_path 的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项 "present" "absent"
vdom 字符串	虚拟域，在之前定义的域中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。 默认值： "root"

说明

注意

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

示例

- name: Settings for local disk logging.
  fortinet.fortios.fortios_log_disk_setting:
      vdom: "{{ vdom }}"
      log_disk_setting:
          diskfull: "overwrite"
          dlp_archive_quota: "0"
          full_final_warning_threshold: "95"
          full_first_warning_threshold: "75"
          full_second_warning_threshold: "90"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ips_archive: "enable"
          log_quota: "0"
          max_log_file_size: "20"
          max_policy_packet_capture_size: "100"
          maximum_log_age: "7"
          report_quota: "0"
          roll_day: "sunday"
          roll_schedule: "daily"
          roll_time: "<your_own_value>"
          source_ip: "84.230.14.43"
          status: "enable"
          upload: "enable"
          upload_delete_files: "enable"
          upload_destination: "ftp-server"
          upload_ssl_conn: "default"
          uploaddir: "<your_own_value>"
          uploadip: "<your_own_value>"
          uploadpass: "<your_own_value>"
          uploadport: "21"
          uploadsched: "disable"
          uploadtime: "<your_own_value>"
          uploadtype: "traffic"
          uploaduser: "<your_own_value>"

返回值

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

键	描述
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)

集合链接

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