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.

Examples¶ ↑

Included in the bin subdirectory 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

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

Download¶ ↑

The latest version of MTik can be found at

• aarongifford.com/computers/mtik/

Ruby RDoc documentation can be found online at

• aarongifford.com/computers/mtik/latest/doc/

Additional documentation is available at

• aarongifford.com/computers/mtik/

• wiki.mikrotik.com/wiki/API_Ruby_class

Source code is available on GitHub:

• www.github.com/astounding/mtik/

For documentation on the MikroTik RouterOS API, see

• wiki.mikrotik.com/wiki/API

Installation¶ ↑

To install MTik is through its GEM file:

% [sudo] gem install mtik-4.1.1.gem

License¶ ↑

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

Report Bugs¶ ↑

Bugs/issues may also be reported via GitHub:

• www.github.com/astounding/mtik/issues/

ALSO, please send the author a note regarding the issue by clicking on the “Contact Me” link in the left-hand menu of the author's web site. The direct URL is:

• aarongifford.com/leaveanote.html

Thank you!

– Aaron D. Gifford