fortinet.fortimanager.fmgr_system_log_settings_rollingregular – Log rolling policy for device logs.
fortinet.fortimanager.fmgr_system_log_settings_rollingregular – Log rolling policy for device logs.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.0.1).
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 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 | Choices/Defaults | Comments | |
---|---|---|---|
bypass_validation boolean |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
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 | |
system_log_settings_rollingregular dictionary |
the top level parameters set | ||
days list / elements=string |
|
no description | |
del-files string |
|
Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. | |
directory string |
Upload server directory, for Unix server, use absolute | ||
file-size integer |
Default: 200 |
Roll log files when they reach this size (MB). | |
gzip-format string |
|
Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. | |
hour integer |
Default: 0 |
Log files rolling schedule (hour). | |
ip string |
Default: "0.0.0.0" |
Upload server IP address. | |
ip2 string |
Default: "0.0.0.0" |
Upload server IP2 address. | |
ip3 string |
Default: "0.0.0.0" |
Upload server IP3 address. | |
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. | |
min integer |
Default: 0 |
Log files rolling schedule (minutes). | |
password string |
no description | ||
password2 string |
no description | ||
password3 string |
no description | ||
server-type string |
|
Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. | |
upload string |
|
Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. | |
upload-hour integer |
Default: 0 |
Log files upload schedule (hour). | |
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. | |
upload-trigger string |
|
Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. | |
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. | |
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 |
Default: 300 |
the maximum time in seconds to wait for other user to release the workspace lock |
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 device logs.
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: <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]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
request_url string |
always |
The full url requested
Sample: /sys/login/user |
response_code integer |
always |
The status of api request
|
response_message string |
always |
The descriptive message of the api response
Sample: OK. |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_log_settings_rollingregular_module.html