fortinet.fortios.fortios_log_disk_setting module – Settings for local disk logging in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.1.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_log_disk_setting.
New in version 2.0.0: of fortinet.fortios
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
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Settings for local disk logging. |
|
Action to take when disk is full. The system can overwrite the oldest log messages or stop logging when the disk is full . Choices:
|
|
DLP archive quota (MB). |
|
Log full final warning threshold as a percent (3 - 100). |
|
Log full first warning threshold as a percent (1 - 98). |
|
Log full second warning threshold as a percent (2 - 99). |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Enable/disable IPS packet archiving to the local disk. Choices:
|
|
Disk log quota (MB). |
|
Maximum log file size before rolling (1 - 100 Mbytes). |
|
Maximum size of policy sniffer in MB (0 means unlimited). |
|
Delete log files older than (days). |
|
Report db quota (MB). |
|
Day of week on which to roll log file. Choices:
|
|
Frequency to check log file for rolling. Choices:
|
|
Time of day to roll the log file (hh:mm). |
|
Source IP address to use for uploading disk log files. |
|
Enable/disable local disk logging. Choices:
|
|
Enable/disable uploading log files when they are rolled. Choices:
|
|
Delete log files after uploading . Choices:
|
|
The type of server to upload log files to. Only FTP is currently supported. Choices:
|
|
Enable/disable encrypted FTPS communication to upload log files. Choices:
|
|
The remote directory on the FTP server to upload log files to. |
|
IP address of the FTP server to upload log files to. |
|
Password required to log into the FTP server to upload disk log files. |
|
TCP port to use for communicating with the FTP server . |
|
Set the schedule for uploading log files to the FTP server . Choices:
|
|
Time of day at which log files are uploaded if uploadsched is enabled (hh:mm or hh). |
|
Types of log files to upload. Separate multiple entries with a space. Choices:
|
|
Username required to log into the FTP server to upload disk log files. |
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: “root” |
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"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
log_quota: "11"
max_log_file_size: "12"
max_policy_packet_capture_size: "13"
maximum_log_age: "14"
report_quota: "15"
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: "28"
uploadsched: "disable"
uploadtime: "<your_own_value>"
uploadtype: "traffic"
uploaduser: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: “1547” |
|
Last method used to provision the content into FortiGate Returned: always Sample: “PUT” |
|
Last result given by FortiGate on last operation applied Returned: always Sample: “200” |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: “id” |
|
Name of the table used to fulfill the request Returned: always Sample: “urlfilter” |
|
Path of the table used to fulfill the request Returned: always Sample: “webfilter” |
|
Internal revision number Returned: always Sample: “17.0.2.10658” |
|
Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352” |
|
Indication of the operation’s result Returned: always Sample: “success” |
|
Virtual domain used Returned: always Sample: “root” |
|
Version of the FortiGate Returned: always Sample: “v5.6.3” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)