Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evilfreelancer/routeros-api-php
Mikrotik RouterOS API PHP client for your applications
https://github.com/evilfreelancer/routeros-api-php
api-client library mikrotik mikrotik-api php7 php8 psr routeros routeros-api
Last synced: 4 days ago
JSON representation
Mikrotik RouterOS API PHP client for your applications
- Host: GitHub
- URL: https://github.com/evilfreelancer/routeros-api-php
- Owner: EvilFreelancer
- License: mit
- Created: 2018-08-19T19:45:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-20T11:50:53.000Z (3 months ago)
- Last Synced: 2024-11-20T11:17:28.599Z (about 1 month ago)
- Topics: api-client, library, mikrotik, mikrotik-api, php7, php8, psr, routeros, routeros-api
- Language: PHP
- Homepage: https://mikrotik.com/software
- Size: 303 KB
- Stars: 407
- Watchers: 33
- Forks: 150
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/evilfreelancer/routeros-api-php)
[](https://travis-ci.org/EvilFreelancer/routeros-api-php)
[](https://packagist.org/packages/evilfreelancer/routeros-api-php)
[](https://packagist.org/packages/evilfreelancer/routeros-api-php)
[](https://codeclimate.com/github/EvilFreelancer/routeros-api-php)
[](https://scrutinizer-ci.com/g/EvilFreelancer/routeros-api-php/?branch=master)
[](https://scrutinizer-ci.com/g/evilfreelancer/routeros-api-php/)
# RouterOS API Client
```shell
composer require evilfreelancer/routeros-api-php
```
This library is partly based on [this old project](https://github.com/BenMenking/routeros-api), but unlike it has many
innovations to ease development. In addition, the project designed
to work with PHP7/8 in accordance with the PSR standards.
You can use this library with pre-6.43 and post-6.43 versions of
RouterOS firmware, it will be detected automatically on connection stage.
## Table of Contents
* [Minimum requirements](#Minimum-requirements)
* [Laravel framework support](#Laravel-framework-support)
* [Laravel installation](#Laravel-installation)
* [How to use](#How-to-use)
* [How to configure the client](#How-to-configure-the-client)
* [List of available configuration parameters](#List-of-available-configuration-parameters)
* [How to enable support of legacy login schema (RouterOS pre-6.43)](#How-to-enable-support-of-legacy-login-schema-(RouterOS-pre-6.43))
* [How to write queries](#How-to-write-queries)
* [Read response as Iterator](#Read-response-as-Iterator)
* [Short methods](#Short-methods)
* [Known issues](#Known-issues)
* [Unable to establish socket session, Operation timed out](#Unable-to-establish-socket-session,-Operation-timed-out)
* [How to update/remove/create something via API?](#How-to-update/remove/create-something-via-API?)
* [Undefined character (any non-English languages)](#Undefined-character-(any-non-English-languages))
* [Testing](#Testing)
* [Links](#Links)
## Minimum requirements
* `php` >= 7.2|8.0
* `ext-sockets`
## Laravel framework support
RouterOS API client is optimized for usage as normal Laravel package, all functional is available via `\RouterOS` facade,
for access to client object you need instead:
```php
$config = new \RouterOS\Config([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin',
'port' => 8728,
]);
$client = new \RouterOS\Client($config);
```
Use the facade and pass array of parameters to `client` method:
```php
$client = \RouterOS::client([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin',
'port' => 8728,
]);
```
You also may get array with all configs which was obtained from `routeros-api.php` file:
```php
$config = \RouterOS::config([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin',
'port' => 8728,
]);
dump($config);
$client = \RouterOS::client($config);
```
### Laravel installation
By default, the package will automatically register its service provider, but
if you are a happy owner of Laravel version less than 5.5, then in a project, which is using the package
(after `composer require` is done, of course), add into`providers` block of your `config/app.php`:
```php
'providers' => [
// ...
RouterOS\Laravel\ServiceProvider::class,
],
```
Optionally, publish the configuration file if you want to change any defaults:
```shell
php artisan vendor:publish --provider="RouterOS\\Laravel\\ServiceProvider"
```
## How to use
Basic example, analogue via command line is `/ip hotspot ip-binding print`:
```php
use \RouterOS\Client;
use \RouterOS\Query;
// Initiate client with config object
$client = new Client([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin',
'port' => 8728,
]);
// Create "where" Query object for RouterOS
$query =
(new Query('/ip/hotspot/ip-binding/print'))
->where('mac-address', '00:00:00:00:40:29');
// Send query and read response from RouterOS
$response = $client->query($query)->read();
var_dump($response);
```
Basic example for update/create/delete types of queries:
```php
use \RouterOS\Client;
use \RouterOS\Query;
// Initiate client with config object
$client = new Client([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin'
]);
// Send "equal" query with details about IP address which should be created
$query =
(new Query('/ip/hotspot/ip-binding/add'))
->equal('mac-address', '00:00:00:00:40:29')
->equal('type', 'bypassed')
->equal('comment', 'testcomment');
// Send query and read response from RouterOS (ordinary answer from update/create/delete queries has empty body)
$response = $client->query($query)->read();
var_dump($response);
```
If you need export all settings from router:
```php
use \RouterOS\Client;
// Initiate client with config object
$client = new Client([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin',
'ssh_port' => 22222,
'ssh_timeout' => 60, // if not set then 30 seconds by default
]);
// Execute export command via ssh
$response = $client->query('/export');
// or
$response = $client->export();
var_dump($response);
```
Examples with "where" conditions, "operations" and "tag":
```php
use \RouterOS\Query;
/**
* Simple "where" query will be generated by default
*/
$client->query('/ip/address/print')->read();
/**
* Send advanced "where" query with parameters to RouterOS
*/
// If only one "where" condition
$client->query('/queue/simple/print', ['target', '192.168.1.1/32']);
// If multiple "where" conditions and need merge (operation "|") results
$client->query('/interface/print', [
['type', 'ether'], // same as ['type', '=', 'ether']
['type', 'vlan'], // same as ['type', '=', 'vlan']
], '|');
/**
* Or in OOP style
*/
// If you need create query for "create/update/delete" operations
$query = new Query('/ip/hotspot/ip-binding/add');
$query->equal('mac-address', '00:00:00:00:40:29');
$query->equal('type', 'bypassed');
$query->equal('comment', 'testcomment');
// If multiple "where" conditions and need merge (operation "|") results
$query = new Query('/interface/print');
$query->where('type', 'ether');
$query->where('type', 'vlan');
$query->operations('|');
// If multiple "where" conditions and need append tag
$query = new Query('/interface/set');
$query->where('disabled', 'no');
$query->where('.id', 'ether1');
$query->tag(4);
/**
* Write Query object to RouterOS and read response from it
*/
$response = $client->query($query)->read();
```
> All available examples you can find [here](https://github.com/EvilFreelancer/routeros-api-php/tree/master/examples).
## How to configure the client
You just need create object of Client class with required
parameters in array format:
```php
use \RouterOS\Client;
$client = new Client([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin'
]);
```
ℹ️ Advanced examples of Config and Client classes usage
```php
use \RouterOS\Config;
use \RouterOS\Client;
/**
* You can create object of Config class
*/
$config = new Config();
// Then set parameters of config
$config->set('host', '192.168.1.3');
$config->set('user', 'admin');
$config->set('pass', 'admin');
// By the way, `->set()` method is support inline style of syntax
$config
->set('host', '192.168.1.3')
->set('user', 'admin')
->set('pass', 'admin');
/**
* Or just create preconfigured Config object
*/
$config = new Config([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin'
]);
/**
* Then send Config object to Client constructor
*/
$client = new Client($config);
```
### List of available configuration parameters
| Parameter | Type | Default | Description |
|-----------------|--------|----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------|
| host | string | | (required) Address of Mikrotik RouterOS |
| user | string | | (required) Username |
| pass | string | | (required) Password |
| port | int | | RouterOS API port number for access (if not set use 8728 or 8729 if SSL enabled) |
| ssl | bool | false | Enable ssl support (if port is not set this parameter must change default port to ssl port) |
| ssl_options | array | [details](https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/Config.php#L46) | See https://www.php.net/manual/en/context.ssl.php |
| legacy | bool | false | Deprecated, will be removed from 1.5.0: Support of legacy login scheme (true - pre 6.43, false - post 6.43) |
| timeout | int | 10 | Max timeout for connecting to RouterOS (in seconds) |
| socket_timeout | int | 30 | Max read timeout from RouterOS (in seconds) |
| socket_blocking | bool | true | Set blocking mode on a socket stream |
| socket_options | array | [details](https://github.com/EvilFreelancer/routeros-api-php/blob/master/src/Config.php#L87) | See https://www.php.net/manual/en/context.socket.php |
| attempts | int | 10 | Count of attempts to establish TCP session |
| delay | int | 1 | Delay between attempts in seconds |
| ssh_port | int | 22 | Number of SSH port for exporting configuration |
| ssh_timeout | int | 30 | Max timeout from router via SSH (in seconds) |
| ssh_private_key | string | ~/.ssh/id_rsa | Full path to required private key |
### How to enable support of legacy login schema (RouterOS pre-6.43)
> From 0.8.1 this is not important, version of firmware will be detected automatically.
> Deprecated, will be removed from 1.5.0
```php
'192.168.1.3',
'user' => 'admin',
'pass' => 'admin',
'legacy' => true // you need set `legacy` parameter with `true` value
]);
// Your code below...
```
## How to write queries
You can write absolutely any queries to your router, for this you
need to create a "Query" object whose first argument is the
required command, after this you can add the attributes of the
command to "Query" object.
More about attributes and "words" from which these attributes
should be created [here](https://wiki.mikrotik.com/wiki/Manual:API#Command_word).
More about "expressions", "where", "equal" and other filters/modifications
of your query you can find [here](https://wiki.mikrotik.com/wiki/Manual:API#Queries).
Simple usage examples of Query class:
```php
use \RouterOS\Query;
// Get all installed packages (it may be enabled or disabled)
$query = new Query('/system/package/getall');
// Send "equal" query with details about IP address which should be created
$query =
(new Query('/ip/hotspot/ip-binding/add'))
->equal('mac-address', '00:00:00:00:40:29')
->equal('type', 'bypassed')
->equal('comment', 'testcomment');
// Set where interface is disabled and ID is ether1 (with tag 4)
$query =
(new Query('/interface/set'))
->where('disabled', 'no')
->where('.id', 'ether1')
->tag(4);
// Get all ethernet and VLAN interfaces
$query =
(new Query('/interface/print'))
->where('type', 'ether')
->where('type', 'vlan')
->operations('|');
// Get all routes that have non-empty comment
$query =
(new Query('/ip/route/print'))
->where('comment', '>', null);
```
ℹ️ Advanced examples of Query class usage
```php
use \RouterOS\Query;
use \RouterOS\Client;
// Initiate connection to RouterOS
$client = new Client([
'host' => '192.168.1.3',
'user' => 'admin',
'pass' => 'admin'
]);
/**
* Execute query directly through "->query()" method of Client class
*/
// If your query has no "where" conditions
$client->query('/ip/arp/print');
// If you have only one where condition, you may use one dimensional array as second parameter of query method
$client->query('/queue/simple/print', ['target', '192.168.1.250/32']);
// If you need set few where conditions then need use multi dimensional array
$client->query('/interface/bridge/add', [
['name', 'vlan100-bridge'],
['vlan-filtering', 'no']
]);
/**
* By some reason you may need restrict scope of RouterOS response,
* for this need to use third attribute of "->query()" method
*/
// Get all ethernet and VLAN interfaces
$client->query('/interface/print', [
['type', 'ether'],
['type', 'vlan']
], '|');
/**
* If you want set tag of your query then you need to use fourth
* attribute of "->query()" method, but third attribute may be null
*/
// Enable interface (tag is 4)
$client->query('/interface/set', [
['disabled', 'no'],
['.id', 'ether1']
], null, 4);
/**
* Or in OOP style
*/
// Get all ethernet and VLAN interfaces
$query = new Query('/interface/print');
$query->where('type', 'ether');
$query->where('type', 'vlan');
$query->operations('|');
// Enable interface (tag is 4)
$query = new Query('/interface/set');
$query->equal('disabled', 'no');
$query->equal('.id', 'ether1');
$query->tag(4);
// Or, RAW mode
$query = new Query('/interface/set');
$query->add('=disabled=no');
$query->add('=.id=ether1');
$query->add('.tag=4');
// Or, RAW mode in format of array
$query = new Query('/interface/set', [
'=disabled=no',
'=.id=ether1',
'.tag=4'
]);
// Or
$query = new Query([
'/interface/set',
'=disabled=no',
'=.id=ether1',
'.tag=4'
]);
/**
* Write Query object to RouterOS and read response from it
*/
$response = $client->query($query)->read();
```
## Read response as Iterator
By default, original solution of this client is not optimized for
work with a large amount of results, only for small count of lines
in response from RouterOS API.
But some routers may have (for example) 30000+ records in
their firewall list. Specifically for such tasks, a method
`readAsIterator` has been added that converts the results
obtained from the router into a resource, with which it will
later be possible to work.
> You could treat response as an array except using any array_* functions
```php
$response = $client->query($query)->readAsIterator();
var_dump($response);
// The following for loop allows you to skip elements for which
// $iterator->current() throws an exception, rather than breaking
// the loop.
for ($response->rewind(); $response->valid(); $response->next()) {
try {
$value = $response->current();
} catch (Exception $exception) {
continue;
}
# ...
}
```
## Short methods
You can simplify your code and send then read from socket in one line:
```php
/**
* Execute query and read response in ordinary mode
*/
$response = $client->query($query)->read();
var_dump($response);
// Or
$response = $client->q($query)->r();
var_dump($response);
// Single method analog of lines above is
$response = $client->qr($query);
var_dump($response);
/**
* Execute query and read response as Iterator
*/
$response = $client->query($query)->readAsIterator();
var_dump($response);
// Or
$response = $client->q($query)->ri();
var_dump($response);
// Single method analog of lines above is
$response = $client->qri($query);
var_dump($response);
/**
* By the way, you can send few queries to your router without result:
*/
$client->query($query1)->query($query2)->query($query3);
// Or
$client->q($query1)->q($query2)->q($query3);
```
## Known issues
### Unable to establish socket session, Operation timed out
This error means that the library cannot connect to your router,
it may mean router turned off (then need turn on), or the API service not enabled.
Go to `Mikrotik Router OS -> IP -> Services` and enable `api` service.
Or via command line:
```shell script
/ip service enable api
```
### How to update/remove/create something via API?
Instead of `->where()` method of `Query` class you need to
use `->equal()` method:
```php
// Create query which should remove security profile
$query = new \RouterOS\Query('/interface/wireless/security-profiles/remove');
// It will generate queries, which stared from "?" symbol:
$query->where('.id', '*1');
/*
// Sample with ->where() method
RouterOS\Query Object
(
[_attributes:RouterOS\Query:private] => Array
(
[0] => ?.id=*1
)
[_operations:RouterOS\Query:private] =>
[_tag:RouterOS\Query:private] =>
[_endpoint:RouterOS\Query:private] => /interface/wireless/security-profiles/remove
)
*/
// So, as you can see, instead of `->where()` need to use `->equal()`
// It will generate queries, which stared from "=" symbol:
$query->equal('.id', '*1');
/*
// Sample with ->equal() method
RouterOS\Query Object
(
[_attributes:RouterOS\Query:private] => Array
(
[0] => =.id=*1
)
[_operations:RouterOS\Query:private] =>
[_tag:RouterOS\Query:private] =>
[_endpoint:RouterOS\Query:private] => /interface/wireless/security-profiles/remove
)
*/
```
### Undefined character (any non-English languages)
RouterOS does not support national languages, only English (and API of RouterOS too).
You can try to reproduce it via web, for example add the comment to any
element of your system, then save and reload the page, you will see unreadable characters.
## Testing
You can use my [other project](https://github.com/EvilFreelancer/docker-routeros)
with RouterOS in Docker container for running unit testing on your
computer, for this you just need to have [Expect](https://wiki.debian.org/Expect),
[Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/).
Next clone the repo with RouterOS in Docker and exec
`docker-compose up -d`, then you need preconfigure virtual routers
via [preconf.tcl](https://github.com/EvilFreelancer/routeros-api-php/blob/master/preconf.tcl)
script from root of routeros-api-php:
```
./preconf.tcl 12223
./preconf.tcl 22223
```
And after this you can run tests:
```
./vendor/bin/phpunit
```
## Links
* [Cloud Hosted Router](https://mikrotik.com/download#chr) - Virtual images of RouterOS for your hypervisor
* [RouterOS Manual:API](https://wiki.mikrotik.com/wiki/Manual:API) - In case if you are wondering what is insane