Try SpotterLog settings.
| "added in version" 1.0.0 of fortinet.fortianalyzer"
Authors: Xinwei Du (@dux-fortinet), Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0
collections:
- name: fortinet.fortianalyzer
version: 1.4.0This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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
log_path:
default: /tmp/fortianalyzer.ansible.log
description:
- 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.log
required: false
type: str
rc_failed:
description: the rc codes list with which the conditions to fail will be overriden
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: the rc codes list with which the conditions to succeed will be overriden
elements: int
required: false
type: list
proposed_method:
choices:
- set
- update
- add
description: The overridden method for the underlying Json RPC request
required: false
type: str
bypass_validation:
default: false
description: only set to True when module schema diffs with FortiAnalyzer API structure,
module continues to execute without validating parameters
required: false
type: bool
cli_system_log_settings:
description: The top level parameters set.
required: false
suboptions:
FAC-custom-field1:
description: Name of custom log field to index.
type: str
FAZ-custom-field1:
description: Name of custom log field to index.
type: str
FCH-custom-field1:
description: Name of custom log field to index.
type: str
FCT-custom-field1:
description: Name of custom log field to index.
type: str
FDD-custom-field1:
description: Name of custom log field to index.
type: str
FGT-custom-field1:
description: Name of custom log field to index.
type: str
FMG-custom-field1:
description: Name of custom log field to index.
type: str
FML-custom-field1:
description: Name of custom log field to index.
type: str
FPX-custom-field1:
description: Name of custom log field to index.
type: str
FSA-custom-field1:
description: Name of custom log field to index.
type: str
FWB-custom-field1:
description: Name of custom log field to index.
type: str
browse-max-logfiles:
description: Maximum number of log files for each log browse attempt for each
Adom.
type: int
device-auto-detect:
choices:
- disable
- enable
description:
- 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.
type: str
dns-resolve-dstip:
choices:
- disable
- enable
description:
- Enable/Disable resolving destination IP by DNS.
- disable - Disable resolving destination IP by DNS.
- enable - Enable resolving destination IP by DNS.
type: str
download-max-logs:
description: Maximum number of logs for each log download attempt.
type: int
ha-auto-migrate:
choices:
- disable
- enable
description:
- 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.
type: str
import-max-logfiles:
description: Maximum number of log files for each log import attempt.
type: int
keep-dev-logs:
choices:
- disable
- enable
description:
- 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.
type: str
log-file-archive-name:
choices:
- basic
- extended
description:
- Log file name format for archiving, such as backup, upload or download.
- basic - Basic format for log archive file name, e.g. FGT20C0000000001.tlog.1417797247.log.
- extended - Extended format for log archive file name, e.g. FGT20C0000000001.2014-12-05-08:34:58.tlog.1417797247.log.
type: str
log-interval-dev-no-logging:
description: Interval in minute of no log received from a device when considering
the device down.
type: int
log-upload-interval-dev-no-logging:
description: Interval in minute of no log uploaded from a device when considering
the device down.
type: int
rolling-analyzer:
description: no description
required: false
suboptions:
days:
choices:
- sun
- mon
- tue
- wed
- thu
- fri
- sat
description: no description
elements: str
type: list
del-files:
choices:
- disable
- enable
description:
- Enable/disable log file deletion after uploading.
- disable - Disable log file deletion.
- enable - Enable log file deletion.
type: str
directory:
description: Upload server directory, for Unix server, use absolute
type: str
file-size:
description: Roll log files when they reach this size (MB).
type: int
gzip-format:
choices:
- disable
- enable
description:
- Enable/disable compression of uploaded log files.
- disable - Disable compression.
- enable - Enable compression.
type: str
hour:
description: Log files rolling schedule (hour).
type: int
ip:
description: Upload server IP address.
type: str
ip2:
description: Upload server IP2 address.
type: str
ip3:
description: Upload server IP3 address.
type: str
log-format:
choices:
- native
- text
- csv
description:
- Format of uploaded log files.
- native - Native format (text or compact).
- text - Text format (convert if necessary).
- csv - CSV (comma-separated value) format.
type: str
min:
description: Log files rolling schedule (minutes).
type: int
password:
description: no description
type: str
password2:
description: no description
type: str
password3:
description: no description
type: str
port:
description: Upload server IP1 port number.
type: int
port2:
description: Upload server IP2 port number.
type: int
port3:
description: Upload server IP3 port number.
type: int
rolling-upgrade-status:
description: rolling upgrade status (1|0).
type: int
server:
description: Upload server FQDN/IP.
type: str
server-type:
choices:
- ftp
- sftp
- scp
description:
- Upload server type.
- ftp - Upload via FTP.
- sftp - Upload via SFTP.
- scp - Upload via SCP.
type: str
server2:
description: Upload server2 FQDN/IP.
type: str
server3:
description: Upload server3 FQDN/IP.
type: str
upload:
choices:
- disable
- enable
description:
- Enable/disable log file uploads.
- disable - Disable log files uploading.
- enable - Enable log files uploading.
type: str
upload-hour:
description: Log files upload schedule (hour).
type: int
upload-mode:
choices:
- backup
- mirror
description:
- 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.
type: str
upload-trigger:
choices:
- on-roll
- on-schedule
description:
- Event triggering log files upload.
- on-roll - Upload log files after they are rolled.
- on-schedule - Upload log files daily.
type: str
username:
description: Upload server login username.
type: str
username2:
description: Upload server login username2.
type: str
username3:
description: Upload server login username3.
type: str
when:
choices:
- none
- daily
- weekly
description:
- 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.
type: str
type: dict
rolling-local:
description: no description
required: false
suboptions:
days:
choices:
- sun
- mon
- tue
- wed
- thu
- fri
- sat
description: no description
elements: str
type: list
del-files:
choices:
- disable
- enable
description:
- Enable/disable log file deletion after uploading.
- disable - Disable log file deletion.
- enable - Enable log file deletion.
type: str
directory:
description: Upload server directory, for Unix server, use absolute
type: str
file-size:
description: Roll log files when they reach this size (MB).
type: int
gzip-format:
choices:
- disable
- enable
description:
- Enable/disable compression of uploaded log files.
- disable - Disable compression.
- enable - Enable compression.
type: str
hour:
description: Log files rolling schedule (hour).
type: int
ip:
description: Upload server IP address.
type: str
ip2:
description: Upload server IP2 address.
type: str
ip3:
description: Upload server IP3 address.
type: str
log-format:
choices:
- native
- text
- csv
description:
- Format of uploaded log files.
- native - Native format (text or compact).
- text - Text format (convert if necessary).
- csv - CSV (comma-separated value) format.
type: str
min:
description: Log files rolling schedule (minutes).
type: int
password:
description: no description
type: str
password2:
description: no description
type: str
password3:
description: no description
type: str
port:
description: Upload server IP1 port number.
type: int
port2:
description: Upload server IP2 port number.
type: int
port3:
description: Upload server IP3 port number.
type: int
rolling-upgrade-status:
description: rolling upgrade status (1|0).
type: int
server:
description: Upload server FQDN/IP.
type: str
server-type:
choices:
- ftp
- sftp
- scp
description:
- Upload server type.
- ftp - Upload via FTP.
- sftp - Upload via SFTP.
- scp - Upload via SCP.
type: str
server2:
description: Upload server2 FQDN/IP.
type: str
server3:
description: Upload server3 FQDN/IP.
type: str
upload:
choices:
- disable
- enable
description:
- Enable/disable log file uploads.
- disable - Disable log files uploading.
- enable - Enable log files uploading.
type: str
upload-hour:
description: Log files upload schedule (hour).
type: int
upload-mode:
choices:
- backup
- mirror
description:
- 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.
type: str
upload-trigger:
choices:
- on-roll
- on-schedule
description:
- Event triggering log files upload.
- on-roll - Upload log files after they are rolled.
- on-schedule - Upload log files daily.
type: str
username:
description: Upload server login username.
type: str
username2:
description: Upload server login username2.
type: str
username3:
description: Upload server login username3.
type: str
when:
choices:
- none
- daily
- weekly
description:
- 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.
type: str
type: dict
rolling-regular:
description: no description
required: false
suboptions:
days:
choices:
- sun
- mon
- tue
- wed
- thu
- fri
- sat
description: no description
elements: str
type: list
del-files:
choices:
- disable
- enable
description:
- Enable/disable log file deletion after uploading.
- disable - Disable log file deletion.
- enable - Enable log file deletion.
type: str
directory:
description: Upload server directory, for Unix server, use absolute
type: str
file-size:
description: Roll log files when they reach this size (MB).
type: int
gzip-format:
choices:
- disable
- enable
description:
- Enable/disable compression of uploaded log files.
- disable - Disable compression.
- enable - Enable compression.
type: str
hour:
description: Log files rolling schedule (hour).
type: int
ip:
description: Upload server IP address.
type: str
ip2:
description: Upload server IP2 address.
type: str
ip3:
description: Upload server IP3 address.
type: str
log-format:
choices:
- native
- text
- csv
description:
- Format of uploaded log files.
- native - Native format (text or compact).
- text - Text format (convert if necessary).
- csv - CSV (comma-separated value) format.
type: str
min:
description: Log files rolling schedule (minutes).
type: int
password:
description: no description
type: str
password2:
description: no description
type: str
password3:
description: no description
type: str
port:
description: Upload server IP1 port number.
type: int
port2:
description: Upload server IP2 port number.
type: int
port3:
description: Upload server IP3 port number.
type: int
rolling-upgrade-status:
description: rolling upgrade status (1|0).
type: int
server:
description: Upload server FQDN/IP.
type: str
server-type:
choices:
- ftp
- sftp
- scp
description:
- Upload server type.
- ftp - Upload via FTP.
- sftp - Upload via SFTP.
- scp - Upload via SCP.
type: str
server2:
description: Upload server2 FQDN/IP.
type: str
server3:
description: Upload server3 FQDN/IP.
type: str
upload:
choices:
- disable
- enable
description:
- Enable/disable log file uploads.
- disable - Disable log files uploading.
- enable - Enable log files uploading.
type: str
upload-hour:
description: Log files upload schedule (hour).
type: int
upload-mode:
choices:
- backup
- mirror
description:
- 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.
type: str
upload-trigger:
choices:
- on-roll
- on-schedule
description:
- Event triggering log files upload.
- on-roll - Upload log files after they are rolled.
- on-schedule - Upload log files daily.
type: str
username:
description: Upload server login username.
type: str
username2:
description: Upload server login username2.
type: str
username3:
description: Upload server login username3.
type: str
when:
choices:
- none
- daily
- weekly
description:
- 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.
type: str
type: dict
sync-search-timeout:
description: Maximum number of seconds for running a log search session in synchronous
mode.
type: int
unencrypted-logging:
choices:
- disable
- enable
description:
- Enable/Disable receiving syslog through UDP(514) or TCP(514) un-encrypted.
- disable - Disable receiving syslog through UDP(514) or TCP(514) un-encrypted.
- enable - Enable receiving syslog through UDP(514) or TCP(514) un-encrypted.
type: str
type: dict
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
meta:
contains:
request_url:
description: The full url requested
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request
returned: always
sample: 0
type: int
response_data:
description: The api response
returned: always
type: list
response_message:
description: The descriptive message of the api response
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current fortianalyzer version.
returned: complex
type: list