Try SpotterSettings for local disk logging.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: Settings for local disk logging.
fortinet.fortimanager.fmgr_system_locallog_disk_setting:
# 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_locallog_disk_setting:
diskfull: <value in [overwrite, nolog]>
log_disk_full_percentage: <integer>
max_log_file_size: <integer>
roll_day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
roll_schedule: <value in [none, daily, weekly]>
roll_time: <list or string>
server_type: <value in [FTP, SFTP, SCP]>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
upload: <value in [disable, enable]>
upload_delete_files: <value in [disable, enable]>
upload_time: <list or string>
uploaddir: <string>
uploadip: <string>
uploadpass: <list or string>
uploadport: <integer>
uploadsched: <value in [disable, enable]>
uploadtype:
- event
uploaduser: <string>
uploadzip: <value in [disable, enable]>
log_disk_quota: <integer>
max_log_file_num: <integer>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
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: Deprecated, please rename it to log_disk_full_percentage. Consider
log disk as full at this usage percentage.
type: int
log-disk-quota:
description: Deprecated, please rename it to log_disk_quota. Quota for controlling
local log size.
type: int
max-log-file-num:
description: Deprecated, please rename it to max_log_file_num. Maximum number
of log files before rolling.
type: int
max-log-file-size:
description: Deprecated, please rename it to max_log_file_size. Maximum log file
size before rolling.
type: int
roll-day:
choices:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
description:
- Deprecated, please rename it to roll_day.
- Days of week to roll logs.
- sunday - Sunday.
- monday - Monday.
- tuesday - Tuesday.
- wednesday - Wednesday.
- thursday - Thursday.
- friday - Friday.
- saturday - Saturday.
elements: str
type: list
roll-schedule:
choices:
- none
- daily
- weekly
description:
- Deprecated, please rename it to roll_schedule.
- Frequency to check log file for rolling.
- none - Not scheduled.
- daily - Every day.
- weekly - Every week.
type: str
roll-time:
description: (list or str) Deprecated, please rename it to roll_time. Time to
roll logs
type: raw
server-type:
choices:
- FTP
- SFTP
- SCP
description:
- Deprecated, please rename it to server_type.
- 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:
- Deprecated, please rename it to upload_delete_files.
- Delete log files after uploading
- disable - Do not delete log files after uploading.
- enable - Delete log files after uploading.
type: str
upload-time:
description: (list or str) Deprecated, please rename it to upload_time. Time to
upload logs
type: raw
uploaddir:
description: Log file upload remote directory.
type: str
uploadip:
description: IP address of log uploading server.
type: str
uploadpass:
description: (list) Password of user account in upload server.
type: raw
uploadport:
description: Server port
type: int
uploadsched:
choices:
- disable
- enable
description:
- Scheduled upload
- disable - Upload when rolling.
- enable - Scheduled upload.
type: str
uploadtype:
choices:
- event
description:
- Types of log files that need to be uploaded.
- event - Upload event log.
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 FortiManager version.
returned: complex
type: list