fortiswitch_log_fortianalyzer2_setting – Setting for FortiAnalyzer 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_fortianalyzer2 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_fortianalyzer2_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_fortianalyzer2_setting - Setting for FortiAnalyzer. type: dict
    • __change_ip - Hidden attribute. type: int
    • address_mode - FortiAnalyzer IP addressing mode. type: str choices: static, auto-discovery
    • buffer_max_send - Maximum log transmission rate for buffered logs. type: int
    • conn_timeout - FortiAnalyzer connection time-out in seconds (for status and log buffer). type: int
    • enc_algorithm - Whether to send FortiAnalyzer log data with SSL encryption. type: str choices: default, high, low, disable
    • encrypt - Whether to send FortiAnalyzer log data in IPsec tunnel. type: str choices: disable, enable
    • fdp_device - Serial number of FortiAnalyzer to connect to. type: str
    • fdp_interface - Interface for FortiAnalyzer auto-discovery. Source system.interface.name. type: str
    • hmac_algorithm - FortiAnalyzer IPsec tunnel HMAC algorithm. type: str choices: sha256, sha1
    • ips_archive - Whether to enable IPS packet archive. type: str choices: enable, disable
    • localid - Local id for IPsec tunnel to FortiAnalyzer. type: str
    • max_buffer_size - Maximum buffer size, in MBytes, 0--1024, 0=disabled. type: int
    • mgmt_name - Hidden management name of FortiAnalyzer. type: str
    • override - Override FortiAnalyzer settings or use the global settings. type: str
    • psksecret - Pre-shared key for IPsec tunnel to FortiAnalyzer. type: str
    • server - IP address of the remote FortiAnalyzer. type: str
    • source_ip - Source IP address of the FortiAnalyzer. type: str
    • status - Enable/disable FortiAnalyzer. type: str choices: enable, disable
    • upload_day - Days of week(month) to upload logs. type: str
    • upload_interval - Frequency to check log file for upload. type: str choices: daily, weekly, monthly
    • upload_option - Enable/disable logging to hard disk and then upload to FortiAnalyzer. type: str choices: store-and-upload, realtime
    • upload_time - Time to upload logs [hh:mm]. type: str

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: Setting for FortiAnalyzer.
    fortiswitch_log_fortianalyzer2_setting:
      log_fortianalyzer2_setting:
        __change_ip: "3"
        address_mode: "static"
        buffer_max_send: "5"
        conn_timeout: "6"
        enc_algorithm: "default"
        encrypt: "disable"
        fdp_device: "<your_own_value>"
        fdp_interface: "<your_own_value> (source system.interface.name)"
        hmac_algorithm: "sha256"
        ips_archive: "enable"
        localid: "<your_own_value>"
        max_buffer_size: "14"
        mgmt_name: "<your_own_value>"
        override: "<your_own_value>"
        psksecret: "<your_own_value>"
        server: "192.168.100.40"
        source_ip: "84.230.14.43"
        status: "enable"
        upload_day: "<your_own_value>"
        upload_interval: "daily"
        upload_option: "store-and-upload"
        upload_time: "<your_own_value>"

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.