:source: fortiswitch_log_fortianalyzer2_setting.py

:orphan:

.. fortiswitch_log_fortianalyzer2_setting:

fortiswitch_log_fortianalyzer2_setting -- Setting for FortiAnalyzer in Fortinet's FortiSwitch
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.0

.. contents::
   :local:
   :depth: 1


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.16


FortiSwitch Version Compatibility
---------------------------------


.. raw:: html

 <br>
 <table border="1">
 <tr>
 <td></td><td colspan="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>fortiswitch_log_fortianalyzer2_setting</td>
 <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td>
 </tr>
 </table>
 <p>



Parameters
----------


.. raw:: html

    <ul>
    <li> <span class="li-head">enable_log</span> - Enable/Disable logging for task. <span class="li-normal">type: bool</span> <span class="li-required">required: false</span> <span class="li-normal">default: False</span> </li>
    <li> <span class="li-head">member_path</span> - Member attribute path to operate on. <span class="li-normal">type: str</span> </li>
    <li> <span class="li-head">member_state</span> - Add or delete a member under specified attribute path. <span class="li-normal">type: str</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">log_fortianalyzer2_setting</span> - Setting for FortiAnalyzer. <span class="li-normal">type: dict</span> </li>
        <ul class="ul-self">
        <li> <span class="li-head">__change_ip</span> - Hidden attribute. <span class="li-normal">type: int</span> </li>
        <li> <span class="li-head">address_mode</span> - FortiAnalyzer IP addressing mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: static, auto-discovery</span> </li>
        <li> <span class="li-head">buffer_max_send</span> - Maximum log transmission rate for buffered logs. <span class="li-normal">type: int</span> </li>
        <li> <span class="li-head">conn_timeout</span> - FortiAnalyzer connection time-out in seconds (for status and log buffer). <span class="li-normal">type: int</span> </li>
        <li> <span class="li-head">enc_algorithm</span> - Whether to send FortiAnalyzer log data with SSL encryption. <span class="li-normal">type: str</span> <span class="li-normal">choices: default, high, low, disable</span> </li>
        <li> <span class="li-head">encrypt</span> - Whether to send FortiAnalyzer log data in IPsec tunnel. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</span> </li>
        <li> <span class="li-head">fdp_device</span> - Serial number of FortiAnalyzer to connect to. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">fdp_interface</span> - Interface for FortiAnalyzer auto-discovery. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">hmac_algorithm</span> - FortiAnalyzer IPsec tunnel HMAC algorithm. <span class="li-normal">type: str</span> <span class="li-normal">choices: sha256, sha1</span> </li>
        <li> <span class="li-head">ips_archive</span> - Whether to enable IPS packet archive. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> </li>
        <li> <span class="li-head">localid</span> - Local id for IPsec tunnel to FortiAnalyzer. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">max_buffer_size</span> - Maximum buffer size, in MBytes, 0--1024, 0=disabled. <span class="li-normal">type: int</span> </li>
        <li> <span class="li-head">mgmt_name</span> - Hidden management name of FortiAnalyzer. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">override</span> - Override FortiAnalyzer settings or use the global settings. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">psksecret</span> - Pre-shared key for IPsec tunnel to FortiAnalyzer. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">server</span> - IP address of the remote FortiAnalyzer. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">source_ip</span> - Source IP address of the FortiAnalyzer. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">status</span> - Enable/disable FortiAnalyzer. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> </li>
        <li> <span class="li-head">upload_day</span> - Days of week(month) to upload logs. <span class="li-normal">type: str</span> </li>
        <li> <span class="li-head">upload_interval</span> - Frequency to check log file for upload. <span class="li-normal">type: str</span> <span class="li-normal">choices: daily, weekly, monthly</span> </li>
        <li> <span class="li-head">upload_option</span> - Enable/disable logging to hard disk and then upload to FortiAnalyzer. <span class="li-normal">type: str</span> <span class="li-normal">choices: store-and-upload, realtime</span> </li>
        <li> <span class="li-head">upload_time</span> - Time to upload logs [hh:mm]. <span class="li-normal">type: str</span> </li>
        </ul>
    </ul>


Examples
--------

.. code-block:: yaml+jinja
    
    - name: Setting for FortiAnalyzer.
      fortinet.fortiswitch.fortiswitch_log_fortianalyzer2_setting:
          log_fortianalyzer2_setting:
              __change_ip: "3"
              address_mode: "static"
              buffer_max_send: "10000"
              conn_timeout: "1073741823"
              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: "512"
              mgmt_name: "<your_own_value>"
              override: "<your_own_value>"
              psksecret: "<your_own_value>"
              server: "192.168.100.40"
              source_ip: "<your_own_value>"
              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:

.. raw:: html

    <ul>

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

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, feel free to create a pull request to improve it.