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 3.1.0 released on 24 Apr. 2010.

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

You can download the latest GEM here:

SHA256 and MD5 sums of the gem files are:
  • MD5 (mtik-3.1.0.gem) = "557e96c47ea232d4770a0206b8db7c8d"
  • SHA256 (mtik-3.1.0.gem) = "cd8808c51fcf199a761b938ffd5439a3175810b8a10448b472fcc0fd63a7bc7e"
If you want to use GIT to obtain the current source files (and also the GEM), you can do: 
  • git clone http://www.aarongifford.com/computers/mtik/mtik.git
Or alternatively (from RubyForge): 
  • git clone git://rubyforge.org/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:

MikroTik's online wiki has documentation at:

For more general documentation about the MikroTik MikroTik RouterOS API, see:

Installation

To install MTik is through its GEM file: 

% [sudo] gem install mtik-3.1.0.gem
The latest GEM file is available for download at:

Examples

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

tikcli.rb
A command-line-like API interface
tikcommand.rb
A tool for executing a single API command from a unix command-line.
tikfetch.rb
A tool for instructing devices to download files from specified URLs (unix command-line tool).
tikjson.rb
Like 'command.rb' 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:

Thank you!

-- Aaron D. Gifford