mikrotik-java/README.md

mikrotik-java

A Java client implementation for the Mikrotik RouterOS API.

This project provides a Java client to manipulate Mikrotik routers using the remote API. Simple things must be easy to do, and complex things must be possible.

This code is currently pre-release, so in order to use it you will have to clone it locally and compile it yourself. Any part, including public interfaces, can change at any time, until I release version 1.0.

Examples

Here is a simple example: Connect to a router and reboot it.

ApiConnection con = ApiConnection.connect("10.0.1.1"); // connect to router
con.login("admin","password"); // log in to router
con.execute("/system/reboot"); // execute a command
con.disconnect(); // disconnect from router

A simple example that returns a result: Print all interfaces.

ApiConnection con = ApiConnection.connect("10.0.1.1");
con.login("admin","password");
List<Result> rs = con.execute("/interface/print");
for (Result r : rs) {
  System.out.println(r);
}

The same query, but with the results filtered: Print all interfaces of type 'vlan'

List<Result> rs = con.execute("/interface/print where type=vlan");

The same query, but we only want certain result fields names Print all interfaces of type 'vlan' and return their name

List<Result> rs = con.execute("/interface/print where type=vlan return name");

We can run asynchrynous commands:

This example shows how to run '/interface wireless monitor' and have the result sent to a listener object, which prints it

Command cmd = con.execute("/interface/wireless/monitor .id=wlan1 return signal-to-noise", 
      new ResultListener() {

            public void receive(Result result) {
                System.out.println(result);
            }
            
        }
  );

The above command will run and send results asynchrynously as they become available, until it is canceled. The command (returned in the Command object above) is cancelled like this:

con.cancel(cmd);

More examples will be added shortly.

References

The RouterOS API is documented here: http://wiki.mikrotik.com/wiki/Manual:API

Licence

mikrotik-java is released under the Apache 2.0 license. See http://www.apache.org/licenses/LICENSE-2.0