faz_cli_system_log_settings_rollingregular – Log rolling policy for device logs.¶

New in version 2.10.

Synopsis
Requirements
FortiAnalyzer Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements ¶

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

ansible>=2.9.0

FortiAnalyzer Version Compatibility ¶

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

cli_system_log_settings_rollingregular yes yes yes yes yes yes yes yes yes yes yes yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
cli_system_log_settings_rollingregular - Log rolling policy for device logs. type: dict

days - No description for the parameter type: array choices: [sun, mon, tue, wed, thu, fri, sat] more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

days True True True True True True True True True True True True
del-files - Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

del-files True True True True True True True True True True True True
directory - Upload server directory, for Unix server, use absolute type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

directory True True True True True True True True True True True True
file-size - Roll log files when they reach this size (MB). type: int default: 200 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

file-size True True True True True True True True True True True True
gzip-format - Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

gzip-format True True True True True True True True True True True True
hour - Log files rolling schedule (hour). type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

hour True True True True True True True True True True True True
ip - Upload server IP address. type: str default: 0.0.0.0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ip True True True True True True True True True True True False
ip2 - Upload server IP2 address. type: str default: 0.0.0.0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ip2 True True True True True True True True True True True False
ip3 - Upload server IP3 address. type: str default: 0.0.0.0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

ip3 True True True True True True True True True True True False
log-format - Format of uploaded log files. type: str choices: [native, text, csv] default: native more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

log-format True True True True True True True True True True True True
min - Log files rolling schedule (minutes). type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

min True True True True True True True True True True True True
password - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

password True True True True True True True True True True True True
password2 - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

password2 True True True True True True True True True True True True
password3 - No description for the parameter type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

password3 True True True True True True True True True True True True
port - Upload server IP1 port number. type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

port True True True True True True True True True True True True
port2 - Upload server IP2 port number. type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

port2 True True True True True True True True True True True True
port3 - Upload server IP3 port number. type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

port3 True True True True True True True True True True True True
server-type - Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

server-type True True True True True True True True True True True True
upload - Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

upload True True True True True True True True True True True True
upload-hour - Log files upload schedule (hour). type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

upload-hour True True True True True True True True True True True True
upload-mode - Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

upload-mode True True True True True True True True True True True True
upload-trigger - Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

upload-trigger True True True True True True True True True True True True
username - Upload server login username. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

username True True True True True True True True True True True True
username2 - Upload server login username2. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

username2 True True True True True True True True True True True True
username3 - Upload server login username3. type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

username3 True True True True True True True True True True True True
when - Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

when True True True True True True True True True True True True
rolling-upgrade-status - rolling upgrade status (1|0). type: int default: 0 more...

7.2.0

rolling-upgrade-status True
server - Upload server FQDN/IP. type: str more...

7.2.0

server True
server2 - Upload server2 FQDN/IP. type: str more...

7.2.0

server2 True
server3 - Upload server3 FQDN/IP. type: str more...

7.2.0

server3 True

Notes ¶

Note

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 ¶

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_log_settings_rollingregular:
      cli_system_log_settings_rollingregular:
        days:
        - sun
        - mon
        - tue
        - wed
        - thu
        - fri
        - sat
        del-files: disable
        gzip-format: disable
        upload: disable
        when: none
    name: Log rolling policy for device logs.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Return Values ¶

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

request_url - The full url requested returned: always type: str sample: /sys/login/user
response_code - The status of api request returned: always type: int sample: 0
response_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

	`7.2.0`
rolling-upgrade-status	True

	`7.2.0`
server	True

	`7.2.0`
server2	True

	`7.2.0`
server3	True