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.2.1).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_log_disk_setting.

New in fortinet.fortios 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

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

log_disk_setting

dictionary

Settings for local disk logging.

diskfull

string

Action to take when disk is full. The system can overwrite the oldest log messages or stop logging when the disk is full .

Choices:

  • "overwrite"

  • "nolog"

dlp_archive_quota

integer

DLP archive quota (MB).

full_final_warning_threshold

integer

Log full final warning threshold as a percent (3 - 100).

full_first_warning_threshold

integer

Log full first warning threshold as a percent (1 - 98).

full_second_warning_threshold

integer

Log full second warning threshold as a percent (2 - 99).

interface

string

Specify outgoing interface to reach server. Source system.interface.name.

interface_select_method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

ips_archive

string

Enable/disable IPS packet archiving to the local disk.

Choices:

  • "enable"

  • "disable"

log_quota

integer

Disk log quota (MB).

max_log_file_size

integer

Maximum log file size before rolling (1 - 100 Mbytes).

max_policy_packet_capture_size

integer

Maximum size of policy sniffer in MB (0 means unlimited).

maximum_log_age

integer

Delete log files older than (days).

report_quota

integer

Report db quota (MB).

roll_day

list / elements=string

Day of week on which to roll log file.

Choices:

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

roll_schedule

string

Frequency to check log file for rolling.

Choices:

  • "daily"

  • "weekly"

roll_time

string

Time of day to roll the log file (hh:mm).

source_ip

string

Source IP address to use for uploading disk log files.

status

string

Enable/disable local disk logging.

Choices:

  • "enable"

  • "disable"

upload

string

Enable/disable uploading log files when they are rolled.

Choices:

  • "enable"

  • "disable"

upload_delete_files

string

Delete log files after uploading .

Choices:

  • "enable"

  • "disable"

upload_destination

string

The type of server to upload log files to. Only FTP is currently supported.

Choices:

  • "ftp-server"

upload_ssl_conn

string

Enable/disable encrypted FTPS communication to upload log files.

Choices:

  • "default"

  • "high"

  • "low"

  • "disable"

uploaddir

string

The remote directory on the FTP server to upload log files to.

uploadip

string

IP address of the FTP server to upload log files to.

uploadpass

string

Password required to log into the FTP server to upload disk log files.

uploadport

integer

TCP port to use for communicating with the FTP server .

uploadsched

string

Set the schedule for uploading log files to the FTP server .

Choices:

  • "disable"

  • "enable"

uploadtime

string

Time of day at which log files are uploaded if uploadsched is enabled (hh:mm or hh).

uploadtype

list / elements=string

Types of log files to upload. Separate multiple entries with a space.

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"

uploaduser

string

Username required to log into the FTP server to upload disk log files.

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

vdom

string

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"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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 here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

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)