Raymii.org
Quis custodiet ipsos custodes?Home | About | All pages | Cluster Status | RSS Feed
Python script to talk to LibreNMS API and get alerts and hosts
Published: 08-08-2018 | Author: Remy van Elst | Text only version of this article
❗ This post is over six years old. It may no longer be up to date. Opinions may have changed.
Table of Contents
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.
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:
I'm developing an open source monitoring app called Leaf Node Monitoring, for windows, linux & android. Go check it out!
Consider sponsoring me on Github. It means the world to me if you show your appreciation and you'll help pay the server costs.
You can also sponsor me by getting a Digital Ocean VPS. With this referral link you'll get $200 credit for 60 days. Spend $25 after your credit expires and I'll get $25!
Installation
On Ubuntu you need to install prettytable and python:
apt-get install python-prettytable python
Clone the git repository:
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:
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/>.