fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_system_log_settings_rollinglocal Log rolling policy for local logs. | "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 communityfortinet.fortimanager.fmgr_system_log_settings_rollinglocal (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
This 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: Log rolling policy for local logs. fortinet.fortimanager.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: <string> file_size: <integer> gzip_format: <value in [disable, enable]> hour: <integer> ip: <string> ip2: <string> ip3: <string> log_format: <value in [native, text, csv]> min: <integer> password: <list or string> password2: <list or string> password3: <list or string> server_type: <value in [ftp, sftp, scp]> upload: <value in [disable, enable]> upload_hour: <integer> upload_mode: <value in [backup, mirror]> upload_trigger: <value in [on-roll, on-schedule]> username: <string> username2: <string> username3: <string> when: <value in [none, daily, weekly]> port: <integer> port2: <integer> port3: <integer> rolling_upgrade_status: <integer> server: <string> server2: <string> server3: <string>
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_log_settings_rollinglocal: description: The top level parameters set. required: false suboptions: days: choices: - sun - mon - tue - wed - thu - fri - sat description: - Log files rolling schedule - sun - Sunday. - mon - Monday. - tue - Tuesday. - wed - Wednesday. - thu - Thursday. - fri - Friday. - sat - Saturday. elements: str type: list del-files: choices: - disable - enable description: - Deprecated, please rename it to del_files. - Enable/disable log file deletion after uploading. - disable - Disable log file deletion. - enable - Enable log file deletion. type: str directory: description: Upload server directory, for Unix server, use absolute type: str file-size: description: Deprecated, please rename it to file_size. Roll log files when they reach this size type: int gzip-format: choices: - disable - enable description: - Deprecated, please rename it to gzip_format. - Enable/disable compression of uploaded log files. - disable - Disable compression. - enable - Enable compression. type: str hour: description: Log files rolling schedule type: int ip: description: Upload server IP address. type: str ip2: description: Upload server IP2 address. type: str ip3: description: Upload server IP3 address. type: str log-format: choices: - native - text - csv description: - Deprecated, please rename it to log_format. - Format of uploaded log files. - native - Native format - text - Text format - csv - CSV type: str min: description: Log files rolling schedule type: int password: description: (list) Upload server login password. type: raw password2: description: (list) Upload server login password2. type: raw password3: description: (list) Upload server login password3. type: raw port: description: Upload server IP1 port number. type: int port2: description: Upload server IP2 port number. type: int port3: description: Upload server IP3 port number. type: int rolling-upgrade-status: description: Deprecated, please rename it to rolling_upgrade_status. Rolling upgrade status type: int server: description: Upload server FQDN/IP. type: str server-type: choices: - ftp - sftp - scp description: - Deprecated, please rename it to server_type. - Upload server type. - ftp - Upload via FTP. - sftp - Upload via SFTP. - scp - Upload via SCP. type: str server2: description: Upload server2 FQDN/IP. type: str server3: description: Upload server3 FQDN/IP. type: str upload: choices: - disable - enable description: - Enable/disable log file uploads. - disable - Disable log files uploading. - enable - Enable log files uploading. type: str upload-hour: description: Deprecated, please rename it to upload_hour. Log files upload schedule type: int upload-mode: choices: - backup - mirror description: - Deprecated, please rename it to upload_mode. - Upload mode with multiple servers. - backup - Servers are attempted and used one after the other upon failure to connect. - mirror - All configured servers are attempted and used. type: str upload-trigger: choices: - on-roll - on-schedule description: - Deprecated, please rename it to upload_trigger. - Event triggering log files upload. - on-roll - Upload log files after they are rolled. - on-schedule - Upload log files daily. type: str username: description: Upload server login username. type: str username2: description: Upload server login username2. type: str username3: description: Upload server login username3. type: str when: choices: - none - daily - weekly description: - Roll log files periodically. - none - Do not roll log files periodically. - daily - Roll log files daily. - weekly - Roll log files on certain days of week. 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