fortiswitch_log_disk_setting – Settings for local disk logging in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify log_disk feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_log_disk_setting yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • log_disk_setting - Settings for local disk logging. type: dict
    • diskfull - Policy to apply when disk is full. type: str choices: overwrite, nolog
    • drive_standby_time - Power management timeout(0-19800 sec)(0 disable). type: int
    • full_final_warning_threshold - Log full final warning threshold(3-100), the default is 95. type: int
    • full_first_warning_threshold - Log full first warning threshold(1-98), the default is 75. type: int
    • full_second_warning_threshold - Log full second warning threshold(2-99), the default is 90. type: int
    • log_quota - Disk log quota. type: int
    • max_log_file_size - Max log file size in MB before rolling (may not be accurate all the time). type: int
    • report_quota - Report quota. type: int
    • roll_day - Days of week to roll logs. type: str choices: sunday, monday, tuesday, wednesday, thursday, friday, saturday
    • roll_schedule - Frequency to check log file for rolling. type: str choices: daily, weekly
    • roll_time - Time to roll logs [hh:mm]. type: str
    • source_ip - Source IP address of the disk log uploading. type: str
    • status - Enable/disable local disk log. type: str choices: enable, disable
    • upload - Whether to upload the log file when rolling. type: str choices: enable, disable
    • upload_delete_files - Delete log files after uploading . type: str choices: enable, disable
    • upload_destination - Server type. type: str choices: ftp-server
    • upload_format - Upload compact/text logs. type: str choices: compact, text
    • upload_ssl_conn - Enable/disable SSL communication when uploading. type: str choices: default, high, low, disable
    • uploaddir - Log file uploading remote directory. type: str
    • uploadip - IP address of the log uploading server. type: str
    • uploadpass - Password of the user account in the uploading server. type: str
    • uploadport - Port of the log uploading server. type: int
    • uploadsched - Scheduled upload (disable=upload when rolling). type: str choices: disable, enable
    • uploadtime - Time of scheduled upload. type: int
    • uploadtype - Types of log files that need to be uploaded. type: str choices: traffic, event, virus, webfilter, attack, spamfilter, dlp-archive, dlp, app-ctrl
    • uploaduser - User account in the uploading server. type: str
    • uploadzip - Compress upload logs. type: str choices: disable, enable

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Settings for local disk logging.
    fortiswitch_log_disk_setting:
      log_disk_setting:
        diskfull: "overwrite"
        drive_standby_time: "4"
        full_final_warning_threshold: "5"
        full_first_warning_threshold: "6"
        full_second_warning_threshold: "7"
        log_quota: "8"
        max_log_file_size: "9"
        report_quota: "10"
        roll_day: "sunday"
        roll_schedule: "daily"
        roll_time: "<your_own_value>"
        source_ip: "84.230.14.43"
        status: "enable"
        upload: "enable"
        upload_delete_files: "enable"
        upload_destination: "ftp-server"
        upload_format: "compact"
        upload_ssl_conn: "default"
        uploaddir: "<your_own_value>"
        uploadip: "<your_own_value>"
        uploadpass: "<your_own_value>"
        uploadport: "24"
        uploadsched: "disable"
        uploadtime: "26"
        uploadtype: "traffic"
        uploaduser: "<your_own_value>"
        uploadzip: "disable"

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:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

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