fortinet.fortimanager.fmgr_system_locallog_disk_setting – Settings for local disk logging.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_locallog_disk_setting.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

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.

Parameters

Parameter		Choices/Defaults	Comments
bypass_validation boolean		no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		present absent	the directive to create, update or delete an object
system_locallog_disk_setting dictionary			the top level parameters set
	diskfull string	overwrite ← nolog	Policy to apply when disk is full. overwrite - Overwrite oldest log when disk is full. nolog - Stop logging when disk is full.
	log-disk-full-percentage integer	Default: 80	Consider log disk as full at this usage percentage.
	max-log-file-size integer	Default: 100	Maximum log file size before rolling.
	roll-day list / elements=string	sunday monday tuesday wednesday thursday friday saturday	no description
	roll-schedule string	none ← daily weekly	Frequency to check log file for rolling. none - Not scheduled. daily - Every day. weekly - Every week.
	roll-time string		no description
	server-type string	FTP ← SFTP SCP	Server type. FTP - Upload via FTP. SFTP - Upload via SFTP. SCP - Upload via SCP.
	severity string	emergency alert critical error warning notification information ← debug	Least severity level to log. emergency - Emergency level. alert - Alert level. critical - Critical level. error - Error level. warning - Warning level. notification - Notification level. information - Information level. debug - Debug level.
	status string	disable enable ←	Enable/disable local disk log. disable - Do not log to local disk. enable - Log to local disk.
	upload string	disable ← enable	Upload log file when rolling. disable - Disable uploading when rolling log file. enable - Enable uploading when rolling log file.
	upload-delete-files string	disable enable ←	Delete log files after uploading (default = enable). disable - Do not delete log files after uploading. enable - Delete log files after uploading.
	upload-time string		no description
	uploaddir string		Log file upload remote directory.
	uploadip string	Default: "0.0.0.0"	IP address of log uploading server.
	uploadpass string		no description
	uploadport integer	Default: 0	Server port (0 = default protocol port).
	uploadsched string	disable ← enable	Scheduled upload (disable = upload when rolling). disable - Upload when rolling. enable - Scheduled upload.
	uploadtype list / elements=string	event	no description
	uploaduser string		User account in upload server.
	uploadzip string	disable ← enable	Compress upload logs. disable - Upload log files as plain text. enable - Upload log files compressed.
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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 here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_locallog_disk_setting_module.html