drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_system_log_settings Log settings. | "added in version" 2.0.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_system_log_settings (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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 settings. fmgr_system_log_settings: 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: FAC-custom-field1: <value of string> FAZ-custom-field1: <value of string> FCH-custom-field1: <value of string> FCT-custom-field1: <value of string> FDD-custom-field1: <value of string> FGT-custom-field1: <value of string> FMG-custom-field1: <value of string> FML-custom-field1: <value of string> FPX-custom-field1: <value of string> FSA-custom-field1: <value of string> FWB-custom-field1: <value of string> browse-max-logfiles: <value of integer> dns-resolve-dstip: <value in [disable, enable]> download-max-logs: <value of integer> ha-auto-migrate: <value in [disable, enable]> import-max-logfiles: <value of integer> log-file-archive-name: <value in [basic, extended]> rolling-analyzer: 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]> port: <value of integer> port2: <value of integer> port3: <value of integer> rolling-upgrade-status: <value of integer> server: <value of string> server2: <value of string> server3: <value of string> rolling-local: 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]> port: <value of integer> port2: <value of integer> port3: <value of integer> rolling-upgrade-status: <value of integer> server: <value of string> server2: <value of string> server3: <value of string> rolling-regular: 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]> port: <value of integer> port2: <value of integer> port3: <value of integer> rolling-upgrade-status: <value of integer> server: <value of string> server2: <value of string> server3: <value of string> sync-search-timeout: <value of integer> keep-dev-logs: <value in [disable, enable]>
rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false 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. required: false type: bool system_log_settings: description: the top level parameters set required: false suboptions: FAC-custom-field1: description: Name of custom log field to index. type: str FAZ-custom-field1: description: Name of custom log field to index. type: str FCH-custom-field1: description: Name of custom log field to index. type: str FCT-custom-field1: description: Name of custom log field to index. type: str FDD-custom-field1: description: Name of custom log field to index. type: str FGT-custom-field1: description: Name of custom log field to index. type: str FMG-custom-field1: description: Name of custom log field to index. type: str FML-custom-field1: description: Name of custom log field to index. type: str FPX-custom-field1: description: Name of custom log field to index. type: str FSA-custom-field1: description: Name of custom log field to index. type: str FWB-custom-field1: description: Name of custom log field to index. type: str browse-max-logfiles: description: Maximum number of log files for each log browse attempt for each Adom. type: int dns-resolve-dstip: choices: - disable - enable description: - Enable/Disable resolving destination IP by DNS. - disable - Disable resolving destination IP by DNS. - enable - Enable resolving destination IP by DNS. type: str download-max-logs: description: Maximum number of logs for each log download attempt. type: int ha-auto-migrate: choices: - disable - enable description: - Enabled/Disable automatically merging HA members logs to HA cluster. - disable - Disable automatically merging HA members logs to HA cluster. - enable - Enable automatically merging HA members logs to HA cluster. type: str import-max-logfiles: description: Maximum number of log files for each log import attempt. type: int keep-dev-logs: choices: - disable - enable description: - Enable/Disable keeping the dev logs after the device has been deleted. - disable - Disable keeping the dev logs after the device has been deleted. - enable - Enable keeping the dev logs after the device has been deleted. type: str log-file-archive-name: choices: - basic - extended description: - Log file name format for archiving, such as backup, upload or download. - basic - Basic format for log archive file name, e. - extended - Extended format for log archive file name, e. type: str rolling-analyzer: description: no description required: false suboptions: days: choices: - sun - mon - tue - wed - thu - fri - sat description: Log files rolling schedule elements: str type: list del-files: choices: - disable - enable description: - 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: Roll log files when they reach this size type: int gzip-format: choices: - disable - enable description: - 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: - 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: Upload server login password. type: str password2: description: Upload server login password2. type: str password3: description: Upload server login password3. type: str 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: rolling upgrade status type: int server: description: Upload server FQDN/IP. type: str server-type: choices: - ftp - sftp - scp description: - 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: Log files upload schedule type: int upload-mode: choices: - backup - mirror description: - 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: - 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 rolling-local: description: no description required: false suboptions: days: choices: - sun - mon - tue - wed - thu - fri - sat description: Log files rolling schedule elements: str type: list del-files: choices: - disable - enable description: - 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: Roll log files when they reach this size type: int gzip-format: choices: - disable - enable description: - 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: - 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: Upload server login password. type: str password2: description: Upload server login password2. type: str password3: description: Upload server login password3. type: str 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: rolling upgrade status type: int server: description: Upload server FQDN/IP. type: str server-type: choices: - ftp - sftp - scp description: - 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: Log files upload schedule type: int upload-mode: choices: - backup - mirror description: - 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: - 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 rolling-regular: description: no description required: false suboptions: days: choices: - sun - mon - tue - wed - thu - fri - sat description: Log files rolling schedule elements: str type: list del-files: choices: - disable - enable description: - 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: Roll log files when they reach this size type: int gzip-format: choices: - disable - enable description: - 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: - 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: Upload server login password. type: str password2: description: Upload server login password2. type: str password3: description: Upload server login password3. type: str 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: rolling upgrade status type: int server: description: Upload server FQDN/IP. type: str server-type: choices: - ftp - sftp - scp description: - 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: Log files upload schedule type: int upload-mode: choices: - backup - mirror description: - 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: - 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 sync-search-timeout: description: Maximum number of seconds for running a log search session in synchronous mode. type: int type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
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