Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An interface to the MikroTik RouterOS API (via TCP) in Ruby
Ruby
branch: master

Version 3.0.3 log entry added

latest commit 103aa140df
Aaron D. Gifford authored
Failed to load latest commit information.
bin Mostly cosmetic changes. See CHANGELOG.txt for details. Minor version…
examples Cosmetic mod to json script, added fetch example (not really useful, …
lib Oops, imported new feature with a new bug--corrected.
.gitignore Mostly cosmetic changes. See CHANGELOG.txt for details. Minor version…
CHANGELOG.txt
LICENSE.txt
README.txt README cosmetic change example to use version 4.0.0
Rakefile
VERSION.txt Version bump for fetch() feature change

README.txt

= 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 examples subdirectory 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


== Download

The latest version of MTik can be found at

* http://www.aarongifford.com/computers/mtik/

Ruby RDoc documentation can be found online at

* http://www.aarongifford.com/computers/mtik/latest/doc/ 

Additional documentation is available at

* http://www.aarongifford.com/computers/mtik/
* http://wiki.mikrotik.com/wiki/API_Ruby_class

Source code is available on GitHub:

* http://www.github.com/astounding/mtik/

For documentation on the MikroTik RouterOS APi, see

* http://wiki.mikrotik.com/wiki/API


== Installation

To install MTik is through its GEM file:

  % [sudo] gem install mtik-4.0.0.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:

* http://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:

* http://www.aarongifford.com/leaveanote.html

Thank you!

-- Aaron D. Gifford

Something went wrong with that request. Please try again.