fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer module – Log rolling policy for Network Analyzer logs.

Note

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

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

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_log_settings_rollinganalyzer

dictionary

the top level parameters set

days

list / elements=string

Log files rolling schedule (days of week).

Choices:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

del-files

string

Enable/disable log file deletion after uploading.

disable - Disable log file deletion.

enable - Enable log file deletion.

Choices:

  • disable ← (default)

  • enable

directory

string

Upload server directory, for Unix server, use absolute

file-size

integer

Roll log files when they reach this size (MB).

Default: 200

gzip-format

string

Enable/disable compression of uploaded log files.

disable - Disable compression.

enable - Enable compression.

Choices:

  • disable ← (default)

  • enable

hour

integer

Log files rolling schedule (hour).

Default: 0

ip

string

Upload server IP address.

Default: “0.0.0.0”

ip2

string

Upload server IP2 address.

Default: “0.0.0.0”

ip3

string

Upload server IP3 address.

Default: “0.0.0.0”

log-format

string

Format of uploaded log files.

native - Native format (text or compact).

text - Text format (convert if necessary).

csv - CSV (comma-separated value) format.

Choices:

  • native ← (default)

  • text

  • csv

min

integer

Log files rolling schedule (minutes).

Default: 0

password

string

Upload server login password.

password2

string

Upload server login password2.

password3

string

Upload server login password3.

port

integer

Upload server IP1 port number.

Default: 0

port2

integer

Upload server IP2 port number.

Default: 0

port3

integer

Upload server IP3 port number.

Default: 0

server-type

string

Upload server type.

ftp - Upload via FTP.

sftp - Upload via SFTP.

scp - Upload via SCP.

Choices:

  • ftp ← (default)

  • sftp

  • scp

upload

string

Enable/disable log file uploads.

disable - Disable log files uploading.

enable - Enable log files uploading.

Choices:

  • disable ← (default)

  • enable

upload-hour

integer

Log files upload schedule (hour).

Default: 0

upload-mode

string

Upload mode with multiple servers.

backup - Servers are attempted and used one after the other upon failure to connect.

mirror - All configured servers are attempted and used.

Choices:

  • backup ← (default)

  • mirror

upload-trigger

string

Event triggering log files upload.

on-roll - Upload log files after they are rolled.

on-schedule - Upload log files daily.

Choices:

  • on-roll ← (default)

  • on-schedule

username

string

Upload server login username.

username2

string

Upload server login username2.

username3

string

Upload server login username3.

when

string

Roll log files periodically.

none - Do not roll log files periodically.

daily - Roll log files daily.

weekly - Roll log files on certain days of week.

Choices:

  • none ← (default)

  • daily

  • weekly

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: Log rolling policy for Network Analyzer logs.
     fmgr_system_log_settings_rollinganalyzer:
        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_log_settings_rollinganalyzer:
           days:
             - sun
             - mon
             - tue
             - wed
             - thu
             - fri
             - sat
           del-files: <value in [disable, enable]>
           directory: <value of string>
           file-size: <value of integer>
           gzip-format: <value in [disable, enable]>
           hour: <value of integer>
           ip: <value of string>
           ip2: <value of string>
           ip3: <value of string>
           log-format: <value in [native, text, csv]>
           min: <value of integer>
           password: <value of string>
           password2: <value of string>
           password3: <value of string>
           server-type: <value in [ftp, sftp, scp]>
           upload: <value in [disable, enable]>
           upload-hour: <value of integer>
           upload-mode: <value in [backup, mirror]>
           upload-trigger: <value in [on-roll, on-schedule]>
           username: <value of string>
           username2: <value of string>
           username3: <value of string>
           when: <value in [none, daily, weekly]>
           port: <value of integer>
           port2: <value of integer>
           port3: <value of integer>

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)