https://github.com/henriquesebastiao/netmikro

Manage your Mikrotik RouterOS with Python.
https://github.com/henriquesebastiao/netmikro

mikrotik mikrotik-api mikrotik-routeros-script mikrotik-script netmikro router routerboard routerboard-api routeros routeros-api routeros-scripts ssh

Last synced: about 1 month ago
JSON representation

Manage your Mikrotik RouterOS with Python.

• Host: GitHub
• URL: https://github.com/henriquesebastiao/netmikro
• Owner: henriquesebastiao
• License: mit
• Created: 2023-09-07T18:59:38.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-31T12:21:01.000Z (about 2 months ago)
• Last Synced: 2024-11-06T07:43:30.697Z (about 2 months ago)
• Topics: mikrotik, mikrotik-api, mikrotik-routeros-script, mikrotik-script, netmikro, router, routerboard, routerboard-api, routeros, routeros-api, routeros-scripts, ssh
• Language: Python
• Homepage: https://netmikro.henriquesebastiao.com
• Size: 749 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Citation: CITATION.cff
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


# Netmikro

[![CI](https://github.com/henriquesebastiao/netmikro/actions/workflows/ci.yml/badge.svg)](https://github.com/henriquesebastiao/netmikro/actions/workflows/ci.yml)

[![Documentation Status](https://readthedocs.org/projects/netmikro/badge/?version=latest)](https://netmikro.henriquesebastiao.com/en/latest/?badge=latest)

[![Coverage](docs/assets/coverage.svg)](https://github.com/henriquesebastiao/netmikro)

[![PyPI version](https://badge.fury.io/py/netmikro.svg)](https://badge.fury.io/py/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](api/RouterOS.md) 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](https://github.com/ktbyers/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](https://netmikro.henriquesebastiao.com)

**Source Code**: [https://github.com/henriquesebastiao/netmikro](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:

``` {.bash .copy }

pip install netmikro

```

## Basic usage

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

```Python

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](LICENSE).