#routeros documentation

routeros is a thick, friendly layer over the MikroTik RouterOS API for the Jennifer language. Each guide below covers one topic file of the module with background, the full function surface, worked examples, and the pitfalls the abstraction protects you from.

#Conventions used in every guide

All snippets assume an established connection:

import "@jennifer/routeros/" as mt;

def c as mt.Client init mt.connect("192.168.88.1", "admin", "secret");
# ... snippets go here ...
mt.disconnect($c);

Errors: every validation failure raised by routeros is an Error{kind: "routeros"} with a human-readable message; errors coming from the router or the wire are Error{kind: "mikrotik"}. Catch either with try { ... } catch (e) { io.printf("%s\n", $e.message); }.

Verbose mode: $c = mt.setVerbose($c, true); prints every command the client sends to stdout (mt> /ip/address/add address=... interface=...), with credentials redacted - see core.md. It returns a copy, so keep the returned client. MT_VERBOSE=1 in the environment turns it on at connect time without touching the script.

Ids: RouterOS gives every list item an internal id like "*3". The add* functions return it, the typed structs carry it in .id, and the generic verbs accept it. Most routeros helpers let you use a name or a comment instead, so you rarely touch ids directly.

The condensed, everything-on-one-page reference is cheatsheet.md. For the RouterOS side itself - every menu, property, and behavior these topics wrap - see MikroTik's official RouterOS documentation.

#Guides

One runnable example per topic lives in ../examples/ (MT_HOST=... MT_USER=... MT_PASSWORD=... jennifer run examples/<topic>.j).

#Disclaimer

MikroTik and RouterOS are trademarks of SIA Mikrotīkls. routeros is an independent, community-written client library, not affiliated with, endorsed, or supported by SIA Mikrotīkls - and it configures live network equipment. Use at your own risk; no warranty of any kind.

Licensed under the GNU LGPL v3.0 only - see ../LICENSE.

#Running the tests

jennifer test src/routeros_test.j

The white-box overlay exercises everything network-free: validators, row folding, builders, and normalization. Functions that need a live router are thin compositions of those tested helpers.