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.10.1.tar.gz (100.1 kB view details)

Uploaded Source

Built Distribution

routeros_check-0.10.1-py3-none-any.whl (68.2 kB view details)

Uploaded Python 3

File details

Details for the file routeros_check-0.10.1.tar.gz.

File metadata

  • Download URL: routeros_check-0.10.1.tar.gz
  • Upload date:
  • Size: 100.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for routeros_check-0.10.1.tar.gz
Algorithm Hash digest
SHA256 b12f86e05d286151b1a536a7f5d3863c92d382d14f164afb91820026863360b0
MD5 566e16bfdd7f58cee86588071e946c5b
BLAKE2b-256 25927bbfc5f39bc8191991f820f84eaac46e1866843234571a8931a98436a220

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for routeros_check-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b5373476b86dbb2fcd8e9509726faf7b1bc7cd8ce4a72d9724b465bfac88e2fb
MD5 0e29258c9897c7930be0a22be67227b7
BLAKE2b-256 ed837b4de78ac6a46aed6a8532c45977ec5b94b12d8e7c26e5fc3caa255b5b44

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