Zabbix utils library
zabbix_utils is a Python library for working with Zabbix API as well as with Zabbix sender and Zabbix get protocols.
Get started
Requirements
Supported versions:
- Zabbix 5.0+
- Python 3.8+
Tested on:
- Zabbix 5.0, 6.0, 6.4 and 7.0
- Python 3.8, 3.9, 3.10, 3.11 and 3.12
Dependencies:
- aiohttp (in case of async use)
Installation
Installation from PyPI
Install zabbix_utils library using pip:
$ pip install zabbix_utilsTo install the library with dependencies for asynchronous work use the following way:
$ pip install zabbix_utils[async]Installation from Zabbix repository
First of all, you need to install Zabbix repository. Official Zabbix packages for Red Hat Enterprise Linux and derivatives, as well as for Debian and derivatives are available on Zabbix website.
Red Hat Enterprise Linux and derivatives
Install zabbix_utils library from Zabbix repository:
# dnf install python3-zabbix-utilsTo install additional dependencies such as aiohttp for asynchronous work use the following way:
# dnf install epel-release
# dnf install python3-aiohttpDebian / Ubuntu and derivatives
Install zabbix_utils library from Zabbix repository:
# apt install python3-zabbix-utilsTo install additional dependencies such as aiohttp for asynchronous work use the following way:
# apt install python3-aiohttpInstallation from GitHub
Clone the zabbix_utils repository:
$ git clone https://github.com/zabbix/python-zabbix-utilsInstall zabbix_utils library using setup.py:
$ cd python-zabbix-utils/
$ python3 setup.py installTo install dependencies use one of the ways above.
Documentation
Use cases
To work with Zabbix API
To work with Zabbix API via synchronous I/O you can import and use zabbix_utils library as follows:
from zabbix_utils import ZabbixAPI
api = ZabbixAPI(url="127.0.0.1")
api.login(user="User", password="zabbix")
users = api.user.get(
output=['userid','name']
)
for user in users:
print(user['name'])
api.logout()To work with Zabbix API via asynchronous I/O you can use the following way:
import asyncio
from zabbix_utils import AsyncZabbixAPI
async def main():
api = AsyncZabbixAPI(url="127.0.0.1")
await api.login(user="User", password="zabbix")
users = await api.user.get(
output=['userid','name']
)
for user in users:
print(user['name'])
await api.logout()
asyncio.run(main())You can also authenticate using an API token (supported since Zabbix 5.4):
api = ZabbixAPI(url="127.0.0.1")
api.login(token="xxxxxxxx")api = AsyncZabbixAPI(url="127.0.0.1")
await api.login(token="xxxxxxxx")When token is used, calling api.logout() is not necessary.
It is possible to specify authentication fields by the following environment variables:
ZABBIX_URL, ZABBIX_TOKEN, ZABBIX_USER, ZABBIX_PASSWORD
You can compare Zabbix API version with strings and numbers, for example:
# Method to get version
ver = api.api_version()
print(type(ver).__name__, ver) # APIVersion 7.0.0
# ZabbixAPI prototype with version
ver = api.version
print(type(ver).__name__, ver) # APIVersion 7.0.0
# Comparing versions
print(ver > 6.0) # True
print(ver != 7.0) # False
print(ver != "7.0.0") # False
# Version additional methods
print(ver.major) # 7.0
print(ver.minor) # 0
print(ver.is_lts()) # TrueIn case the API object or method name matches one of Python keywords, you can use the suffix _ in their name to execute correctly, for example:
from zabbix_utils import ZabbixAPI
api = ZabbixAPI(url="127.0.0.1")
api.login(token="xxxxxxxx")
template_source = ''
with open('template_example.xml', mode='r', encoding='utf-8') as f:
template_source = f.read()
response = api.configuration.import_(
source=template_source,
format="xml",
rules={...}
)
if response:
print("Template imported successfully")Please, refer to the Zabbix API Documentation and the using examples for more information.
To work via Zabbix sender protocol
To send item values to a Zabbix server or a Zabbix proxy you can import and use the library as follows:
from zabbix_utils import Sender
sender = Sender(server='127.0.0.1', port=10051)
response = sender.send_value('host', 'item.key', 'value', 1695713666)
print(response)
# {"processed": 1, "failed": 0, "total": 1, "time": "0.000338", "chunk": 1}The asynchronous way:
import asyncio
from zabbix_utils import AsyncSender
async def main():
sender = AsyncSender(server='127.0.0.1', port=10051)
response = await sender.send_value('host', 'item.key', 'value', 1695713666)
print(response)
# {"processed": 1, "failed": 0, "total": 1, "time": "0.000338", "chunk": 1}
asyncio.run(main())You can also prepare a list of item values and send all at once:
from zabbix_utils import ItemValue, Sender
items = [
ItemValue('host1', 'item.key1', 10),
ItemValue('host1', 'item.key2', 'test message'),
ItemValue('host2', 'item.key1', -1, 1695713666),
ItemValue('host3', 'item.key1', '{"msg":"test message"}'),
ItemValue('host2', 'item.key1', 0, 1695713666, 100)
]
sender = Sender(server='127.0.0.1', port=10051)
response = sender.send(items)
print(response)
# {"processed": 5, "failed": 0, "total": 5, "time": "0.001661", "chunk": 1}If you need to send values to several Zabbix clusters at once, you can do this by passing a list of Zabbix clusters:
from zabbix_utils import Sender
zabbix_clusters = [
['zabbix.cluster1.node1', 'zabbix.cluster1.node2:10051'],
['zabbix.cluster2.node1:10051', 'zabbix.cluster2.node2:20051', 'zabbix.cluster2.node3']
]
sender = Sender(clusters=zabbix_clusters)
response = sender.send_value('host', 'item.key', 'value', 1695713666)
print(response)
# {"processed": 2, "failed": 0, "total": 2, "time": "0.000103", "chunk": 2}
print(response.details)
# {
# zabbix.cluster1.node1:10051: [{"processed": 1, "failed": 0, "total": 1, "time": "0.000050", "chunk": 1}],
# zabbix.cluster2.node2:20051: [{"processed": 1, "failed": 0, "total": 1, "time": "0.000053", "chunk": 1}]
# }In such case, the value will be sent to the first available node of each cluster.
Please, refer to the Zabbix sender protocol and the using examples for more information.
To work via Zabbix get protocol
To get a value by item key from a Zabbix agent or agent 2 via synchronous I/O the library can be imported and used as follows:
from zabbix_utils import Getter
agent = Getter(host='127.0.0.1', port=10050)
resp = agent.get('system.uname')
print(resp.value)
# Linux test_server 5.15.0-3.60.5.1.el9uek.x86_64The library can be used via asynchronous I/O, as in the following example:
import asyncio
from zabbix_utils import AsyncGetter
async def main():
agent = AsyncGetter(host='127.0.0.1', port=10050)
resp = await agent.get('system.uname')
print(resp.value)
# Linux test_server 5.15.0-3.60.5.1.el9uek.x86_64
asyncio.run(main())Please, refer to the Zabbix agent protocol and the using examples for more information.
Enabling debug log
If it needed to debug some issue with Zabbix API, sender or get you can enable the output of logging. The zabbix_utils library uses the default python logging module, but it doesn't log by default. You can define logging handler to see records from the library, for example:
import logging
from zabbix_utils import Getter
logging.basicConfig(
format=u'[%(asctime)s] %(levelname)s %(message)s',
level=logging.DEBUG
)
agent = Getter(host='127.0.0.1', port=10050)
resp = agent.get('system.uname')
print(resp.value)And then you can see records like the following:
[2023-10-01 12:00:01,587] DEBUG Content of the packet: b'ZBXD\x01\x0c\x00\x00\x00\x00\x00\x00\x00system.uname'
[2023-10-01 12:00:01,722] DEBUG Zabbix response header: b'ZBXD\x01C\x00\x00\x00C\x00\x00\x00'
[2023-10-01 12:00:01,723] DEBUG Zabbix response body: Linux test_server 5.15.0-3.60.5.1.el9uek.x86_64
[2023-10-01 12:00:01,724] DEBUG Response from [127.0.0.1:10050]: Linux test_server 5.15.0-3.60.5.1.el9uek.x86_64
Linux test_server 5.15.0-3.60.5.1.el9uek.x86_64
License
zabbix_utils is distributed under MIT License.