134 lines
3.4 KiB
Markdown
134 lines
3.4 KiB
Markdown
mikrotik-java
|
|
=============
|
|
|
|
A Java client library 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.
|
|
|
|
Versions
|
|
--------
|
|
|
|
The current stable version 1.1, which added TLS (SSL) support to encrypt API traffic.
|
|
|
|
|
|
Examples
|
|
========
|
|
|
|
Here is a simple example: Connect to a router and reboot it.
|
|
|
|
```java
|
|
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
|
|
```
|
|
If your router does not use the default API port, the port can be specified when connecting:
|
|
|
|
```java
|
|
ApiConnection con = ApiConnection.connect("10.0.1.1", 1337); // connect to router on port 1337
|
|
```
|
|
|
|
To open an encrypted (TLS) connection is as simple, assuming the default API-SSL port is used:
|
|
|
|
```java
|
|
ApiConnection con = ApiConnection.connectTLS("10.0.1.1"); // connect to router using TLS
|
|
```
|
|
|
|
Currently only anonymous TLS is supported, not certificates.
|
|
|
|
In following examples the connection, login and disconnection code will not be repeated.
|
|
|
|
Reading data
|
|
------------
|
|
|
|
A simple example that returns a result: Print all interfaces.
|
|
|
|
|
|
```java
|
|
List<Map<String, String>> rs = con.execute("/interface/print");
|
|
for (Map<String,String> r : rs) {
|
|
System.out.println(r);
|
|
}
|
|
```
|
|
|
|
### Filtering results
|
|
|
|
The same query, but with the results filtered: Print all interfaces of type 'vlan'.
|
|
|
|
```java
|
|
List<Map<String, String>> rs = con.execute("/interface/print where type=vlan");
|
|
```
|
|
|
|
### Selecting returned fields
|
|
|
|
The same query, but we only want certain result fields names Print all interfaces of type 'vlan' and return their name.
|
|
|
|
```java
|
|
List<Map<String, String>> rs = con.execute("/interface/print where type=vlan return name");
|
|
```
|
|
|
|
Writing data
|
|
------------
|
|
|
|
Creating, modifying and deleting configuration objects is of course possible.
|
|
|
|
### Creating an object
|
|
|
|
This example shows how to create a new GRE interface:
|
|
|
|
```java
|
|
con.execute("/interface/gre/add remote-address=192.168.1.1 name=gre1 keepalive=10");
|
|
```
|
|
|
|
### Modify an existing object
|
|
|
|
Change the IP address in the object created by the above example:
|
|
|
|
```java
|
|
con.execute("/interface/gre/set .id=gre1 remote-address=10.0.1.1");
|
|
```
|
|
|
|
### Remove an existing object
|
|
|
|
And now remove the object:
|
|
|
|
```java
|
|
con.execute("/interface/gre/remove .id=gre1");
|
|
```
|
|
|
|
Asynchronous commands
|
|
---------------------
|
|
|
|
We can run some commands asynchronously in order to continue receiving updates:
|
|
|
|
This example shows how to run '/interface wireless monitor' and have the result sent to a listener object, which prints it
|
|
|
|
```java
|
|
String tag = con.execute("/interface/wireless/monitor .id=wlan1 return signal-to-noise",
|
|
new ResultListener() {
|
|
|
|
public void receive(Map<String, String> result) {
|
|
System.out.println(result);
|
|
}
|
|
|
|
}
|
|
);
|
|
```
|
|
|
|
The above command will run and send results asynchronously as they become available, until it is canceled. The command (identified by the unique String retruned)
|
|
is canceled like this:
|
|
|
|
```java
|
|
con.cancel(tag);
|
|
```
|
|
|
|
References
|
|
==========
|
|
|
|
The RouterOS API is documented here: http://wiki.mikrotik.com/wiki/Manual:API
|
|
|
|
Licence
|
|
=======
|
|
|
|
This library is released under the Apache 2.0 licence. See the Licence.md file
|