Try SpotterSettings for local disk logging.
| "added in version" 1.0.0 of dux_fortinet.fortianalyzer_dev"
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 dux_fortinet.fortianalyzer_dev:==1.4.0
collections:
- name: dux_fortinet.fortianalyzer_dev
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: Settings for local disk logging.
fortinet.fortianalyzer.faz_cli_system_locallog_disk_setting:
cli_system_locallog_disk_setting:
# diskfull: <value in [overwrite, nolog]>
# log_disk_full_percentage: <value of integer>
# max_log_file_size: <value of integer>
roll_day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
# roll_schedule: <value in [none, daily, weekly]>
# roll_time: <value of string>
# server_type: <value in [FTP, SFTP, SCP]>
# severity: <value in [emergency, alert, critical, ...]>
status: disable
upload: disable
upload_delete_files: disable
# upload_time: <value of string>
# uploaddir: <value of string>
# uploadip: <value of string>
# uploadpass: <value of string>
# uploadport: <value of integer>
uploadsched: disable
uploadtype:
- event
# uploaduser: <value of string>
uploadzip: disable
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
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
cli_system_locallog_disk_setting:
description: The top level parameters set.
required: false
suboptions:
diskfull:
choices:
- overwrite
- nolog
description:
- Policy to apply when disk is full.
- overwrite - Overwrite oldest log when disk is full.
- nolog - Stop logging when disk is full.
type: str
log-disk-full-percentage:
description: Consider log disk as full at this usage percentage.
type: int
log-disk-quota:
description: Quota for controlling local log size.
type: int
max-log-file-num:
description: Maximum number of log files before rolling.
type: int
max-log-file-size:
description: Maximum log file size before rolling.
type: int
roll-day:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description: no description
elements: str
type: list
roll-schedule:
choices:
- none
- daily
- weekly
description:
- Frequency to check log file for rolling.
- none - Not scheduled.
- daily - Every day.
- weekly - Every week.
type: str
roll-time:
description: Time to roll logs (hh:mm).
type: str
server-type:
choices:
- FTP
- SFTP
- SCP
description:
- Server type.
- FTP - Upload via FTP.
- SFTP - Upload via SFTP.
- SCP - Upload via SCP.
type: str
severity:
choices:
- emergency
- alert
- critical
- error
- warning
- notification
- information
- debug
description:
- Least severity level to log.
- emergency - Emergency level.
- alert - Alert level.
- critical - Critical level.
- error - Error level.
- warning - Warning level.
- notification - Notification level.
- information - Information level.
- debug - Debug level.
type: str
status:
choices:
- disable
- enable
description:
- Enable/disable local disk log.
- disable - Do not log to local disk.
- enable - Log to local disk.
type: str
upload:
choices:
- disable
- enable
description:
- Upload log file when rolling.
- disable - Disable uploading when rolling log file.
- enable - Enable uploading when rolling log file.
type: str
upload-delete-files:
choices:
- disable
- enable
description:
- Delete log files after uploading (default = enable).
- disable - Do not delete log files after uploading.
- enable - Delete log files after uploading.
type: str
upload-time:
description: Time to upload logs (hh:mm).
type: str
uploaddir:
description: Log file upload remote directory.
type: str
uploadip:
description: IP address of log uploading server.
type: str
uploadpass:
description: no description
type: str
uploadport:
description: Server port (0 = default protocol port).
type: int
uploadsched:
choices:
- disable
- enable
description:
- Scheduled upload (disable = upload when rolling).
- disable - Upload when rolling.
- enable - Scheduled upload.
type: str
uploadtype:
choices:
- event
description: no description
elements: str
type: list
uploaduser:
description: User account in upload server.
type: str
uploadzip:
choices:
- disable
- enable
description:
- Compress upload logs.
- disable - Upload log files as plain text.
- enable - Upload log files compressed.
type: str
type: dict
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