fortinet.fortimanager.fmgr_system_locallog_disk_setting – Settings for local disk logging.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_locallog_disk_setting.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_locallog_disk_setting

dictionary

the top level parameters set

diskfull

string

Policy to apply when disk is full.

overwrite - Overwrite oldest log when disk is full.

nolog - Stop logging when disk is full.

Choices:

  • overwrite ← (default)

  • nolog

log-disk-full-percentage

integer

Consider log disk as full at this usage percentage.

Default: 80

max-log-file-size

integer

Maximum log file size before rolling.

Default: 100

roll-day

list / elements=string

Days of week to roll logs.

Choices:

  • sunday

  • monday

  • tuesday

  • wednesday

  • thursday

  • friday

  • saturday

roll-schedule

string

Frequency to check log file for rolling.

none - Not scheduled.

daily - Every day.

weekly - Every week.

Choices:

  • none ← (default)

  • daily

  • weekly

roll-time

string

Time to roll logs (hh:mm).

server-type

string

Server type.

FTP - Upload via FTP.

SFTP - Upload via SFTP.

SCP - Upload via SCP.

Choices:

  • FTP ← (default)

  • SFTP

  • SCP

severity

string

Least severity level to log.

emergency - Emergency level.

alert - Alert level.

critical - Critical level.

error - Error level.

warning - Warning level.

notification - Notification level.

information - Information level.

debug - Debug level.

Choices:

  • emergency

  • alert

  • critical

  • error

  • warning

  • notification

  • information ← (default)

  • debug

status

string

Enable/disable local disk log.

disable - Do not log to local disk.

enable - Log to local disk.

Choices:

  • disable

  • enable ← (default)

upload

string

Upload log file when rolling.

disable - Disable uploading when rolling log file.

enable - Enable uploading when rolling log file.

Choices:

  • disable ← (default)

  • enable

upload-delete-files

string

Delete log files after uploading (default = enable).

disable - Do not delete log files after uploading.

enable - Delete log files after uploading.

Choices:

  • disable

  • enable ← (default)

upload-time

string

Time to upload logs (hh:mm).

uploaddir

string

Log file upload remote directory.

uploadip

string

IP address of log uploading server.

Default: “0.0.0.0”

uploadpass

string

Password of user account in upload server.

uploadport

integer

Server port (0 = default protocol port).

Default: 0

uploadsched

string

Scheduled upload (disable = upload when rolling).

disable - Upload when rolling.

enable - Scheduled upload.

Choices:

  • disable ← (default)

  • enable

uploadtype

list / elements=string

Types of log files that need to be uploaded.

Choices:

  • event

uploaduser

string

User account in upload server.

uploadzip

string

Compress upload logs.

disable - Upload log files as plain text.

enable - Upload log files compressed.

Choices:

  • disable ← (default)

  • enable

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Settings for local disk logging.
     fmgr_system_locallog_disk_setting:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        system_locallog_disk_setting:
           diskfull: <value in [overwrite, nolog]>
           log-disk-full-percentage: <value of integer>
           max-log-file-size: <value of integer>
           roll-day:
             - sunday
             - monday
             - tuesday
             - wednesday
             - thursday
             - friday
             - saturday
           roll-schedule: <value in [none, daily, weekly]>
           roll-time: <value of string>
           server-type: <value in [FTP, SFTP, SCP]>
           severity: <value in [emergency, alert, critical, ...]>
           status: <value in [disable, enable]>
           upload: <value in [disable, enable]>
           upload-delete-files: <value in [disable, enable]>
           upload-time: <value of string>
           uploaddir: <value of string>
           uploadip: <value of string>
           uploadpass: <value of string>
           uploadport: <value of integer>
           uploadsched: <value in [disable, enable]>
           uploadtype:
             - event
           uploaduser: <value of string>
           uploadzip: <value in [disable, enable]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)