Features¶

from zb.api import *

configure(user=YOUR_USER, password=YOUR_PASSWORD, url=YOUR_URL)
reponse = request('history.get', {
    'output': 'extend',
    'history': 0,
    'itemids': '23296',
    'sortfield': 'clock',
    'sortorder': 'DESC',
    'limit': 10
})

from zb.api import *
from zb.config.items.aggregate import AvgItem

configuration = Config()
template = configuration.templates.new('My template')
classic_item = template.items.new('my item', key='my.item', applications=['my application'])
average_item = template.items.add(AvgItem('my item',
                                          groups=['first group', 'second group'],
                                          key='my.item',
                                          applications=['my application']))

zbx.api¶

Access to zabbix api as described here: https://www.zabbix.com/documentation/2.2/manual/api

class zbx.api.Api(user, password, url, auth_token=None)[source]¶

Main api object

authenticate(reset=False)[source]¶

Authenticates to the api.

request(method, params=None, auth_token=None)[source]¶

Handle a request to the api.

It will authenticate automatically if auth_token was not provided

zbx.api.cast(data)[source]¶

Ensure that int are int etc...

zbx.api.authenticate = <bound method Api.authenticate of <zbx.api.Api object at 0x2152c10>>¶

authenticate with the global api instance

zbx.api.request = <bound method Api.request of <zbx.api.Api object at 0x2152c10>>¶

request with the global api instance

zbx.api.configure(**attrs)[source]¶

Configure the global api instance.

zbx.config¶

class zbx.config.Application(name, **fields)¶

Application model

class zbx.config.DiscoveryRule(name, **fields)¶

DiscoveryRule model

class zbx.config.Config[source]¶

Main config model

class zbx.config.Graph(name, **fields)¶

Graph model

class zbx.config.GraphItem(item=None, **fields)¶

GraphItem model

class zbx.config.Group(name, **fields)¶

Group model

class zbx.config.Host(name, **fields)¶

Host model

class zbx.config.Interface(ident, **fields)¶

Interface model

class zbx.config.Item(name, **fields)¶

Item model

class zbx.config.Macro(**fields)[source]¶

Macro model

class zbx.config.Screen(name, **fields)¶

Screen model

class zbx.config.ScreenItem(graph=None, **fields)¶

ScreenItem model

class zbx.config.Template(name, **fields)¶

Template model

class zbx.config.Trigger(name, **fields)[source]¶

Trigger model

class zbx.config.ValueMap¶

ValueMap model

zbx.config.item.aggregate¶

see https://www.zabbix.com/documentation/2.0/manual/config/items/itemtypes/aggregate # NOQA

class zbx.config.items.aggregate.AggregateItem(name, groups, groupfunc, itemfunc, timeperiod, **fields)[source]¶

AggregateItem model

zbx.config.items.aggregate.AvgItem(name, groups, **fields)[source]¶

Helper for average items.

zbx.config.items.aggregate.SumItem(name, groups, **fields)[source]¶

Helper for sum items.

zbx.io¶

Dump and load config from xml files

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up zbx for local development.

1. Fork the zbx repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/zbx.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv zbx
   $ cd zbx/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 zbx tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/johnnoone/zbx/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_zbx

Development Lead¶

• Xavier Barbosa <clint.northwood@gmail.com>

Contributors¶

None yet. Why not be the first?

0.1.0 (2014-05-02)¶

• Starting this project.