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 字符串	指定到达服务器的出站接口。源系统接口名称。
interface_select_method 字符串	指定如何选择到达服务器的出站接口。 选项 "auto" "sdwan" "specify"
ips_archive 字符串	启用/禁用将 IPS 数据包存档到本地磁盘。 选项 "enable" "disable"
log_quota 整数	磁盘日志配额 (MB)。
max_log_file_size 整数	滚动前最大日志文件大小（1-100 MB）。
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" 虚拟补丁 零信任网络访问 (ZTNA) 通用互联网文件系统 (CIFS) 垃圾邮件过滤器 网络扫描
上传用户 字符串	登录FTP服务器上传磁盘日志文件所需的用户名。
成员路径 字符串	要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有member_path的参数对于执行成员操作是合法的。
成员状态 字符串	在指定的属性路径下添加或删除成员。 当指定member_state时，状态选项将被忽略。 选项 存在 不存在
虚拟域 (vdom) 字符串	先前定义的虚拟域之一。vdom是FortiGate的虚拟实例，可以将其配置并用作不同的单元。 默认值： "root"

注释

注意

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

示例

- 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>"

返回值

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

键	描述
版本号 字符串	FortiGate镜像的版本号 返回值：始终返回 示例： "1547"
HTTP方法 字符串	上次用于将内容配置到FortiGate的方法 返回值：始终返回 示例： "PUT"
HTTP状态 字符串	FortiGate在上次应用的操作中给出的最后结果 返回值：始终返回 示例： "200"
主密钥 字符串	上次调用FortiGate时使用的主密钥（ID） 返回值：成功 示例： "id"
名称 字符串	用于完成请求的表的名称 返回值：始终返回 示例： "urlfilter"
路径 字符串	用于完成请求的表的路径 返回值：始终返回 示例： "webfilter"
修订版 字符串	内部修订号 返回值：始终返回 示例： "17.0.2.10658"
序列号 字符串	设备的序列号 返回值：始终返回 示例： "FGVMEVYYQT3AB5352"
status 字符串	操作结果指示 返回值：始终返回 示例： "success"
虚拟域 (vdom) 字符串	使用的虚拟域 返回值：始终返回 示例： "root"
版本 字符串	FortiGate的版本 返回值：始终返回 示例： "v5.6.3"

作者

• 郑链 (@chillancezen)

• 薛杰 (@JieX19)

• 卢洪斌 (@fgtdev-hblu)

• 沈峰 (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

资源链接

• 问题跟踪器
• 主页
• 代码仓库