Skip to main content

Zabbix API Python interface

Project description

PyZabbix

PyZabbix is a Python module for working with the Zabbix API.

Build Status PyPi version

Requirements

  • Tested against Zabbix 1.8 through 5.0

Documentation

Getting Started

Install PyZabbix using pip:

$ pip install pyzabbix

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")
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.

This is useful for:

  • 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")

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:

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')

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
}
>>>

License

LGPL 2.1 http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyzabbix-0.8.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distributions

pyzabbix-0.8.1-py2.py3-none-any.whl (5.4 kB view details)

Uploaded Python 2Python 3

pyzabbix-0.8.1-py2-none-any.whl (5.4 kB view details)

Uploaded Python 2

File details

Details for the file pyzabbix-0.8.1.tar.gz.

File metadata

  • Download URL: pyzabbix-0.8.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/2.7.15

File hashes

Hashes for pyzabbix-0.8.1.tar.gz
Algorithm Hash digest
SHA256 e9bb9f4e0ca3d24802ecb893b26f2ccae0359536734f8c6b37ef0964997585e3
MD5 d7d35b3d3b544e73b1e787c68138632b
BLAKE2b-256 c6a804ce6560f3e41151c8dd3a1e40d3b41e0f09ac0401a38be70e8d74474d29

See more details on using hashes here.

File details

Details for the file pyzabbix-0.8.1-py2.py3-none-any.whl.

File metadata

  • Download URL: pyzabbix-0.8.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/2.7.15

File hashes

Hashes for pyzabbix-0.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 212f8aabb827ac9778cc85c599d8d323c7765b93a7f3dc5848aaed8bb3a4e349
MD5 6bace198b95477e93b1464576e539ab9
BLAKE2b-256 f3c64d38390ca4844c67821a172e2fad9203a6c1dfa93623b8b5e710c34be473

See more details on using hashes here.

File details

Details for the file pyzabbix-0.8.1-py2-none-any.whl.

File metadata

  • Download URL: pyzabbix-0.8.1-py2-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/44.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/2.7.15

File hashes

Hashes for pyzabbix-0.8.1-py2-none-any.whl
Algorithm Hash digest
SHA256 afb09a4ebf5afa8f911a85d1f1f5cd884b4babf602d039f76235770ac22d523d
MD5 5cad13a0de0c63f76531ff015e2b1861
BLAKE2b-256 74458772fe942cf104be931b4dabe3b08e5e658dcf539250352c06348d665a45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page