source: faz_cli_system_log_settings.py
orphan

faz_cli_system_log_settings -- Log settings.

1.0.0

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

Possible variable names before 2.0.0: variable-name, variable name, variable.name
Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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

FortiAnalyzer Version Compatibility

Supported Version Ranges: v6.2.1 -> latest

Parameters

access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
enable_log Enable/Disable logging for task type: bool default: False
forticloud_access_token Access token of forticloud analyzer API users. type: str
log_path The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str default: "/tmp/fortianalyzer.ansible.log"
proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
rc_failed The rc codes list with which the conditions to fail will be overriden type: list
cli_system_log_settings Log settings. type: dict

FAC_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FAZ_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> v7.2.0
FCH_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FCT_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FDD_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FGT_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FMG_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> v7.2.0
FML_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FPX_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FSA_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
FWB_custom_field1 Name of custom log field to index. type: str more...

Supported Version Ranges: v6.2.1 -> latest
browse_max_logfiles Maximum number of log files for each log browse attempt for each Adom. type: int default: 10000 more...

Supported Version Ranges: v6.2.1 -> latest
dns_resolve_dstip Enable/Disable resolving destination IP by DNS. type: str choices: [disable, enable] default: disable more...

Supported Version Ranges: v6.2.1 -> latest
download_max_logs Maximum number of logs for each log download attempt. type: int default: 100000 more...

Supported Version Ranges: v6.2.1 -> latest
ha_auto_migrate Enabled/Disable automatically merging HA members logs to HA cluster. type: str choices: [disable, enable] default: disable more...

Supported Version Ranges: v6.2.1 -> latest
import_max_logfiles Maximum number of log files for each log import attempt. type: int default: 10000 more...

Supported Version Ranges: v6.2.1 -> latest
log_file_archive_name Log file name format for archiving, such as backup, upload or download. type: str choices: [basic, extended] default: basic more...

Supported Version Ranges: v6.2.1 -> latest
rolling_analyzer type: dict more...

Supported Version Ranges: v6.2.1 -> latest
- days Log files rolling schedule (days of week). type: list elements: str choices: [sun, mon, tue, wed, thu, fri, sat] more...
  
  Supported Version Ranges: v6.2.1 -> latest
- del_files Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- directory Upload server directory, for Unix server, use absolute type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- file_size Roll log files when they reach this size (MB). type: int default: 200 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- gzip_format Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- hour Log files rolling schedule (hour). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- ip Upload server IP address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- ip2 Upload server IP2 address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- ip3 Upload server IP3 address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- log_format Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
  
  Supported Version Ranges: v6.2.1 -> latest
- min Log files rolling schedule (minutes). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password Upload server login password. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password2 Upload server login password2. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password3 Upload server login password3. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port Upload server IP1 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port2 Upload server IP2 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port3 Upload server IP3 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- server_type Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_hour Log files upload schedule (hour). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_mode Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_trigger Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username Upload server login username. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username2 Upload server login username2. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username3 Upload server login username3. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- when Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
  
  Supported Version Ranges: v6.2.1 -> latest
- rolling_upgrade_status rolling upgrade status (1|0). type: int default: 0 more...
  
  Supported Version Ranges: v7.0.3 -> latest
- server Upload server FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
- server2 Upload server2 FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
- server3 Upload server3 FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
rolling_local type: dict more...

Supported Version Ranges: v6.2.1 -> latest
- days Log files rolling schedule (days of week). type: list elements: str choices: [sun, mon, tue, wed, thu, fri, sat] more...
  
  Supported Version Ranges: v6.2.1 -> latest
- del_files Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- directory Upload server directory, for Unix server, use absolute type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- file_size Roll log files when they reach this size (MB). type: int default: 200 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- gzip_format Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- hour Log files rolling schedule (hour). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- ip Upload server IP address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- ip2 Upload server IP2 address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- ip3 Upload server IP3 address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- log_format Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
  
  Supported Version Ranges: v6.2.1 -> latest
- min Log files rolling schedule (minutes). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password Upload server login password. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password2 Upload server login password2. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password3 Upload server login password3. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port Upload server IP1 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port2 Upload server IP2 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port3 Upload server IP3 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- server_type Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_hour Log files upload schedule (hour). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_mode Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_trigger Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username Upload server login username. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username2 Upload server login username2. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username3 Upload server login username3. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- when Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
  
  Supported Version Ranges: v6.2.1 -> latest
- rolling_upgrade_status rolling upgrade status (1|0). type: int default: 0 more...
  
  Supported Version Ranges: v7.0.3 -> latest
- server Upload server FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
- server2 Upload server2 FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
- server3 Upload server3 FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
rolling_regular type: dict more...

Supported Version Ranges: v6.2.1 -> latest
- days Log files rolling schedule (days of week). type: list elements: str choices: [sun, mon, tue, wed, thu, fri, sat] more...
  
  Supported Version Ranges: v6.2.1 -> latest
- del_files Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- directory Upload server directory, for Unix server, use absolute type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- file_size Roll log files when they reach this size (MB). type: int default: 200 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- gzip_format Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- hour Log files rolling schedule (hour). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- ip Upload server IP address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- ip2 Upload server IP2 address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- ip3 Upload server IP3 address. type: str default: 0.0.0.0 more...
  
  Supported Version Ranges: v6.2.1 -> v7.0.12
- log_format Format of uploaded log files. type: str choices: [native, text, csv] default: native more...
  
  Supported Version Ranges: v6.2.1 -> latest
- min Log files rolling schedule (minutes). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password Upload server login password. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password2 Upload server login password2. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- password3 Upload server login password3. type: str elements: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port Upload server IP1 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port2 Upload server IP2 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- port3 Upload server IP3 port number. type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- server_type Upload server type. type: str choices: [ftp, sftp, scp] default: ftp more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload Enable/disable log file uploads. type: str choices: [disable, enable] default: disable more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_hour Log files upload schedule (hour). type: int default: 0 more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_mode Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup more...
  
  Supported Version Ranges: v6.2.1 -> latest
- upload_trigger Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username Upload server login username. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username2 Upload server login username2. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- username3 Upload server login username3. type: str more...
  
  Supported Version Ranges: v6.2.1 -> latest
- when Roll log files periodically. type: str choices: [none, daily, weekly] default: none more...
  
  Supported Version Ranges: v6.2.1 -> latest
- rolling_upgrade_status rolling upgrade status (1|0). type: int default: 0 more...
  
  Supported Version Ranges: v7.0.3 -> latest
- server Upload server FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
- server2 Upload server2 FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
- server3 Upload server3 FQDN/IP. type: str more...
  
  Supported Version Ranges: v7.2.0 -> latest
sync_search_timeout Maximum number of seconds for running a log search session in synchronous mode. type: int default: 60 more...

Supported Version Ranges: v6.2.1 -> latest
keep_dev_logs Enable/Disable keeping the dev logs after the device has been deleted. type: str choices: [disable, enable] default: disable more...

Supported Version Ranges: v6.4.7 -> v6.4.14, v7.0.2 -> latest
device_auto_detect Enable/Disable looking up device ID in syslog received with no encryption. type: str choices: [disable, enable] default: enable more...

Supported Version Ranges: v7.0.10 -> v7.0.12, v7.2.4 -> v7.2.5, v7.4.1 -> latest
unencrypted_logging Enable/Disable receiving syslog through UDP(514) or TCP(514) un-encrypted. type: str choices: [disable, enable] default: enable more...

Supported Version Ranges: v7.0.10 -> v7.0.12, v7.2.4 -> v7.2.5, v7.4.1 -> latest
log_interval_dev_no_logging Interval in minute of no log received from a device when considering the device down. type: int default: 15 more...

Supported Version Ranges: v7.2.5 -> v7.2.5, v7.4.2 -> latest
log_upload_interval_dev_no_logging Interval in minute of no log uploaded from a device when considering the device down. type: int default: 360 more...

Supported Version Ranges: v7.2.5 -> v7.2.5, v7.4.2 -> latest

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

- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Log settings.
      fortinet.fortianalyzer.faz_cli_system_log_settings:
        cli_system_log_settings:
          dns_resolve_dstip: disable
          download_max_logs: 100000
          ha_auto_migrate: disable
          import_max_logfiles: 10000
          sync_search_timeout: 60
  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:

meta The result of the request. returned: always type: dict

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_data The data body of the api response. returned: optional type: list or dict
response_message The descriptive message of the api response. returned: always type: str sample: OK
system_information The information of the target system. returned: always type: dict

rc The status the request. returned: always type: int sample: 0
version_check_warning Warning if the parameters used in the playbook are not supported by the current fortianalyzer version. returned: if params are not supported in the current version type: list

Status

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

Authors

Xinwei Du (@dux-fortinet)
Maxx Liu (@MaxxLiu22)
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

faz_cli_system_log_settings.rst

faz_cli_system_log_settings.rst

faz_cli_system_log_settings -- Log settings.

Synopsis

Requirements

FortiAnalyzer Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

Files

faz_cli_system_log_settings.rst

Latest commit

History

faz_cli_system_log_settings.rst

File metadata and controls

faz_cli_system_log_settings -- Log settings.

Synopsis

Requirements

FortiAnalyzer Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors