omdclient check_mk + WATO/OMD interface
omdclient provides a suite of command-line tools to interact with the APIs
associated with the
check_mk/Open Monitoring Distribution tool suite.
WATO is used to create, remove, and modify entries within the OMD user suite. This is documented at:
Activates changes made by the API user.
Takes a list of hosts on STDIN and adds them to a specific folder in OMD.
Creates/Reads/Updates/Deletes entries from an existing monitoring interface.
update/remove a given host tag in OMD
Reinventory a host in OMD.
Acknowledges host/service alerts from the command-line.
Schedules host/service downtimes from the command-line.
Print a list of all hosts in the given nagios instance.
Print a list of hosts that are currently exhibiting a specific problem.
Prints a human-readable report on current host and service alerts.
Setup / How To Use
You'll have to populate this file on your own:
server: 'xxxxxx.example' site: 'xxxxxx' user: 'xxxx-api' apikey: 'xxxxxx'
If you set the 'OMDCONFIG' environment variable you can point at different configs, e.g.:
Configuration of 'expanded views'
The report scripts depend on 'expanded view' versions of the
svcproblems views, which add comments. In order to
add these, you generally have to:
- Edit view
hostproblems- it's a default view, so you'll go to 'clone'.
- Change the name from
- Update the list of columns to read:
- Host icons
- Host state
- Output of host check plugin
- Number of services in state OK
- Number of services in state WARN
- Number of services in state UNKNOWN
- Number of services in state CRIT
- Number of services in state PENDING
- The age of the current host state
- Host comments
- (newer versions) set to 'public' and 'hidden'.
- Change the name from
- Edit the view
svcproblems_expanded, same as above but just add the column
In newer versions of check_mk, you may also need to make these views
Make this view available for other users /
Publish to all users). Also, the
hostproblems base view may have
changed: I have for
(Thanks to Christian Bryn - https://github.com/epleterte - for the docs!)
How To Build
There is a
Makefile.bak and a
*.spec file that mirrors my local build
process for RPMs, if this matches your requirements; just run
make -f Makefile.bak build-nomock.
Otherwise, you may want to just follow the general instructions
*.spec. Scripts from
usr/bin/* go into your path; create
/etc/omdclient/config.yaml as described above; make man pages with
pod2man if you're ambitious; and run
python setup.py install to
install the python library.
make -f Makefile.deb build
That should build a full .deb package.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size omdclient-1.4.2-py3-none-any.whl (55.8 kB)||File type Wheel||Python version py3||Upload date||Hashes View hashes|
|Filename, size omdclient-1.4.2.tar.gz (22.8 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for omdclient-1.4.2-py3-none-any.whl