MTik -- A Ruby implementation of the MikroTik RouterOS API

The MTik gem implements the MikroTik RouterOS API for connecting to devices running RouterOS (with the API enabled) over the network.

Latest Version

The latest version is version 4.1.2 released on 24 August 2020.

You can view the most recent changes in the CHANGELOG here.

You can download the latest GEM here:

• https://aarongifford.com/computers/mtik/gems/mtik-4.1.2.gem

SHA256 and MD5 sums of the gem files are:

• MD5 (mtik-4.1.2.gem) = "8af17d53dab6e8739bea67e984b266fa"
• SHA256 (mtik-4.1.2.gem) = "9434ce5fb4814a097addd53990a6067ba9aafb7209a86538c9a57beb9fc3e472"

The latest source code is available at https://github.com/astounding/mtik/. You can grab a clone using 'git' by doing:

• git clone git://github.com/astounding/mtik.git

License

This gem and all other scripts and documentation files are licensed under a BSD-style license. (See the LICENSE.txt file.)

Documentation

Basic RDoc documentation can be found at:

• https://aarongifford.com/computers/mtik/doc/index.html

MikroTik's online wiki has documentation at:

• https://wiki.mikrotik.com/wiki/API_Ruby_class

For general documentation about the MikroTik RouterOS API, see:

• https://wiki.mikrotik.com/wiki/API

Installation

To install MTik is through its GEM file:

% [sudo] gem install mtik-4.1.2.gem

The latest GEM file is available for download at:

• https://aarongifford.com/computers/mtik/gems/mtik-4.1.2.gem

Examples

Included in the bin subdirectory of the GEM are four example ruby scripts that use the Ruby API implementation:

tikcli

A command-line-like API interface

tikcommand

A tool for executing a single API command from a unix command-line.

tikfetch

A tool for instructing devices to download files from specified URLs (unix command-line tool).

tikjson.rb

Like 'tikcommand' a tool for executing a single API command, except the output is formatted in JSON-style.

Report Bugs

Please report bugs by going to the author's web site and clicking on the "Contact Me" link in the left-hand menu. The direct URL is:

• https://aarongifford.com/leaveanote.html

Additionally, issues may be reported on GitHub, though it's still a good idea to drop the author a note as mentioned after reporting an issue via GitHub.

Thank you!

-- Aaron D. Gifford