fmgd_log_disk_setting – Settings for local disk logging.
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- vdom - The parameter in requested url type: str required: true
- log_disk_setting - Settings for local disk logging. type: dict
- diskfull Action to take when disk is full. type: str choices: [overwrite, blocktraffic, nolog] more...
- dlp_archive_quota (Alias name: dlp-archive-quota) Dlp archive quota (mb). type: int more...
- full_final_warning_threshold (Alias name: full-final-warning-threshold) Log full final warning threshold as a percent (3 - 100, default = 95). type: int more...
- full_first_warning_threshold (Alias name: full-first-warning-threshold) Log full first warning threshold as a percent (1 - 98, default = 75). type: int more...
- full_second_warning_threshold (Alias name: full-second-warning-threshold) Log full second warning threshold as a percent (2 - 99, default = 90). type: int more...
- interface Specify outgoing interface to reach server. type: list more...
- interface_select_method (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
- ips_archive (Alias name: ips-archive) Enable/disable ips packet archiving to the local disk. type: str choices: [disable, enable] more...
- log_quota (Alias name: log-quota) Disk log quota (mb). type: int more...
- max_log_file_size (Alias name: max-log-file-size) Maximum log file size before rolling (1 - 100 mbytes). type: int more...
- max_policy_packet_capture_size (Alias name: max-policy-packet-capture-size) Maximum size of policy sniffer in mb (0 means unlimited). type: int more...
- maximum_log_age (Alias name: maximum-log-age) Delete log files older than (days). type: int more...
- report_quota (Alias name: report-quota) Report db quota (mb). type: int more...
- roll_day (Alias name: roll-day) Day of week on which to roll log file. type: list choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
- roll_schedule (Alias name: roll-schedule) Frequency to check log file for rolling. type: str choices: [daily, weekly] more...
- roll_time (Alias name: roll-time) Time of day to roll the log file (hh:mm). type: str more...
- source_ip (Alias name: source-ip) Source ip address to use for uploading disk log files. type: str more...
- status Enable/disable local disk logging. type: str choices: [disable, enable] more...
- upload Enable/disable uploading log files when they are rolled. type: str choices: [disable, enable] more...
- upload_delete_files (Alias name: upload-delete-files) Delete log files after uploading (default = enable). type: str choices: [disable, enable] more...
- upload_destination (Alias name: upload-destination) The type of server to upload log files to. type: str choices: [ftp-server, fortianalyzer] more...
- upload_ssl_conn (Alias name: upload-ssl-conn) Enable/disable encrypted ftps communication to upload log files. type: str choices: [default, high, low, disable] more...
- uploaddir The remote directory on the ftp server to upload log files to. type: str more...
- uploadip Ip address of the ftp server to upload log files to. type: str more...
- uploadpass Password required to log into the ftp server to upload disk log files. type: list more...
- uploadport Tcp port to use for communicating with the ftp server (default = 21). type: int more...
- uploadsched Set the schedule for uploading log files to the ftp server (default = disable = upload when rolling). type: str choices: [disable, enable] more...
- uploadtime Time of day at which log files are uploaded if uploadsched is enabled (hh:mm or hh). type: int more...
- uploadtype Types of log files to upload. type: list choices: [traffic, event, virus, webfilter, attack, spamfilter, voip, dlp, app-ctrl, netscan, dlp-archive, IPS, anomaly, waf, gtp, dns, emailfilter, ssh, ssl, cifs, file-filter, icap, ztna, http, virtual-patch, debug] more...
- uploaduser Username required to log into the ftp server to upload disk log files. type: str more...
- vrf_select (Alias name: vrf-select) Vrf id used for connection to server. type: int more...
Notes
Note
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.
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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Settings for local disk logging.
fortinet.fmgdevice.fmgd_log_disk_setting:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
vdom: <your own value>
log_disk_setting:
# diskfull: <value in [overwrite, blocktraffic, nolog]>
# dlp_archive_quota: <integer>
# full_final_warning_threshold: <integer>
# full_first_warning_threshold: <integer>
# full_second_warning_threshold: <integer>
# interface: <list or string>
# interface_select_method: <value in [auto, sdwan, specify]>
# ips_archive: <value in [disable, enable]>
# log_quota: <integer>
# max_log_file_size: <integer>
# max_policy_packet_capture_size: <integer>
# maximum_log_age: <integer>
# report_quota: <integer>
# roll_day:
# - "sunday"
# - "monday"
# - "tuesday"
# - "wednesday"
# - "thursday"
# - "friday"
# - "saturday"
# roll_schedule: <value in [daily, weekly]>
# roll_time: <string>
# source_ip: <string>
# status: <value in [disable, enable]>
# upload: <value in [disable, enable]>
# upload_delete_files: <value in [disable, enable]>
# upload_destination: <value in [ftp-server, fortianalyzer]>
# upload_ssl_conn: <value in [default, high, low, ...]>
# uploaddir: <string>
# uploadip: <string>
# uploadpass: <list or string>
# uploadport: <integer>
# uploadsched: <value in [disable, enable]>
# uploadtime: <integer>
# uploadtype:
# - "traffic"
# - "event"
# - "virus"
# - "webfilter"
# - "attack"
# - "spamfilter"
# - "voip"
# - "dlp"
# - "app-ctrl"
# - "netscan"
# - "dlp-archive"
# - "IPS"
# - "anomaly"
# - "waf"
# - "gtp"
# - "dns"
# - "emailfilter"
# - "ssh"
# - "ssl"
# - "cifs"
# - "file-filter"
# - "icap"
# - "ztna"
# - "http"
# - "virtual-patch"
# - "debug"
# uploaduser: <string>
# vrf_select: <integer>
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 FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.