Zabbix Integration Guide¶
Introduction¶
This documentation provides a step-by-step guide to integrating Zabbix with the Redborder Web Platform. By following these instructions, you will be able to make POST requests to the Zabbix API to create and manage items within Zabbix from the Redborder platform. Zabbix will enrich the assets information by adding additional data.
Integration Version
This integration works with Zabbix version 6.4.14.
API Endpoint Example¶
Here is an example of the API endpoint for the integration:
http://<zabbix-server-ip>/zabbix/api_jsonrpc.php
Parameters¶
To integrate Zabbix, this parameters are required to know for the configuration:
Parameter | Description |
---|---|
Zabbix Endpoint | The Endpoint address of your Zabbix instance. |
Zabbix Username | The username for accessing the Zabbix API. |
Zabbix Password | The password for the specified username. |
Zabbix Token | Token used to access the Zabbix API. |
Note
The Zabbix Username
and Zabbix Password
are the credentials used to log in to the Zabbix web interface.
Important
Ensure that the user has appropriate permissions and has also created a Zabbix Token
with the necessary permissions to access the Zabbix API. (Search how to generate API token in official Zabbix documentation).
Configuring Redborder Web UI to Use the Zabbix API¶
To configure Zabbix in Redborder Web, follow these steps:
- Navigate to
Tools -> Integrations
. - Click on the card titled "Zabbix API Integration" (click the "Start" button).
- Fill in all required fields.
- Click the "Update" button to apply the changes.
About period configuration
Zabbix integration is designed to be executed periodically. Once the worker is started, it will run periodically. However, on the start of the worker, the process will be executed immediately.
Asset Enrichment¶
To enrich assets with data from Zabbix, follow these steps:
- Once the Zabbix parameters are entered, go to the section
Tools -> Worker & Job Queue
. - A new task, "Zabbix Inventory", will now be available. This task will only be visible if the Zabbix parameters are set.
- When executing this task, the values of the IP/MAC addresses in the objects will be modified according to the information from Zabbix. That is, if an IP/MAC value has a different name or object type, it will be updated based on the information from Zabbix.
Results¶
If the jobs have finished correctly, the assets will be enriched with the information from Zabbix. You can notice the improvement in Tools/Objects menu and in any module that uses the following fields: - LAN IP - WAN IP - Client MAC - ...or even related that object types.