Fortinet white logo
Fortinet white logo

Administration Guide

Importing and exporting event handlers

Importing and exporting event handlers

You can import and export event handlers. This feature allows you to develop custom event handlers and deploy them in bulk to other ADOMs or FortiAnalyzer units. To do so, export the custom event handlers, and then import them into the ADOMs or FortiAnalyzer units where you want them deployed. You can also export event handlers as part of your backup procedure, if needed.

To export event handlers:
  1. Go to Incidents & Events > Handlers > Basic Handlers.

    If exporting a correlation handler, go to Incidents & Events > Handlers > Correlation Handlers.

  2. Select the event handler(s) to export, and click More > Export.

    You can also right-click the event handler and select Export.

    Screenshot displayinig Incidents & Events export

  3. Enable Include Data Selectors, if needed.
  4. Enable Include Notification Profiles, if needed.
  5. In the Select Export Data Type field, select Zipped, Text, or CLI.

    If the data type is Zipped or Text, it will be saved as a JSON file. If the data type is CLI, it will be saved as CONF file.

  6. Click OK to save the export file.

To import handlers:
  1. Go to Incidents & Events > Handlers > Basic Handlers.

    If importing a correlation handler, go to Incidents & Events > Handlers > Correlation Handlers.

  2. Click More > Import.

    The Import Event Handler dialog displays.

  3. Drag and drop the exported event handler JSON or CONF file into the import dialog, or click Browse to locate the file on the management computer.

    You can import multiple event handlers at a time.

  4. Click OK to import the event handler(s).
Note

If the imported event handler's name already exists, you will be asked if you want to Rename, Replace, or Skip.

If you select Rename, the Unix epoch timestamp will be automatically appended to the imported event handler's name. For example, App Ctrl Event‘1544644459276775. The name can be edited as required after importing.

Note

If the imported file is the wrong format or has an error, the system will report an error.

Importing and exporting event handlers

Importing and exporting event handlers

You can import and export event handlers. This feature allows you to develop custom event handlers and deploy them in bulk to other ADOMs or FortiAnalyzer units. To do so, export the custom event handlers, and then import them into the ADOMs or FortiAnalyzer units where you want them deployed. You can also export event handlers as part of your backup procedure, if needed.

To export event handlers:
  1. Go to Incidents & Events > Handlers > Basic Handlers.

    If exporting a correlation handler, go to Incidents & Events > Handlers > Correlation Handlers.

  2. Select the event handler(s) to export, and click More > Export.

    You can also right-click the event handler and select Export.

    Screenshot displayinig Incidents & Events export

  3. Enable Include Data Selectors, if needed.
  4. Enable Include Notification Profiles, if needed.
  5. In the Select Export Data Type field, select Zipped, Text, or CLI.

    If the data type is Zipped or Text, it will be saved as a JSON file. If the data type is CLI, it will be saved as CONF file.

  6. Click OK to save the export file.

To import handlers:
  1. Go to Incidents & Events > Handlers > Basic Handlers.

    If importing a correlation handler, go to Incidents & Events > Handlers > Correlation Handlers.

  2. Click More > Import.

    The Import Event Handler dialog displays.

  3. Drag and drop the exported event handler JSON or CONF file into the import dialog, or click Browse to locate the file on the management computer.

    You can import multiple event handlers at a time.

  4. Click OK to import the event handler(s).
Note

If the imported event handler's name already exists, you will be asked if you want to Rename, Replace, or Skip.

If you select Rename, the Unix epoch timestamp will be automatically appended to the imported event handler's name. For example, App Ctrl Event‘1544644459276775. The name can be edited as required after importing.

Note

If the imported file is the wrong format or has an error, the system will report an error.