Skip to main content

Monitoring plugin for MikroTik devices for Icinga-Nagios-...

Project description

check_routeros - Monitoring MikroTik devices

GitHub issues GitHub forks GitHub stars GitHub license Documentation Icinga Exchange PyPI - Downloads PyPI - Python Version PyPI - Format PyPI - Status

This is a monitoring plugin for Icinga, Nagios and other compatible monitoring solutions to check MikroTik devices running RouterOS. It uses the API to fetch the required information.

Requirements

Installation

PIP

If you want to use pip we recommend to use as virtualenv to install the dependencies.

pip install -r requirements.txt

Copy the script check_routeros.py and the directory routeros_check into your plugin directory.

Debian/Ubuntu

Install the required packages

sudo apt-get install python3 python3-click python3-librouteros python3-nagiosplugin

Copy the script check_routeros.py and the directory routeros_check into your plugin directory.

From PyPI

Install the package from PyPI.

pip install routeros-check

You should be able to run check_routeros after the package installation has been finished successfully.

Note You have to update the command in the icinga CheckCommand example config.

Usage

To get the latest help just run the following command.

./check_routeros.py --help

To get help for a subcommand just extend the previous command with the subcommand. In the example below you will see how to get help for the tool.ping subcommand.

./check_routeros.py tool.ping --help

Subcommands/Checks

All commands require at least api and read permissions. The permissions documented in the table are additional permissions.

Subcommand Permissions RouterOS Description
interface - 6, 7 Check interfaces
interface.gre - 6 Check GRE interfaces/tunnels
interface.vrrp - 6 Check the state of an VRRP interface
routing.bgp.peers - 6 Check if connection to BGP peers is established
routing.ospf.neighbors - 6 Check if ospf neigbhors are reachable
system.clock - 6, 7 Check the time from RouterOS against local time
system.cpu - 6, 7 Check the cpu load
system.fan - 6, 7 Check the fans
system.memory - 6, 7 Check system memory
system.ntp.client - 6, 7 Check the ntp client, offset and stratum
system.license - 6, 7 Check the license level and deadline and renewal date
system.power - 6, 7 Check the overall power consumption if available
system.psu - 6, 7 Check the current, voltage and state of the power supply
system.temperature - 6, 7 Check the cpu, system, board and more temperatures.
system.update - 6, 7 Check for updates
system.uptime - 6, 7 Check the uptime
tool.ping test 6, 7 Run the ping command on the device

To get more information about the available subcommands/checks have a look at the check_routeros Command Reference

Resources

License

GPLv3+

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

routeros-check-0.9.1.tar.gz (97.4 kB view details)

Uploaded Source

Built Distribution

routeros_check-0.9.1-py3-none-any.whl (65.0 kB view details)

Uploaded Python 3

File details

Details for the file routeros-check-0.9.1.tar.gz.

File metadata

  • Download URL: routeros-check-0.9.1.tar.gz
  • Upload date:
  • Size: 97.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for routeros-check-0.9.1.tar.gz
Algorithm Hash digest
SHA256 1d069ebe9f9bd118195518274b9350b56e6370dd4e1cd4cd5ccb1827a6936a4d
MD5 0bf38d50973fa75134827b9113907cea
BLAKE2b-256 6588500354774b9631a313abd2f9d3251b904b4d07d22d4dca4facc090cdb128

See more details on using hashes here.

File details

Details for the file routeros_check-0.9.1-py3-none-any.whl.

File metadata

File hashes

Hashes for routeros_check-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c891a8782554c3b0810971f14395bc4428b1d6e2014385e76d1d6d130a709440
MD5 5d9b8e093034f5a7b914f596c0537715
BLAKE2b-256 c29b273af64d7c3233e9838dbe1dfa9a212dd192660bf620fe14f2a416d144cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page