fortinet.fortimanager.fmgr_system_log_settings_rollingregular module – Log rolling policy for device logs.

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

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_log_settings_rollingregular

dictionary

The top level parameters set.

days

list / elements=string

Log files rolling schedule

sun - Sunday.

mon - Monday.

tue - Tuesday.

wed - Wednesday.

thu - Thursday.

fri - Friday.

sat - Saturday.

Choices:

  • "sun"

  • "mon"

  • "tue"

  • "wed"

  • "thu"

  • "fri"

  • "sat"

del-files

string

Deprecated, please rename it to del_files.

Enable/disable log file deletion after uploading.

disable - Disable log file deletion.

enable - Enable log file deletion.

Choices:

  • "disable"

  • "enable"

directory

string

Upload server directory, for Unix server, use absolute

file-size

integer

Deprecated, please rename it to file_size. Roll log files when they reach this size

gzip-format

string

Deprecated, please rename it to gzip_format.

Enable/disable compression of uploaded log files.

disable - Disable compression.

enable - Enable compression.

Choices:

  • "disable"

  • "enable"

hour

integer

Log files rolling schedule

ip

string

Upload server IP address.

ip2

string

Upload server IP2 address.

ip3

string

Upload server IP3 address.

log-format

string

Deprecated, please rename it to log_format.

Format of uploaded log files.

native - Native format

text - Text format

csv - CSV

Choices:

  • "native"

  • "text"

  • "csv"

min

integer

Log files rolling schedule

password

any

(list) Upload server login password.

password2

any

(list) Upload server login password2.

password3

any

(list) Upload server login password3.

port

integer

Upload server IP1 port number.

port2

integer

Upload server IP2 port number.

port3

integer

Upload server IP3 port number.

rolling-upgrade-status

integer

Deprecated, please rename it to rolling_upgrade_status. Rolling upgrade status

server

string

Upload server FQDN/IP.

server-type

string

Deprecated, please rename it to server_type.

Upload server type.

ftp - Upload via FTP.

sftp - Upload via SFTP.

scp - Upload via SCP.

Choices:

  • "ftp"

  • "sftp"

  • "scp"

server2

string

Upload server2 FQDN/IP.

server3

string

Upload server3 FQDN/IP.

upload

string

Enable/disable log file uploads.

disable - Disable log files uploading.

enable - Enable log files uploading.

Choices:

  • "disable"

  • "enable"

upload-hour

integer

Deprecated, please rename it to upload_hour. Log files upload schedule

upload-mode

string

Deprecated, please rename it to upload_mode.

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"

  • "mirror"

upload-trigger

string

Deprecated, please rename it to upload_trigger.

Event triggering log files upload.

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

on-schedule - Upload log files daily.

Choices:

  • "on-roll"

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

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

  • 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: Log rolling policy for device logs.
      fortinet.fortimanager.fmgr_system_log_settings_rollingregular:
        # 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_rollingregular:
          days:
            - sun
            - mon
            - tue
            - wed
            - thu
            - fri
            - sat
          del_files: <value in [disable, enable]>
          directory: <string>
          file_size: <integer>
          gzip_format: <value in [disable, enable]>
          hour: <integer>
          ip: <string>
          ip2: <string>
          ip3: <string>
          log_format: <value in [native, text, csv]>
          min: <integer>
          password: <list or string>
          password2: <list or string>
          password3: <list or string>
          server_type: <value in [ftp, sftp, scp]>
          upload: <value in [disable, enable]>
          upload_hour: <integer>
          upload_mode: <value in [backup, mirror]>
          upload_trigger: <value in [on-roll, on-schedule]>
          username: <string>
          username2: <string>
          username3: <string>
          when: <value in [none, daily, weekly]>
          port: <integer>
          port2: <integer>
          port3: <integer>
          rolling_upgrade_status: <integer>
          server: <string>
          server2: <string>
          server3: <string>

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)