logo do projeto

Netmikro¶

Netmikro is a simple library that provides an easy way to manage Mikrotik routers, simplifying configuration and monitoring tasks.

Everything works through an instance of the RouterOS class that creates an SSH connection with the device, think of the instantiated object as your own router, this object has methods to interact with your router, or you can Run custom commands directly in your router's terminal with the cmd() method.

Netmikro is on the shoulders of the Netmiko project, responsible for creating a connection via SSH with the Mikrotik router.

Note

I'm just a computer networking enthusiast and have experience with handling MIkrotik routers. All Netmikro features are being tested during development with a Mikrotik RB912UAG-5HPn router. The idea is to test it on other models as soon as possible.

Documentation: https://netmikro.henriquesebastiao.com

Source Code: https://github.com/henriquesebastiao/netmikro

Compatibility note¶

For now, Netmikro is only fully compatible with versions higher than v7 of RouterOS, some features may even work with previous versions, but their use is not encouraged at the moment. However, I will make this support for previous versions possible as soon as possible.

How to install¶

Netmikro is available on PyPi, so just use your preferred package manager:

$ pip install netmikro

Basic usage¶

You just need to create an instance of RouterOS to use Netmikro features:

from netmikro import RouterOS


router = RouterOS(
    '192.168.3.3',
    'user',
    'password',
    22,
)

router.cmd('/system identity print')

License¶

This project is licensed under the terms of the MIT license.