fortios_log_disk_setting – Settings for local disk logging in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
Synopsis¶
- This 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
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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 default: root
- log_disk_setting - Settings for local disk logging. type: dict
- diskfull - 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 choices: overwrite, nolog
- dlp_archive_quota - DLP archive quota (MB). type: int
- full_final_warning_threshold - Log full final warning threshold as a percent (3 - 100). type: int
- full_first_warning_threshold - Log full first warning threshold as a percent (1 - 98). type: int
- full_second_warning_threshold - Log full second warning threshold as a percent (2 - 99). type: int
- ips_archive - Enable/disable IPS packet archiving to the local disk. type: str choices: enable, disable
- log_quota - Disk log quota (MB). type: int
- max_log_file_size - Maximum log file size before rolling (1 - 100 Mbytes). type: int
- max_policy_packet_capture_size - Maximum size of policy sniffer in MB (0 means unlimited). type: int
- maximum_log_age - Delete log files older than (days). type: int
- report_quota - Report quota (MB). type: int
- roll_day - Day of week on which to roll log file. type: str choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday
- roll_schedule - Frequency to check log file for rolling. type: str choices: daily, weekly
- roll_time - Time of day to roll the log file (hh:mm). type: str
- source_ip - Source IP address to use for uploading disk log files. type: str
- status - Enable/disable local disk logging. type: str choices: enable, disable
- upload - Enable/disable uploading log files when they are rolled. type: str choices: enable, disable
- upload_delete_files - Delete log files after uploading . type: str choices: enable, disable
- upload_destination - The type of server to upload log files to. Only FTP is currently supported. type: str choices: ftp-server
- upload_ssl_conn - Enable/disable encrypted FTPS communication to upload log files. type: str choices: default, high, low, disable
- uploaddir - The remote directory on the FTP server to upload log files to. type: str
- uploadip - IP address of the FTP server to upload log files to. type: str
- uploadpass - Password required to log into the FTP server to upload disk log files. type: str
- uploadport - TCP port to use for communicating with the FTP server . type: int
- uploadsched - Set the schedule for uploading log files to the FTP server . type: str choices: disable, enable
- uploadtime - Time of day at which log files are uploaded if uploadsched is enabled (hh:mm or hh). type: str
- uploadtype - Types of log files to upload. Separate multiple entries with a space. type: str choices: traffic, event, virus, webfilter, IPS, spamfilter, dlp-archive, anomaly, voip, dlp, app-ctrl, waf, netscan, gtp, dns
- uploaduser - Username required to log into the FTP server to upload disk log files. type: str
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Settings for local disk logging.
fortios_log_disk_setting:
vdom: "{{ vdom }}"
log_disk_setting:
diskfull: "overwrite"
dlp_archive_quota: "4"
full_final_warning_threshold: "5"
full_first_warning_threshold: "6"
full_second_warning_threshold: "7"
ips_archive: "enable"
log_quota: "9"
max_log_file_size: "10"
max_policy_packet_capture_size: "11"
maximum_log_age: "12"
report_quota: "13"
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: "26"
uploadsched: "disable"
uploadtime: "<your_own_value>"
uploadtype: "traffic"
uploaduser: "<your_own_value>"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3