fmgr_system_log_settings_rollinglocal – Log rolling policy for local logs.¶
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_log_settings_rollinglocal - Log rolling policy for local logs. type: dict
- days - No description for the parameter type: array choices: [sun, mon, tue, wed, thu, fri, sat]
- del-files - Enable/disable log file deletion after uploading. type: str choices: [disable, enable] default: disable
- directory - Upload server directory, for Unix server, use absolute type: str
- file-size - Roll log files when they reach this size (MB). type: int default: 200
- gzip-format - Enable/disable compression of uploaded log files. type: str choices: [disable, enable] default: disable
- hour - Log files rolling schedule (hour). type: int default: 0
- ip - Upload server IP address. type: str default: 0.0.0.0
- ip2 - Upload server IP2 address. type: str default: 0.0.0.0
- ip3 - Upload server IP3 address. type: str default: 0.0.0.0
- log-format - Format of uploaded log files. type: str choices: [native, text, csv] default: native
- min - Log files rolling schedule (minutes). type: int default: 0
- password - No description for the parameter type: str
- password2 - No description for the parameter type: str
- password3 - No description for the parameter type: str
- server-type - Upload server type. type: str choices: [ftp, sftp, scp] default: ftp
- upload - Enable/disable log file uploads. type: str choices: [disable, enable] default: disable
- upload-hour - Log files upload schedule (hour). type: int default: 0
- upload-mode - Upload mode with multiple servers. type: str choices: [backup, mirror] default: backup
- upload-trigger - Event triggering log files upload. type: str choices: [on-roll, on-schedule] default: on-roll
- username - Upload server login username. type: str
- username2 - Upload server login username2. type: str
- username3 - Upload server login username3. type: str
- when - Roll log files periodically. type: str choices: [none, daily, weekly] default: none
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: Log rolling policy for local logs.
fmgr_system_log_settings_rollinglocal:
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_log_settings_rollinglocal:
days:
- sun
- mon
- tue
- wed
- thu
- fri
- sat
del-files: <value in [disable, enable]>
directory: <value of string>
file-size: <value of integer>
gzip-format: <value in [disable, enable]>
hour: <value of integer>
ip: <value of string>
ip2: <value of string>
ip3: <value of string>
log-format: <value in [native, text, csv]>
min: <value of integer>
password: <value of string>
password2: <value of string>
password3: <value of string>
server-type: <value in [ftp, sftp, scp]>
upload: <value in [disable, enable]>
upload-hour: <value of integer>
upload-mode: <value in [backup, mirror]>
upload-trigger: <value in [on-roll, on-schedule]>
username: <value of string>
username2: <value of string>
username3: <value of string>
when: <value in [none, daily, weekly]>
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