- Saved searches
- Use saved searches to filter your results more quickly
- lukecyca/pyzabbix
- Name already in use
- Sign In Required
- Launching GitHub Desktop
- Launching GitHub Desktop
- Launching Xcode
- Launching Visual Studio Code
- Latest commit
- Git stats
- Files
- README.md
- Zabbix API Python Example
- PyZabbix
- Requirements
- Documentation
- Getting Started
- Customizing the HTTP request
- Enabling debug logging
- Development
- Releases
- License
Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
lukecyca/pyzabbix
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.md
PyZabbix is a Python module for working with the Zabbix API.
Install PyZabbix using pip:
You can now import and use pyzabbix like so:
from pyzabbix import ZabbixAPI zapi = ZabbixAPI("http://zabbixserver.example.com") zapi.login("zabbix user", "zabbix pass") # You can also authenticate using an API token instead of user/pass with Zabbix >= 5.4 # zapi.login(api_token='xxxxx') print("Connected to Zabbix API Version %s" % zapi.api_version()) for h in zapi.host.get(output="extend"): print(h['hostid'])
Refer to the Zabbix API Documentation and the PyZabbix Examples for more information.
Customizing the HTTP request
PyZabbix uses the requests library for HTTP. You can customize the request parameters by configuring the requests Session object used by PyZabbix.
- Customizing headers
- Enabling HTTP authentication
- Enabling Keep-Alive
- Disabling SSL certificate verification
from pyzabbix import ZabbixAPI zapi = ZabbixAPI("http://zabbixserver.example.com") # Enable HTTP auth zapi.session.auth = ("http user", "http password") # Disable SSL certificate verification zapi.session.verify = False # Specify a timeout (in seconds) zapi.timeout = 5.1 # Login (in case of HTTP Auth, only the username is needed, the password, if passed, will be ignored) zapi.login("http user", "http password") # You can also authenticate using an API token instead of user/pass with Zabbix >= 5.4 # zapi.login(api_token='xxxxx')
If you need to debug some issue with the Zabbix API, you can enable the output of logging, pyzabbix already uses the default python logging facility but by default, it logs to «Null», you can change this behavior on your program, here’s an example:
import sys import logging from pyzabbix import ZabbixAPI stream = logging.StreamHandler(sys.stdout) stream.setLevel(logging.DEBUG) log = logging.getLogger('pyzabbix') log.addHandler(stream) log.setLevel(logging.DEBUG) zapi = ZabbixAPI("http://zabbixserver.example.com") zapi.login('admin','password') # You can also authenticate using an API token instead of user/pass with Zabbix >= 5.4 # zapi.login(api_token='xxxxx')
The expected output is as following:
Sending: < "params": < "password": "password", "user": "admin" >, "jsonrpc": "2.0", "method": "user.login", "id": 2 > Response Code: 200 Response Body: < "jsonrpc": "2.0", "result": ". ", "id": 2 >>>>
To develop this project, start by reading the Makefile to have a basic understanding of the possible tasks.
Install the project and the dependencies in a virtual environment:
make install source .venv/bin/activate
To release a new version, first bump the version number in setup.py by hand and run the release target:
Finally, push the release commit and tag to publish them to Pypi:
Zabbix API Python Library.
Original Ruby Library is Copyright (C) 2009 Andrew Nelson nelsonab(at)red-tux(dot)net
Original Python Library is Copyright (C) 2009 Brett Lentz brett.lentz(at)gmail(dot)com
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Zabbix API Python Example
This lesson was from a previous version of my course, which I’ve now made this video available to view for free.
An example of using the Zabbix API from a Python script.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
import requests import json ZABBIX_API_URL = "https://example.com/zabbix/api_jsonrpc.php" UNAME = "Admin" PWORD = "password" r = requests.post(ZABBIX_API_URL, json= "jsonrpc": "2.0", "method": "user.login", "params": "user": UNAME, "password": PWORD>, "id": 1 >) print(json.dumps(r.json(), indent=4, sort_keys=True)) AUTHTOKEN = r.json()["result"] # Retrieve a list of problems print("\nRetrieve a list of problems") r = requests.post(ZABBIX_API_URL, json= "jsonrpc": "2.0", "method": "problem.get", "params": "output": "extend", "selectAcknowledges": "extend", "recent": "true", "sortfield": ["eventid"], "sortorder": "DESC" >, "id": 2, "auth": AUTHTOKEN >) print(json.dumps(r.json(), indent=4, sort_keys=True)) #Logout user print("\nLogout user") r = requests.post(ZABBIX_API_URL, json= "jsonrpc": "2.0", "method": "user.logout", "params": <>, "id": 2, "auth": AUTHTOKEN >) print(json.dumps(r.json(), indent=4, sort_keys=True))
PyZabbix
PyZabbix is a Python module for working with the Zabbix API.
Requirements
Documentation
Getting Started
Install PyZabbix using pip:
You can now import and use pyzabbix like so:
= 5.4 Refer to the Zabbix API Documentation and the PyZabbix Examples for more information.
Customizing the HTTP request
PyZabbix uses the requests library for HTTP. You can customize the request parameters by configuring the requests Session object used by PyZabbix.
- Customizing headers
- Enabling HTTP authentication
- Enabling Keep-Alive
- Disabling SSL certificate verification
Enabling debug logging
If you need to debug some issue with the Zabbix API, you can enable the output of logging, pyzabbix already uses the default python logging facility but by default, it logs to «Null», you can change this behavior on your program, here’s an example:
The expected output is as following:
Sending: < "params": < "password": "password", "user": "admin" >, "jsonrpc": "2.0", "method": "user.login", "id": 2 > Response Code: 200 Response Body: < "jsonrpc": "2.0", "result": ". ", "id": 2 >>>>
Development
To develop this project, start by reading the Makefile to have a basic understanding of the possible tasks.
Install the project and the dependencies in a virtual environment:
make install .venv/bin/activate
Releases
To release a new version, first bump the version number in setup.py by hand and run the release target:
Finally, push the release commit and tag to publish them to Pypi:
License
Zabbix API Python Library.
Original Ruby Library is Copyright (C) 2009 Andrew Nelson nelsonab(at)red-tux(dot)net
Original Python Library is Copyright (C) 2009 Brett Lentz brett.lentz(at)gmail(dot)com
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA