MikroTik RouterOS Documentation

https://manual.mikrotik.com/
Admin
Comprehensive documentation for MikroTik RouterOS, a network operating system for routers, switches,...
Tokens:1,636,361
Snippets:12,406
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Netinstall CLI Example with Output

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/netinstall/netinstall-linux

Example Netinstall command with -i, -v, and -e flags, followed by its output. The output shows the installation process from waiting for the device to successful completion.

```bash
sudo ./netinstall-cli -i eth0 -v -e  routeros-7.23.1-arm64.npk wifi-qcom-7.23.1-arm64.npk container-7.23.1-arm64.npk
```

```text
Version: 7.24beta1(2026-05-26 11:17:51)
Will apply empty config
Waiting for Link-UP on eth0
Using client IP 192.168.88.3
Waiting for RouterBOARD...
Received a BOOTP request from 01:23:45:67:89:AA (arm64)
Assigned 192.168.88.3 to 01:23:45:67:89:AA
blksize 1452
Booting device 01:23:45:67:89:AA into setup mode
Formatting device 01:23:45:67:89:AA
Sending packages to device 01:23:45:67:89:AA
Packages sent to device 01:23:45:67:89:AA
Rebooting device 01:23:45:67:89:AA
Successfully finished installing device 01:23:45:67:89:AA
```

--------------------------------

### Example output of /disk/btrfs/filesystem/print after replacement

Source: https://manual.mikrotik.com/docs/storage/btrfs/raid

Example output showing the replaced device (disk3) and REPLACE-STATUS 'done'. Ensure no inconsistent Btrfs profiles for data, system, or meta; RAID1 setups should match, RAID10 may differ, and no 'single' profile should exist.

```text
Columns: LABEL, DEV-IDS, DEVS, DEFAULT-SUBVOLUME, SPACES, BALANCE-STATUS, REPLACE-STATUS, UUID, WRITE-ERRORS, READ-ERRORS, FLUSH-ERRORS, CORRUPTION-ERRORS, GENERATION-ERRORS

# LABEL   DEV-IDS  DEVS   DEFAULT-SUBVOLUME  SPACES                                                 BALANCE-STATUS  REPLACE-STATUS  UUID                                  WRITE-ERRORS  READ-ERRORS  F  C  G

0 BtrfsRAID     1  disk1  <FS_ROOT>          disk1:480GB, used:9%                                   done            done            9246dfaa-be9f-4e08-a560-53cb8e82023b             0            0  0  0  0

                2  disk3                     disk3:480GB, used:9%                                                                                                                    0  0  0  0  0

                                              data,raid1:40.8GB disk1:40.8GB disk3:40.8GB, used:72%                                                                                                            

                                              system,raid1:101MB disk1:101MB disk3:101MB, used:0%                                                                                                              

                                              meta,raid1:3.22GB disk1:3.22GB disk3:3.22GB, used:1%                                                                                                             

                                              global-reserve:30.7MB, used:0%
```

--------------------------------

### Check device state after installation with /tool/netinstall/devices/print

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/netinstall/netinstall-package

Shows the state of devices after Netinstall, including MAC address, interface, state, extra packages, version, architecture, model, last state, and auto-reboot flag. The example shows a device with state 'done' and last state 'bootp reply sent'.

```routeros
[admin@MikroTik] /tool/netinstall/devices/print   

Flags: N - NETINSTALL  

Columns: MAC-ADDRESS, INTERFACE, STATE, LAST-STATE-UPDATE, EXTRA-PACKAGES, VERSION, ARCH, MODEL, LAST-STATE, AUTO-REBOOT  

#   MAC-ADDRESS        INTERFACE  STATE    LAST-STATE-UPDATE  EXTRA-PACKAGES  VERSION    ARCH   MODEL       LAST-STATE        AUTO-REBOOT  

0 N 01:23:45:67:89:BB  bridge1    done     58s                container       7.23.1     arm64   L009UiGS   bootp reply sent  reboot       

                                                              wifi-qcom   

```

--------------------------------

### Start interactive HotSpot setup

Source: https://manual.mikrotik.com/docs/virtual-private-networks/wireguard

Starts the interactive HotSpot setup on the RouterOS device. When prompted, select the WireGuard interface wg1.

```routeros
/ip/hotspot/setup  
```

--------------------------------

### Run Netinstall CLI (General Syntax)

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/netinstall/netinstall-linux

General syntax for running the Netinstall CLI. Requires root privileges (sudo). Replace placeholders with actual parameters, address/interface, and package file.

```bash
sudo ./netinstall-cli [-parameters] [address/interface] routeros-[architecture]-[package VERSION].npk
```

--------------------------------

### CLI: /tool/netinstall/devices install

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/netinstall/netinstall-package

This snippet documents the CLI command for installing RouterOS on devices from the Netinstall Devices list, including its parameters and an example.

```APIDOC
## [CLI] /tool/netinstall/devices install

### Description
Installs RouterOS on the selected devices from the Netinstall Devices list. Additional parameters override previously set settings.

### Method
CLI command

### Endpoint
/tool/netinstall/devices install

### Parameters
#### Command Parameters
- **auto-reboot** (none / reboot / shutdown; Default: reboot) - Optional - Defines the action performed after device installation completes successfully.
- **extra-packages** - Optional - Allows to add the extra packages to be installed alongside the `system` package. The `routeros` package will be installed by default.
- **numbers** - Optional - Allows to select for which devices from the list the RouterOS is to be reinstalled.
- **version** - Optional - Specifies the RouterOS version packages to download. If not set, Netinstall installs the version selected for the interface main settings or, if not specified, downloads the latest RouterOS version available in the `Check for Updates` channel currently selected on the Netinstall server.

### Request Example
```
/tool/netinstall/devices> install auto-reboot=reboot extra-packages=user-manager version=7.24beta1
```

### Response
No response body is documented for this command.
```

--------------------------------

### Run container and create main.py

Source: https://manual.mikrotik.com/docs/containers

Runs the container and installs Python, then creates a main.py file inside the container.

```shell
/container/run alpine

/ # apk add python3

...

/ # cat <<EOF > main.py

> import os

> import sys

> ...

> EOF

/ # exit
```

--------------------------------

### Navigate to certificates directory and list contents

Source: https://manual.mikrotik.com/docs/containers/user-guides/container-thingsboard-mqtt-http-server

Navigate to the directory containing the certificates (keystore.p12 and mqttserver.p12) and list its contents. This is the starting point for the SFTP transfer of the ThingsBoard configuration file.

```cmd
C:\Windows\System32>cd c:\Users\Admin\Desktop\ThingsBoard  

C:\Users\Admin\Desktop\ThingsBoard>dir  

Directory of C:\Users\Admin\Desktop\ThingsBoard  

  

27.01.2023  15:36    <DIR>          .  

27.01.2023  15:36    <DIR>          ..  

27.01.2023  15:09             2 448 keystore.p12  

27.01.2023  15:36             2 434 mqttserver.p12  

               2 File(s)          4 882 bytes  

               2 Dir(s)  51 380 154 368 bytes free  

```

--------------------------------

### View OpenFlow flows installed by Faucet

Source: https://manual.mikrotik.com/docs/network-management/openflow

Example output of the 'print detail' command in the /openflow/flow menu, showing the flows installed by Faucet. The output includes details such as priority, timeouts, cookie, and table-id for each flow.

```RouterOS CLI
[admin@CCR2004_2XS_111] /openflow/flow>  print detail   

Flags: I - inactive   

 0   switch=faucet version=4 match=" [ { ethdst_m=01000cccccccffffffffffff } ]" actions=" []"   

     info="priority 8240, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 1   switch=faucet version=4 match=" [ { ethdst_m=01000ccccccdffffffffffff } ]" actions=" []"   

     info="priority 8240, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 2   switch=faucet version=4 match=" [ { ethdst_m=ffffffffffffffffffffffff }; { vlanvid=1064 } ]"   

     actions=" [ { apply-actions= [ { popvlan={} }; { output={ port=1; max_len=0 } }; { output={ port=2; max_len=0 } } ]   

        } ]"   

     info="priority 8240, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 3   switch=faucet version=4 match=" [ { ethdst_m=0180c2000000fffffffffff0 } ]" actions=" []"   

     info="priority 8236, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 4   switch=faucet version=4 match=" [ { ethdst_m=0180c2000000ffffff000000 }; { vlanvid=1064 } ]"   

     actions=" [ { apply-actions= [ { popvlan={} }; { output={ port=1; max_len=0 } }; { output={ port=2; max_len=0 } } ]   

        } ]"   

     info="priority 8216, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 5   switch=faucet version=4 match=" [ { ethdst_m=01005e000000ffffff000000 }; { vlanvid=1064 } ]"   

     actions=" [ { apply-actions= [ { popvlan={} }; { output={ port=1; max_len=0 } }; { output={ port=2; max_len=0 } } ]   

        } ]"   

     info="priority 8216, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 6   switch=faucet version=4 match=" [ { ethdst_m=333300000000ffff00000000 }; { vlanvid=1064 } ]"   

     actions=" [ { apply-actions= [ { popvlan={} }; { output={ port=1; max_len=0 } }; { output={ port=2; max_len=0 } } ]   

        } ]"   

     info="priority 8208, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 7   switch=faucet version=4 match=" [ { vlanvid=1064 } ]"   

     actions=" [ { apply-actions= [ { popvlan={} }; { output={ port=1; max_len=0 } }; { output={ port=2; max_len=0 } } ]   

        } ]"   

     info="priority 8192, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 8   switch=faucet version=4 match=" []" actions=" []"   

     info="priority 0, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=4  

  

 9   switch=faucet version=4 match=" []" actions=" [ { goto=4 } ]"   

     info="priority 0, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=3  

  

10   switch=faucet version=4 match=" [ { ethtype=9000 } ]" actions=" []"   

     info="priority 20490, idletimeout 0, hardtimeout 0, cookie 1524372928, removenotify 0" table-id=2  

  

11   switch=faucet version=4 match=" [ { vlanvid=1064 } ]"   

     actions=" [ { apply-actions= [ { output={ port=4294967293; max_len=96 } } ] }; { goto=3 } ]" 

```

--------------------------------

### Example web-proxy log entries

Source: https://manual.mikrotik.com/docs/network-management/proxy/web-proxy

Example log entries showing the client address, method, URL, access list action, and cache status for a GET and a CONNECT request. These entries appear when the web-proxy logging rule is active.

```routeros
web-proxy,account 192.168.88.10 GET http://example.com/  action=allow cache=MISS  

web-proxy,account 192.168.88.10 CONNECT example.com:443  action=allow cache=MISS  


```

--------------------------------

### netinstall-cli command syntax

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/netinstall/netinstall-linux

Command-line syntax for netinstall-cli. Shows all available options and arguments. Requires root privileges.

```bash
netinstall-cli [-r] [-e] [-b] [-m [-o]] [-f] [-c] [-v] [--reboot] [--shutdown] [-k <keyfile>] [-s <userscript>] [-sm <modescript>] [--mac <mac address>] {-i <interface> | -a <client-ip>} [PACKAGE]+   

```

--------------------------------

### Mark traffic for queue testing

Source: https://manual.mikrotik.com/docs/firewall-and-quality-of-service/queues/htb-hierarchical-token-bucket

Marks all traffic to and from 192.168.88.101 with the packet-mark pc1_traffic. This is the prerequisite setup for the queue examples that follow.

```routeros
/ip/firewall/mangle  

add chain=forward action=mark-connection connection-mark=no-mark src-address=192.168.88.101 new-connection-mark=pc1_conn  

add chain=forward action=mark-connection connection-mark=no-mark dst-address=192.168.88.101 new-connection-mark=pc1_conn  

add chain=forward action=mark-packet connection-mark=pc1_conn new-packet-mark=pc1_traffic  


```

--------------------------------

### Example output with old login method

Source: https://manual.mikrotik.com/docs/developer-guides/api

Shows the terminal output of running the API client with the old login method. The output includes the login sequence and a /user/getall command with its response.

```text
debian@localhost:~/api-test$ ./api.py 10.0.0.1 admin ''  

<<< /login  

<<<  

>>> !done  

>>> =ret=93b438ec9b80057c06dd9fe67d56aa9a  

>>>  

<<< /login  

<<< =name=admin  

<<< =response=00e134102a9d330dd7b1849fedfea3cb57  

<<<  

>>> !done  

>>>  

/user/getall  

  

<<< /user/getall  

<<<  

>>> !re  

>>> =.id=*1  

>>> =disabled=no  

>>> =name=admin  

>>> =group=full  

>>> =address=0.0.0.0/0  

>>> =netmask=0.0.0.0  

>>>  

>>> !done  

>>>  
```

--------------------------------

### Netinstall devices install command with parameters

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/netinstall/netinstall-package

Command to install RouterOS on devices from the Netinstall Devices menu. Overrides previously set settings when additional parameters are chosen. The example sets auto-reboot to reboot, adds the user-manager package, and specifies version 7.24beta1.

```routeros
/tool/netinstall/devices> install auto-reboot=reboot extra-packages=user-manager version=7.24beta1
```

--------------------------------

### Download thingsboard.yml via SFTP and verify

Source: https://manual.mikrotik.com/docs/containers/user-guides/container-thingsboard-mqtt-http-server

Download the thingsboard.yml configuration file using the get command, then quit SFTP and verify the file is present in the local directory. The file is downloaded to the directory from which SFTP was initiated.

```sftp
sftp> get thingsboard.yml  

Fetching /ThingsBoard/usr/share/thingsboard/conf/thingsboard.yml to thingsboard.yml  

/ThingsBoard/usr/share/thingsboard/conf/thingsboard.yml                               100%   67KB   2.0MB/s   00:00  

sftp> quit  

c:\Users\Admin\Desktop\ThingsBoard>dir  

 Directory of c:\Users\Admin\Desktop\ThingsBoard  

30.01.2023  10:59    <DIR>          .  

30.01.2023  10:59    <DIR>          ..  

27.01.2023  15:09             2 448 keystore.p12  

27.01.2023  15:36             2 434 mqttserver.p12  

30.01.2023  10:59            68 846 thingsboard.yml  

               3 File(s)         73 728 bytes  

               2 Dir(s)  50 901 626 880 bytes free  

```

--------------------------------

### Get string length with :len

Source: https://manual.mikrotik.com/docs/developer-guides/scripting

Returns the string length or array element count. The example prints the length of the string "length=8".

```routeros
:put [:len "length=8"];
```

--------------------------------

### Start PostgreSQL Container

Source: https://manual.mikrotik.com/docs/containers/user-guides/container-postgres

Starts the PostgreSQL container, launching the database server and automatically creating the initial database and user based on the configured environment variables.

```routeros
/container/start [find where name=postgres]  
```

--------------------------------

### List packages with /system/package/print

Source: https://manual.mikrotik.com/docs/getting-started/installation-and-upgrade/packages

Lists installed and available packages on the router. The output shows flags X (disabled) and A (available), along with columns for name, version, scheduled, build-time, and size. In the example, zerotier is disabled but installed, iot is available but not downloaded, and dude is scheduled for uninstall.

```routeros
/system/package/print   

Flags: X - DISABLED; A - AVAILABLE  

Columns: NAME, VERSION, SCHEDULED, BUILD-TIME, SIZE  

#    NAME            VERSION     SCHEDULED                      BUILD-TIME           SIZE    

0    wireless        7.24beta1                                  2026-05-26 10:47:52  1388.1KiB  

1 X  container       7.24beta1                                  2026-05-26 10:47:52  1156.1KiB  

2    routeros        7.24beta1                                  2026-05-26 10:47:52  11.0MiB    

3    zerotier        7.24beta1                                  2026-05-26 10:47:52  372.1KiB   

4 XA calea                                                                           20.1KiB    

5 XA gps                                                                             24.1KiB    

6 XA iot                                                                             788.1KiB   

7 XA openflow                                                                        76.1KiB    

8 XA tr069-client                                                                    120.1KiB   

9 XA ups                                                                             44.1KiB   


```

--------------------------------

### Navigate to the target directory

Source: https://manual.mikrotik.com/docs/containers/user-guides/container-mosquitto-mqtt-server

Navigate to the directory where you want to download the mosquitto configuration file. This example uses the 'Container' folder on the Desktop.

```cmd
C:\WINDOWS\system32>cd C:\Users\Administrator\Desktop\Container  

  

C:\Users\Administrator\Desktop\Container>  

```

--------------------------------

### View OpenFlow fast path statistics

Source: https://manual.mikrotik.com/docs/network-management/openflow

Shows fast path statistics for OpenFlow. In this example, the fast path does not work because of the complexity of the flows Faucet installs.

```routeros
[admin@CCR2004_2XS_111] /openflow> print fast-path   

  openflow-fast-path-packets: 0 0  

    openflow-fast-path-bytes: 0 0  


```

--------------------------------

### Gateway forwarder log output

Source: https://manual.mikrotik.com/docs/internet-of-things/lora/user-guides/chirpstack

Example log output showing the gateway forwarder starting and becoming ready, followed by Rx frames with CRC errors.

```log
 2026-06-15 14:31:09 lora,info [FWD] gateway-0 forwarder started  

 2026-06-15 14:31:22 lora,info [FWD] gateway-0 forwarder is ready  

 2026-06-15 14:31:41 lora,debug [FWD] gateway-0, Rx, Freq 868.100, CRC Error  

 2026-06-15 14:32:10 lora,debug [FWD] gateway-0, Rx, Freq 867.100, CRC Error  

```

--------------------------------

### Configure PPTP client and print interface

Source: https://manual.mikrotik.com/docs/virtual-private-networks/pptp

Sets up a PPTP client with username MT-User, password StrongPass, and server 192.168.62.2, then prints the interface configuration. The output shows the running interface with default encryption profile, keepalive-timeout=60, and allowed authentication methods pap,chap,mschap1,mschap2.

```routeros
[admin@MikroTik] > /interface/pptp-client/add connect-to=192.168.62.2 disabled=no name=pptp-out1 password=StrongPass user=MT-User  

[admin@MikroTik] > /interface/pptp-client/print   

Flags: X - disabled; R - running   

 0  R name="pptp-out1" max-mtu=1450 max-mru=1450 mrru=disabled connect-to=192.168.62.2 user="MT-User"   

      password="StrongPass" profile=default-encryption keepalive-timeout=60 add-default-route=no   

      dial-on-demand=no allow=pap,chap,mschap1,mschap2   

```

--------------------------------

### Set internal path cost for MSTP port

Source: https://manual.mikrotik.com/docs/bridging-and-switching/user-guides/spanning-tree-protocol

Sets the internal path cost for a specific port in the bridge configuration. This is part of the MSTP example setup.

```routeros
/interface/bridge/port  

set [find where interface=ether3] internal-path-cost=25  

```

--------------------------------

### Enable start-on-boot for a container

Source: https://manual.mikrotik.com/docs/containers

Shows how to enable start-on-boot for a container so it starts after a router reboot. The first command prints the container list to find the container number, and the second sets the start-on-boot option to yes.

```routeros
/container/print  

  0 name="2e679415-2edd-4300-8fab-a779ec267058" tag="test_arm64:latest" os="linux" arch="arm" interface=veth2   

    root-dir=disk1/alpine mountlists="" dns="" logging=yes start-on-boot=yes status=running   

  

/container/set 0 start-on-boot=yes  
```

--------------------------------

### Output of /tool/sniffer/quick

Source: https://manual.mikrotik.com/docs/diagnostics-monitoring-and-troubleshooting/packet-sniffer

Example output from /tool/sniffer/quick showing two DHCP packets. TIME counts seconds since start, '<-' marks received and '->' sent packets.

```text
Columns: TIME, DIR, SRC-ADDRESS, DST-ADDRESS, SIZE  

TIME      DIR  SRC-ADDRESS                DST-ADDRESS                SIZE  

4.922348  ->   192.168.88.24:68 (bootpc)  192.168.88.1:67 (bootps)    342  

4.923657  <-   192.168.88.1:67 (bootps)   192.168.88.24:68 (bootpc)   342  


```

--------------------------------

### MAC-telnet connection example with output

Source: https://manual.mikrotik.com/docs/wireless/w60g/fail-over-ptmp-cli-example

Shows the interactive MAC-telnet session: command, login prompt, password entry, and successful connection output.

```text
[admin@KD_GW] > /tool/mac-telnet C4:AD:34:84:EE:5D  

 Login: admin  

 Password:    

 Trying C4:AD:34:84:EE:5D...  

 Connected to C4:AD:34:84:EE:5D   
```

--------------------------------

### Download and run configuration script

Source: https://manual.mikrotik.com/docs/system-information-and-utilities/fetch

Fetches a configuration script from a server and imports it. check-certificate=yes verifies the server; /import runs every command in the file. A failed download stops the block, preventing an older copy from being imported.

```routeros
{  

    /tool/fetch url="https://config.example.com/branch.rsc" \  

        check-certificate=yes dst-path=branch.rsc  

    /import file-name=branch.rsc  

}  

```

--------------------------------

### Print firewall NAT and filter rules

Source: https://manual.mikrotik.com/docs/network-management/socks

Shows the existing NAT masquerade rule and the filter rule that blocks direct FTP access. Used as the starting point for the FTP-through-SOCKS example.

```routeros
[admin@MikroTik] /ip/firewall/nat> print  

0   chain=srcnat action=masquerade src-address=192.168.0.0/24  

[admin@MikroTik] /ip/firewall/filter> print  

0   chain=forward action=drop protocol=tcp src-address=192.168.0.0/24  

    dst-port=21  

```

--------------------------------

### Configure temperature and humidity histograms

Source: https://manual.mikrotik.com/docs/internet-of-things/lora/user-guides/tg-lr-setup-guide

Example commands to configure histogram bins and epoch intervals for temperature and humidity.

```text
data temp-histo-cfg 1,86400,0,0,1,1,-10,0,10,15,17.5,20,22.5,25.0,30

data humid-histo-cfg 1,86400,0,0,1,1,10,20,30,40,50,60,70,80,90
```

--------------------------------

### Get property value from hw-info as-value array

Source: https://manual.mikrotik.com/docs/developer-guides/scripting/scripting-tips-and-tricks

Retrieves a specific property value from the 1-D array returned by `hw-info wlan1 as-value` using the `->` operator. The example prints the value of `tx-chains`.

```routeros
[admin@1p_DUT_wAP ac] /interface wireless info> :put ([hw-info wlan1 as-value ]->"tx-chains")  

0;1  


```
Tokens:
Raw