fortios_log_disk_setting – Settings for local disk logging in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_log_disk_setting | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- log_disk_setting - Settings for local disk logging. type: dict more...
- 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 more...
- dlp_archive_quota - DLP archive quota (MB). type: int more...
- full_final_warning_threshold - Log full final warning threshold as a percent (3 - 100). type: int more...
- full_first_warning_threshold - Log full first warning threshold as a percent (1 - 98). type: int more...
- full_second_warning_threshold - Log full second warning threshold as a percent (2 - 99). type: int more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- ips_archive - Enable/disable IPS packet archiving to the local disk. type: str choices: enable, disable more...
- log_quota - Disk log quota (MB). type: int more...
- max_log_file_size - Maximum log file size before rolling (1 - 100 Mbytes). type: int more...
- max_policy_packet_capture_size - Maximum size of policy sniffer in MB (0 means unlimited). type: int more...
- maximum_log_age - Delete log files older than (days). type: int more...
- report_quota - Report db quota (MB). type: int more...
- roll_day - Day of week on which to roll log file. type: list choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday more...
- roll_schedule - Frequency to check log file for rolling. type: str choices: daily, weekly more...
- roll_time - Time of day to roll the log file (hh:mm). type: str more...
- source_ip - Source IP address to use for uploading disk log files. type: str more...
- status - Enable/disable local disk logging. type: str choices: enable, disable more...
- upload - Enable/disable uploading log files when they are rolled. type: str choices: enable, disable more...
- upload_delete_files - Delete log files after uploading . type: str choices: enable, disable more...
- upload_destination - The type of server to upload log files to. Only FTP is currently supported. type: str choices: ftp-server more...
- upload_ssl_conn - Enable/disable encrypted FTPS communication to upload log files. type: str choices: default, high, low, disable more...
- uploaddir - The remote directory on the FTP server to upload log files to. type: str more...
- uploadip - IP address of the FTP server to upload log files to. type: str more...
- uploadpass - Password required to log into the FTP server to upload disk log files. type: str more...
- uploadport - TCP port to use for communicating with the FTP server . type: int more...
- uploadsched - Set the schedule for uploading log files to the FTP server . type: str choices: disable, enable more...
- uploadtime - Time of day at which log files are uploaded if uploadsched is enabled (hh:mm or hh). type: str more...
- uploadtype - Types of log files to upload. Separate multiple entries with a space. type: list choices: traffic, event, virus, webfilter, IPS, emailfilter, dlp-archive, anomaly, voip, dlp, app-ctrl, waf, gtp, dns, ssh, ssl, file-filter, icap, ztna, cifs, spamfilter, netscan more...
- uploaduser - Username required to log into the FTP server to upload disk log files. type: str more...
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: "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>"
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