Skip to content

Latest commit

 

History

History
122 lines (84 loc) · 5.82 KB

fortiswitch_log_fortiguard_setting.rst

File metadata and controls

122 lines (84 loc) · 5.82 KB
Raw
source:fortiswitch_log_fortiguard_setting.py
orphan:

fortiswitch_log_fortiguard_setting -- Settings for FortiGuard Analysis Service in Fortinet's FortiSwitch

.. versionadded:: 1.0.0

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify log_fortiguard 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.14

FortiSW Version Compatibility


Supported Version Ranges
fortiswitch_log_fortiguard_setting v7.0.0 -> latest

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_fortiguard_setting - Settings for FortiGuard Analysis Service. type: dict
    • enc_algorithm - Whether to send FortiAnalyzer log data with SSL encryption. type: str choices: default, high, low, disable
    • status - Whether to enable FortiGuard Analysis Service. type: str choices: enable, disable
    • upload_day - Days of week to roll logs. type: str
    • upload_interval - Frequency to check log file for upload. type: str choices: daily, weekly, monthly
    • upload_time - Time to roll logs [hh:mm]. type: str

Examples

- name: Settings for FortiGuard Analysis Service.
  fortinet.fortiswitch.fortiswitch_log_fortiguard_setting:
      log_fortiguard_setting:
          enc_algorithm: "default"
          status: "enable"
          upload_day: "<your_own_value>"
          upload_interval: "daily"
          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.