fortiswitch_log_memory_filter – Filters for memory buffer 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_memory feature and filter 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_memory_filter 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_memory_filter - Filters for memory buffer. type: dict
    • admin - Whether to log admin login/logout messages. type: str choices: enable, disable
    • auth - Whether to log firewall authentication messages. type: str choices: enable, disable
    • cpu_memory_usage - Whether to log CPU & memory usage every 5 minutes. type: str choices: enable, disable
    • dhcp - Whether to log DHCP service messages. type: str choices: enable, disable
    • event - Enable/disable logging of event messages. type: str choices: enable, disable
    • ha - Whether to log HA activity messages. type: str choices: enable, disable
    • override - Override FortiAnalyzer setting or use the global setting. type: str
    • pattern - Whether to log pattern update messages. type: str choices: enable, disable
    • severity - The least severity level to log. type: str choices: emergency, alert, critical, error, warning, notification, information, debug
    • system - Enable/disable logging of system activity messages. type: str choices: enable, disable
    • wireless_activity - Whether to log wireless activity. type: str choices: enable, disable

Examples

- name: Filters for memory buffer.
  fortinet.fortiswitch.fortiswitch_log_memory_filter:
      log_memory_filter:
          admin: "enable"
          auth: "enable"
          cpu_memory_usage: "enable"
          dhcp: "enable"
          event: "enable"
          ha: "enable"
          override: "<your_own_value>"
          pattern: "enable"
          severity: "emergency"
          system: "enable"
          wireless_activity: "enable"

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.