Try SpotterSettings for local disk logging in Fortinet's FortiOS and FortiGate.
| "added in version" 2.0.0 of fortinet.fortios"
Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortios:==2.3.6
collections:
- name: fortinet.fortios
version: 2.3.6This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_disk feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
- 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>"
vdom:
default: root
description:
- Virtual domain, among those defined previously. A vdom is a virtual instance of
the FortiGate that can be configured and used as a different unit.
type: str
enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool
member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str
access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str
member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str
log_disk_setting:
default: null
description:
- Settings for local disk logging.
suboptions:
diskfull:
choices:
- overwrite
- nolog
description:
- Action to take when disk is full. The system can overwrite the oldest log messages
or stop logging when the disk is full .
type: str
dlp_archive_quota:
description:
- DLP archive quota (MB).
type: int
full_final_warning_threshold:
description:
- Log full final warning threshold as a percent (3 - 100).
type: int
full_first_warning_threshold:
description:
- Log full first warning threshold as a percent (1 - 98).
type: int
full_second_warning_threshold:
description:
- Log full second warning threshold as a percent (2 - 99).
type: int
interface:
description:
- Specify outgoing interface to reach server. Source system.interface.name.
type: str
interface_select_method:
choices:
- auto
- sdwan
- specify
description:
- Specify how to select outgoing interface to reach server.
type: str
ips_archive:
choices:
- enable
- disable
description:
- Enable/disable IPS packet archiving to the local disk.
type: str
log_quota:
description:
- Disk log quota (MB).
type: int
max_log_file_size:
description:
- Maximum log file size before rolling (1 - 100 Mbytes).
type: int
max_policy_packet_capture_size:
description:
- Maximum size of policy sniffer in MB (0 means unlimited).
type: int
maximum_log_age:
description:
- Delete log files older than (days).
type: int
report_quota:
description:
- Report db quota (MB).
type: int
roll_day:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description:
- Day of week on which to roll log file.
elements: str
type: list
roll_schedule:
choices:
- daily
- weekly
description:
- Frequency to check log file for rolling.
type: str
roll_time:
description:
- Time of day to roll the log file (hh:mm).
type: str
source_ip:
description:
- Source IP address to use for uploading disk log files.
type: str
status:
choices:
- enable
- disable
description:
- Enable/disable local disk logging.
type: str
upload:
choices:
- enable
- disable
description:
- Enable/disable uploading log files when they are rolled.
type: str
upload_delete_files:
choices:
- enable
- disable
description:
- Delete log files after uploading .
type: str
upload_destination:
choices:
- ftp-server
description:
- The type of server to upload log files to. Only FTP is currently supported.
type: str
upload_ssl_conn:
choices:
- default
- high
- low
- disable
description:
- Enable/disable encrypted FTPS communication to upload log files.
type: str
uploaddir:
description:
- The remote directory on the FTP server to upload log files to.
type: str
uploadip:
description:
- IP address of the FTP server to upload log files to.
type: str
uploadpass:
description:
- Password required to log into the FTP server to upload disk log files.
type: str
uploadport:
description:
- TCP port to use for communicating with the FTP server .
type: int
uploadsched:
choices:
- disable
- enable
description:
- Set the schedule for uploading log files to the FTP server .
type: str
uploadtime:
description:
- Time of day at which log files are uploaded if uploadsched is enabled (hh:mm
or hh).
type: str
uploadtype:
choices:
- 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
description:
- Types of log files to upload. Separate multiple entries with a space.
elements: str
type: list
uploaduser:
description:
- Username required to log into the FTP server to upload disk log files.
type: str
type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str