faz_cli_system_locallog_disk_setting – Settings for local disk logging.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiAnalyzer device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiAnalyzer Version Compatibility


6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
cli_system_locallog_disk_setting yes yes yes yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
  • 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
  • cli_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 more...
    • log-disk-full-percentage - Consider log disk as full at this usage percentage. type: int default: 80 more...
    • max-log-file-size - Maximum log file size before rolling. type: int default: 100 more...
    • roll-day - No description for the parameter type: array choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
    • roll-schedule - Frequency to check log file for rolling. type: str choices: [none, daily, weekly] default: none more...
    • roll-time - Time to roll logs (hh:mm). type: str more...
    • server-type - Server type. type: str choices: [FTP, SFTP, SCP] default: FTP more...
    • severity - Least severity level to log. type: str choices: [emergency, alert, critical, error, warning, notification, information, debug] default: information more...
    • status - Enable/disable local disk log. type: str choices: [disable, enable] default: enable more...
    • upload - Upload log file when rolling. type: str choices: [disable, enable] default: disable more...
    • upload-delete-files - Delete log files after uploading (default = enable). type: str choices: [disable, enable] default: enable more...
    • upload-time - Time to upload logs (hh:mm). type: str more...
    • uploaddir - Log file upload remote directory. type: str more...
    • uploadip - IP address of log uploading server. type: str default: 0.0.0.0 more...
    • uploadpass - No description for the parameter type: str more...
    • uploadport - Server port (0 = default protocol port). type: int default: 0 more...
    • uploadsched - Scheduled upload (disable = upload when rolling). type: str choices: [disable, enable] default: disable more...
    • uploadtype - No description for the parameter type: array choices: [event] more...
    • uploaduser - User account in upload server. type: str more...
    • uploadzip - Compress upload logs. type: str choices: [disable, enable] default: disable more...
    • log-disk-quota - Quota for controlling local log size. type: int default: 1 more...
    • max-log-file-num - Maximum number of log files before rolling. type: int default: 10000 more...

Notes

Note

  • 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

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_system_locallog_disk_setting:
      cli_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: disable
        upload: disable
        upload-delete-files: disable
        #upload-time: <value of string>
        #uploaddir: <value of string>
        #uploadip: <value of string>
        #uploadpass: <value of string>
        #uploadport: <value of integer>
        uploadsched: disable
        uploadtype:
        - event
        #uploaduser: <value of string>
        uploadzip: disable
    name: Settings for local disk logging.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.