fortinet.fortimanager.fmgr_system_log_settings module – Log settings.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
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.
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 |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The top level parameters set. |
|
Maximum number of log files for each log browse attempt for each Adom. |
|
Enable/Disable looking up device ID in syslog received with no encryption. disable - Disable looking up device ID in syslog received with no encryption. enable - Enable looking up device ID in syslog received with no encryption. Choices:
|
|
Enable/Disable resolving destination IP by DNS. disable - Disable resolving destination IP by DNS. enable - Enable resolving destination IP by DNS. Choices:
|
|
Maximum number of logs for each log download attempt. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Name of custom log field to index. |
|
Enabled/Disable automatically merging HA members logs to HA cluster. disable - Disable automatically merging HA members logs to HA cluster. enable - Enable automatically merging HA members logs to HA cluster. Choices:
|
|
Maximum number of log files for each log import attempt. |
|
Enable/Disable keeping the dev logs after the device has been deleted. disable - Disable keeping the dev logs after the device has been deleted. enable - Enable keeping the dev logs after the device has been deleted. Choices:
|
|
Log file name format for archiving, such as backup, upload or download. basic - Basic format for log archive file name, e. extended - Extended format for log archive file name, e. Choices:
|
|
Interval in minute of no log received from a device when considering the device down. |
|
Interval in minute of no log uploaded from a device when considering the device down. |
|
Rolling analyzer. |
|
Log files rolling schedule sun - Sunday. mon - Monday. tue - Tuesday. wed - Wednesday. thu - Thursday. fri - Friday. sat - Saturday. Choices:
|
|
Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. Choices:
|
|
Upload server directory, for Unix server, use absolute |
|
Roll log files when they reach this size |
|
Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. Choices:
|
|
Log files rolling schedule |
|
Upload server IP address. |
|
Upload server IP2 address. |
|
Upload server IP3 address. |
|
Format of uploaded log files. native - Native format text - Text format csv - CSV Choices:
|
|
Log files rolling schedule |
|
(list) Upload server login password. |
|
(list) Upload server login password2. |
|
(list) Upload server login password3. |
|
Upload server IP1 port number. |
|
Upload server IP2 port number. |
|
Upload server IP3 port number. |
|
Rolling upgrade status |
|
Upload server FQDN/IP. |
|
Upload server2 FQDN/IP. |
|
Upload server3 FQDN/IP. |
|
Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. Choices:
|
|
Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. Choices:
|
|
Log files upload schedule |
|
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:
|
|
Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. Choices:
|
|
Upload server login username. |
|
Upload server login username2. |
|
Upload server login username3. |
|
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:
|
|
Rolling local. |
|
Log files rolling schedule sun - Sunday. mon - Monday. tue - Tuesday. wed - Wednesday. thu - Thursday. fri - Friday. sat - Saturday. Choices:
|
|
Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. Choices:
|
|
Upload server directory, for Unix server, use absolute |
|
Roll log files when they reach this size |
|
Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. Choices:
|
|
Log files rolling schedule |
|
Upload server IP address. |
|
Upload server IP2 address. |
|
Upload server IP3 address. |
|
Format of uploaded log files. native - Native format text - Text format csv - CSV Choices:
|
|
Log files rolling schedule |
|
(list) Upload server login password. |
|
(list) Upload server login password2. |
|
(list) Upload server login password3. |
|
Upload server IP1 port number. |
|
Upload server IP2 port number. |
|
Upload server IP3 port number. |
|
Rolling upgrade status |
|
Upload server FQDN/IP. |
|
Upload server2 FQDN/IP. |
|
Upload server3 FQDN/IP. |
|
Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. Choices:
|
|
Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. Choices:
|
|
Log files upload schedule |
|
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:
|
|
Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. Choices:
|
|
Upload server login username. |
|
Upload server login username2. |
|
Upload server login username3. |
|
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:
|
|
Rolling regular. |
|
Log files rolling schedule sun - Sunday. mon - Monday. tue - Tuesday. wed - Wednesday. thu - Thursday. fri - Friday. sat - Saturday. Choices:
|
|
Enable/disable log file deletion after uploading. disable - Disable log file deletion. enable - Enable log file deletion. Choices:
|
|
Upload server directory, for Unix server, use absolute |
|
Roll log files when they reach this size |
|
Enable/disable compression of uploaded log files. disable - Disable compression. enable - Enable compression. Choices:
|
|
Log files rolling schedule |
|
Upload server IP address. |
|
Upload server IP2 address. |
|
Upload server IP3 address. |
|
Format of uploaded log files. native - Native format text - Text format csv - CSV Choices:
|
|
Log files rolling schedule |
|
(list) Upload server login password. |
|
(list) Upload server login password2. |
|
(list) Upload server login password3. |
|
Upload server IP1 port number. |
|
Upload server IP2 port number. |
|
Upload server IP3 port number. |
|
Rolling upgrade status |
|
Upload server FQDN/IP. |
|
Upload server2 FQDN/IP. |
|
Upload server3 FQDN/IP. |
|
Upload server type. ftp - Upload via FTP. sftp - Upload via SFTP. scp - Upload via SCP. Choices:
|
|
Enable/disable log file uploads. disable - Disable log files uploading. enable - Enable log files uploading. Choices:
|
|
Log files upload schedule |
|
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:
|
|
Event triggering log files upload. on-roll - Upload log files after they are rolled. on-schedule - Upload log files daily. Choices:
|
|
Upload server login username. |
|
Upload server login username2. |
|
Upload server login username3. |
|
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:
|
|
Maximum number of seconds for running a log search session in synchronous mode. |
|
Enable/Disable receiving syslog through UDP disable - Disable receiving syslog through UDP enable - Enable receiving syslog through UDP Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 settings.
fortinet.fortimanager.fmgr_system_log_settings:
# 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:
FAC_custom_field1: <string>
FAZ_custom_field1: <string>
FCH_custom_field1: <string>
FCT_custom_field1: <string>
FDD_custom_field1: <string>
FGT_custom_field1: <string>
FMG_custom_field1: <string>
FML_custom_field1: <string>
FPX_custom_field1: <string>
FSA_custom_field1: <string>
FWB_custom_field1: <string>
browse_max_logfiles: <integer>
dns_resolve_dstip: <value in [disable, enable]>
download_max_logs: <integer>
ha_auto_migrate: <value in [disable, enable]>
import_max_logfiles: <integer>
log_file_archive_name: <value in [basic, extended]>
rolling_analyzer:
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>
rolling_local:
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>
rolling_regular:
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>
sync_search_timeout: <integer>
keep_dev_logs: <value in [disable, enable]>
device_auto_detect: <value in [disable, enable]>
unencrypted_logging: <value in [disable, enable]>
log_interval_dev_no_logging: <integer>
log_upload_interval_dev_no_logging: <integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |