This is a text-only version of the following page on https://raymii.org:
---
Title : Python script to talk to LibreNMS API and get alerts and hosts
Author : Remy van Elst
Date : 08-08-2018
URL : https://raymii.org/s/software/Python_script_to_talk_to_LibreNMS_API_and_get_alerts_and_hosts.html
Format : Markdown/HTML
---
This script talks to the LibreNMS API to receive a list of down devices and
alerts. The LibreNMS dashboard provides widgets for alerts and host statusses,
but there is no easy way to access that output via the API. Using Python I was
able to get certain information and output it as HTML or text using PrettyTable.
It can be included in other systems or be used in a chain of monitoring
customizations.
<p class="ad"> <b>Recently I removed all Google Ads from this site due to their invasive tracking, as well as Google Analytics. Please, if you found this content useful, consider a small donation using any of the options below:</b><br><br> <a href="https://leafnode.nl">I'm developing an open source monitoring app called Leaf Node Monitoring, for windows, linux & android. Go check it out!</a><br><br> <a href="https://github.com/sponsors/RaymiiOrg/">Consider sponsoring me on Github. It means the world to me if you show your appreciation and you'll help pay the server costs.</a><br><br> <a href="https://www.digitalocean.com/?refcode=7435ae6b8212">You can also sponsor me by getting a Digital Ocean VPS. With this referral link you'll get $100 credit for 60 days. </a><br><br> </p>
### Installation
On Ubuntu you need to install `prettytable` and python:
apt-get install python-prettytable python
Clone the [git repository][2]:
git clone https://github.com/RaymiiOrg/librenms-api-alerts
### Usage
Add your API token in the script and change the API URL:
auth_token = ""
api_url = "https://example.org/librenms/api/v0/"
Run the script:
python ./open_alerts.py
Text output example:
Devices Down: (1):
+-----------------------+---------------------+---------------------+-----------------+
| Hostname | Notes | Down since | Location |
+-----------------------+---------------------+---------------------+-----------------+
| rtr-4g-01.example.org | 4G Router Groningen | 2018-08-03 14:21:18 | Groningen |
+-----------------------+---------------------+---------------------+-----------------+
Critical alerts (3):
+-----------------------+-----------------------+----------------------------------------+-----------------------------+
| Hostname | Alert rule | OS Version | Location |
+-----------------------+-----------------------+----------------------------------------+-----------------------------+
| server1.example.org | State Sensor Critical | Server 2008 R2 SP1 (NT 6.1) | Papendrecht |
| server2.example.org | State Sensor Critical | Server 2008 Datacenter R2 SP1 (NT 6.1) | Benthuizen |
| server3.example.org | Disk used > 95% | 3.0.76-0.11-default | Papendrecht |
+-----------------------+-----------------------+----------------------------------------+-----------------------------+
Warning alerts (4):
+--------------------------+-----------------+-----------------------------+-----------------------------+
| Hostname | Alert rule | OS Version | Location |
+--------------------------+-----------------+-----------------------------+-----------------------------+
| server5.example.org | Disk used > 85% | Server 2012 R2 (NT 6.3) | Papendrecht |
| server6.example.org | Disk used > 85% | Server 2008 R2 SP1 (NT 6.1) | Papendrecht |
| server7.example.org | Disk used > 85% | 4.4.0-121-generic | Middenmeer |
| server8.example.org | Disk used > 85% | Server 2012 R2 (NT 6.3) | Papendrecht |
+--------------------------+-----------------+-----------------------------+-----------------------------+
HTML Example:
![][3]
### License
GNU GPLv2
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
[1]: https://www.digitalocean.com/?refcode=7435ae6b8212
[2]: https://github.com/RaymiiOrg/librenms-api-alerts
[3]: https://raymii.org/s/inc/img/librenms_api.png
---
License:
All the text on this website is free as in freedom unless stated otherwise.
This means you can use it in any way you want, you can copy it, change it
the way you like and republish it, as long as you release the (modified)
content under the same license to give others the same freedoms you've got
and place my name and a link to this site with the article as source.
This site uses Google Analytics for statistics and Google Adwords for
advertisements. You are tracked and Google knows everything about you.
Use an adblocker like ublock-origin if you don't want it.
All the code on this website is licensed under the GNU GPL v3 license
unless already licensed under a license which does not allows this form
of licensing or if another license is stated on that page / in that software:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Just to be clear, the information on this website is for meant for educational
purposes and you use it at your own risk. I do not take responsibility if you
screw something up. Use common sense, do not 'rm -rf /' as root for example.
If you have any questions then do not hesitate to contact me.
See https://raymii.org/s/static/About.html for details.