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

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

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

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

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

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

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

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

rc_succeeded

list / elements=integer

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

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"

  • "nolog"

log-disk-full-percentage

integer

Deprecated, please rename it to log_disk_full_percentage. Consider log disk as full at this usage percentage.

log-disk-quota

integer

Deprecated, please rename it to log_disk_quota. Quota for controlling local log size.

max-log-file-num

integer

Deprecated, please rename it to max_log_file_num. Maximum number of log files before rolling.

max-log-file-size

integer

Deprecated, please rename it to max_log_file_size. Maximum log file size before rolling.

roll-day

list / elements=string

Deprecated, please rename it to roll_day.

Days of week to roll logs.

sunday - Sunday.

monday - Monday.

tuesday - Tuesday.

wednesday - Wednesday.

thursday - Thursday.

friday - Friday.

saturday - Saturday.

Choices:

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

roll-schedule

string

Deprecated, please rename it to roll_schedule.

Frequency to check log file for rolling.

none - Not scheduled.

daily - Every day.

weekly - Every week.

Choices:

  • "none"

  • "daily"

  • "weekly"

roll-time

any

(list or str) Deprecated, please rename it to roll_time. Time to roll logs

server-type

string

Deprecated, please rename it to server_type.

Server type.

FTP - Upload via FTP.

SFTP - Upload via SFTP.

SCP - Upload via SCP.

Choices:

  • "FTP"

  • "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"

  • "debug"

status

string

Enable/disable local disk log.

disable - Do not log to local disk.

enable - Log to local disk.

Choices:

  • "disable"

  • "enable"

upload

string

Upload log file when rolling.

disable - Disable uploading when rolling log file.

enable - Enable uploading when rolling log file.

Choices:

  • "disable"

  • "enable"

upload-delete-files

string

Deprecated, please rename it to upload_delete_files.

Delete log files after uploading

disable - Do not delete log files after uploading.

enable - Delete log files after uploading.

Choices:

  • "disable"

  • "enable"

upload-time

any

(list or str) Deprecated, please rename it to upload_time. Time to upload logs

uploaddir

string

Log file upload remote directory.

uploadip

string

IP address of log uploading server.

uploadpass

any

(list) Password of user account in upload server.

uploadport

integer

Server port

uploadsched

string

Scheduled upload

disable - Upload when rolling.

enable - Scheduled upload.

Choices:

  • "disable"

  • "enable"

uploadtype

list / elements=string

Types of log files that need to be uploaded.

event - Upload event log.

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"

  • "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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Settings for local disk logging.
      fortinet.fortimanager.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: <integer>
          max_log_file_size: <integer>
          roll_day:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
          roll_schedule: <value in [none, daily, weekly]>
          roll_time: <list or 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: <list or string>
          uploaddir: <string>
          uploadip: <string>
          uploadpass: <list or string>
          uploadport: <integer>
          uploadsched: <value in [disable, enable]>
          uploadtype:
            - event
          uploaduser: <string>
          uploadzip: <value in [disable, enable]>
          log_disk_quota: <integer>
          max_log_file_num: <integer>

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

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_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)