CherwellAPIClient

Zenoss API client module


Keywords
zenoss, monitoring, api
License
Apache-2.0
Install
pip install CherwellAPIClient==1.0.0

Documentation

Cherwell API Client

Tests badge Documentation Status PyPI - Version GitHub Release TestPyPI - Version

NOTE: This module is inspired by the excellent ZenossAPIClient by Zuora-TechOps and the fork contributed by boblickj.

My own fork of that project is available via PyPI as zenAPIClient

-dan-smalley

Python module for interacting with the Cherwell API in an object-oriented way. Tested with API version 10.1.0, no guarantees for earlier versions...

The philosophy here is to use objects to work with everything in the Cherwell API, and to try to normalize the various calls to the different routers. Thus get methods will always return an object, list methods will return data. All methods to add or create start with add, all remove or delete start with delete. As much as possible the methods try to hide the idiosyncrasies of the JSON API, and to do the work for you, for example by letting you use a device name instead of having to provide the full device UID for every call.

Installing

pip install CherwellAPIClient

Using

In [1]: from cherwellapi import apiclient as capi

In [2]: cherwell_client = capi.Client(host=CHERWELL_URL, client_id=CLIENT_ID, username=USERNAME, passwrod=PASSWORD)