fmgr_system_locallog_disk_setting – Settings for local disk logging.¶
New in version 2.10.
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 v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- system_locallog_disk_setting - Settings for local disk logging. type: dict
- diskfull - Policy to apply when disk is full. type: str choices: [overwrite, nolog] default: overwrite
- log-disk-full-percentage - Consider log disk as full at this usage percentage. type: int default: 80
- max-log-file-size - Maximum log file size before rolling. type: int default: 100
- roll-day - No description for the parameter type: array choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]
- roll-schedule - Frequency to check log file for rolling. type: str choices: [none, daily, weekly] default: none
- roll-time - No description for the parameter type: str
- server-type - Server type. type: str choices: [FTP, SFTP, SCP] default: FTP
- severity - Least severity level to log. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] default: information
- status - Enable/disable local disk log. type: str choices: [disable, enable] default: enable
- upload - Upload log file when rolling. type: str choices: [disable, enable] default: disable
- upload-delete-files - Delete log files after uploading (default = enable). type: str choices: [disable, enable] default: enable
- upload-time - No description for the parameter type: str
- uploaddir - Log file upload remote directory. type: str
- uploadip - IP address of log uploading server. type: str default: 0.0.0.0
- uploadpass - No description for the parameter type: str
- uploadport - Server port (0 = default protocol port). type: int default: 0
- uploadsched - Scheduled upload (disable = upload when rolling). type: str choices: [disable, enable] default: disable
- uploadtype - No description for the parameter type: array choices: [event]
- uploaduser - User account in upload server. type: str
- uploadzip - Compress upload logs. type: str choices: [disable, enable] default: disable
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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Settings for local disk logging.
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: <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: <value in [disable, enable]>
upload: <value in [disable, enable]>
upload-delete-files: <value in [disable, enable]>
upload-time: <value of string>
uploaddir: <value of string>
uploadip: <value of string>
uploadpass: <value of string>
uploadport: <value of integer>
uploadsched: <value in [disable, enable]>
uploadtype:
- event
uploaduser: <value of string>
uploadzip: <value in [disable, enable]>
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict