doc_title
string
doc_section
string
source_url
string
section_count
int64
section_1_title
string
section_1_content
string
section_1_level
float64
section_2_title
string
section_2_content
string
section_2_level
float64
section_3_title
string
section_3_content
string
section_3_level
float64
section_4_title
string
section_4_content
string
section_4_level
float64
section_5_title
string
section_5_content
string
section_5_level
float64
section_6_title
string
section_6_content
string
section_6_level
float64
section_7_title
string
section_7_content
string
section_7_level
float64
section_8_title
string
section_8_content
string
section_8_level
float64
section_9_title
string
section_9_content
string
section_9_level
float64
section_10_title
string
section_10_content
string
section_10_level
float64
section_11_title
string
section_11_content
string
section_11_level
float64
section_12_title
string
section_12_content
string
section_12_level
float64
section_13_title
string
section_13_content
string
section_13_level
float64
section_14_title
string
section_14_content
string
section_14_level
float64
section_15_title
string
section_15_content
string
section_15_level
float64
section_16_title
string
section_16_content
string
section_16_level
float64
section_17_title
string
section_17_content
string
section_17_level
float64
section_18_title
string
section_18_content
string
section_18_level
float64
section_19_title
string
section_19_content
string
section_19_level
float64
section_20_title
string
section_20_content
string
section_20_level
float64
section_21_title
string
section_21_content
string
section_21_level
float64
section_22_title
string
section_22_content
string
section_22_level
float64
section_23_title
string
section_23_content
string
section_23_level
float64
section_24_title
string
section_24_content
string
section_24_level
float64
section_25_title
string
section_25_content
string
section_25_level
float64
section_26_title
string
section_26_content
string
section_26_level
float64
section_27_title
string
section_27_content
string
section_27_level
float64
section_28_title
string
section_28_content
string
section_28_level
float64
section_29_title
string
section_29_content
string
section_29_level
float64
section_30_title
string
section_30_content
string
section_30_level
float64
section_31_title
string
section_31_content
string
section_31_level
float64
section_32_title
string
section_32_content
string
section_32_level
float64
section_33_title
string
section_33_content
string
section_33_level
float64
section_34_title
string
section_34_content
string
section_34_level
float64
section_35_title
string
section_35_content
string
section_35_level
float64
section_36_title
string
section_36_content
string
section_36_level
float64
section_37_title
string
section_37_content
string
section_37_level
float64
section_38_title
string
section_38_content
string
section_38_level
float64
section_39_title
string
section_39_content
string
section_39_level
float64
section_40_title
string
section_40_content
string
section_40_level
float64
section_41_title
string
section_41_content
string
section_41_level
float64
section_42_title
string
section_42_content
string
section_42_level
float64
section_43_title
string
section_43_content
string
section_43_level
float64
section_44_title
string
section_44_content
string
section_44_level
float64
section_45_title
string
section_45_content
string
section_45_level
float64
section_46_title
string
section_46_content
string
section_46_level
float64
section_47_title
string
section_47_content
string
section_47_level
float64
section_48_title
string
section_48_content
string
section_48_level
float64
section_49_title
string
section_49_content
string
section_49_level
float64
section_50_title
string
section_50_content
string
section_50_level
float64
section_51_title
string
section_51_content
string
section_51_level
float64
section_52_title
string
section_52_content
string
section_52_level
float64
section_53_title
string
section_53_content
string
section_53_level
float64
section_54_title
string
section_54_content
string
section_54_level
float64
section_55_title
string
section_55_content
string
section_55_level
float64
section_56_title
string
section_56_content
string
section_56_level
float64
section_57_title
string
section_57_content
string
section_57_level
float64
section_58_title
string
section_58_content
string
section_58_level
float64
section_59_title
string
section_59_content
string
section_59_level
float64
section_60_title
string
section_60_content
string
section_60_level
float64
section_61_title
string
section_61_content
string
section_61_level
float64
section_62_title
string
section_62_content
string
section_62_level
float64
section_63_title
string
section_63_content
string
section_63_level
float64
section_64_title
string
section_64_content
string
section_64_level
float64
section_65_title
string
section_65_content
string
section_65_level
float64
section_66_title
string
section_66_content
string
section_66_level
float64
section_67_title
string
section_67_content
string
section_67_level
float64
section_68_title
string
section_68_content
string
section_68_level
float64
section_69_title
string
section_69_content
string
section_69_level
float64
section_70_title
string
section_70_content
string
section_70_level
float64
section_71_title
string
section_71_content
string
section_71_level
float64
section_72_title
string
section_72_content
string
section_72_level
float64
section_73_title
string
section_73_content
string
section_73_level
float64
section_74_title
string
section_74_content
string
section_74_level
float64
section_75_title
string
section_75_content
string
section_75_level
float64
section_76_title
string
section_76_content
string
section_76_level
float64
section_77_title
string
section_77_content
string
section_77_level
float64
section_78_title
string
section_78_content
string
section_78_level
float64
section_79_title
string
section_79_content
string
section_79_level
float64
section_80_title
string
section_80_content
string
section_80_level
float64
section_81_title
string
section_81_content
string
section_81_level
float64
section_82_title
string
section_82_content
string
section_82_level
float64
section_83_title
string
section_83_content
string
section_83_level
float64
section_84_title
string
section_84_content
string
section_84_level
float64
section_85_title
string
section_85_content
string
section_85_level
float64
section_86_title
string
section_86_content
string
section_86_level
float64
section_87_title
string
section_87_content
string
section_87_level
float64
section_88_title
string
section_88_content
string
section_88_level
float64
section_89_title
string
section_89_content
string
section_89_level
float64
section_90_title
string
section_90_content
string
section_90_level
float64
section_91_title
string
section_91_content
string
section_91_level
float64
6to4
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/135004174/6to4
5
Summary
Sub-menu:/interface 6to4 ``` /interface 6to4 ``` 6to4 is a special mechanism that allows IPv6 packets to be transmitted over IPv4 networks without the need of explicitly configured tunnel interfaces. It is especially useful for connecting two or more IPv6 networks over a network that does not have IPv6 support. There a...
1
Property Description
Property | Description ---------------------- clamp-tcp-mss(yes | no; Default:yes) | Controls whether to change MSS size for received TCP SYN packets. When enabled, a router will change the MSS size for received TCP SYN packets if the current MSS size exceeds the tunnel interface MTU (taking into account the TCP/IP ove...
1
Configuration Examples
1
Simple 6to4 tunnel encapsulation (Currently not working)
It is possible to simply route IPv6 packets over IPv4 network by utilizing the 2002::/16 allocated address space. All 6to4 nodes has to have reachable IPv4 addresses - if you are running this setup over the Internet, all IPv4's must be public addresses. R1 configuration: Create the 6to4 tunnel interface: ``` /interface...
1
Hurricane Electric Tunnel Broker Example
Following example will show how to get IPv6 connectivity on a RouterOS device through IPv4 network using 6to4 tunnel. To be able to create the tunnel, you have to have a public IPv4 address and enable ping from Tunnel Broker IPv4 server. When you create a tunnel usingHurricane Electric Tunnel Broker, you will be given ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Address-lists
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/130220135/Address-lists
4
1Summary2PropertiesSummary
``` /ip firewall address-list ``` Firewall address lists allow a user to create lists of IP addresses grouped together under a common name. Firewall filter, mangle, and NAT facilities can then use those address lists to match packets against them. The address list records can also be updated dynamically via theaction=a...
1
Properties
Property | Description ---------------------- address(DNS Name | IP address/netmask | IP-IP; Default:) | A single IP address or range of IPs to add to the address list or DNS name. You can input for example, '192.168.0.0-192.168.1.255' and it will auto modify the typed entry to 192.168.0.0/23 on saving. dynamic(yes,no)...
1
LIST ADDRESS
0 drop_traffic 192.0.34.166 ``` ``` /ip firewall mangle add action=add-src-to-address-list address-list=drop_traffic address-list-timeout=5m chain=prerouting dst-port=23 protocol=tcp /ip firewall filter add action=drop chain=input src-address-list=drop_traffic ``` ``` /ip firewall address-list print Flags: X - disabl...
1
LIST ADDRESS
0 drop_traffic 192.0.34.166 1 D drop_traffic 1.1.1.1 2 D drop_traffic 10.5.11.8 ``` As seen in the output of the last print command, two new dynamic entries appeared in the address list (marked with a status of 'D'). Hosts with these IP addresses tried to initialize a telnet session to the router and were then subseq...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
API
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/47579160/API
24
Summary
Application Programmable Interface (API) allows users to create custom software solutions to communicate with RouterOS to gather information, adjust the configuration, and manage the router. API closely follows syntax from the command-line interface (CLI). It can be used to create translated or custom configuration too...
1
Protocol
Communication with the router is done by sending sentences and receiving one or more sentences in return. A sentence is a sequence of words terminated by zero-length words. Word is part of a sentence encoded in a certain way - encoded length and data. Communication happens by sending sentences to the router and receivi...
1
API words
Words are part of a sentence. Each word has to be encoded in a certain way - the length of the word followed by the word content. The length of the word should be given as a count of bytes that are going to be sent. The length of the word is encoded as follows: Value of length | # of bytes | Encoding ------------------...
1
Command word
The first word in the sentence has to be a command followed by attribute words and a zero-length word or terminating word. The name of the command word should begin with '/'. Names of commands closely follow CLI, with spaces replaced with '/'. Some commands are specific to API; Command word structure in the strict orde...
1
Attribute word
Eachcommand wordhas its list ofattribute wordsdepending on content. Attribute wordstructure consists of 5 parts in this order: Examples without encoded length prefix: ``` =address=10.0.0.1 ``` ``` =name=iu=c3Eeg ``` ``` =disable-running-check=yes ```
1
API attribute word
API attribute word structure is in the strict order: Currently, the only such API attribute is thetag.
1
Query word
Sentences can have additional query parameters that restrict their scope. A detailed explanation is in thequery section. Example of a sentence using query word attributes: ``` /interface/print ?type=ether ?type=vlan ?# |! ```
1
Reply word
It is only sent by the router in response to the full sentence received from the client.
1
API sentences
API sentence is the main object of communication using API.
1
Initial login
Note:that each command and response ends with an empty word. Login method post-v6.43: /login =name=admin =password= !done
1
Tags
1
Command description
1
Queries
Theprintcommand accepts query words that limit the set of returned sentences. Query | Description ------------------- ?name | pushes 'true' if an item has a value of propertyname, 'false' if it does not. ?-name | pushes 'true' if an item does not have a value of propertyname, 'false' otherwise. ?name=x?=name=x | pushes...
1
OID
Theprintcommand can return OID values for properties that are available in SNMP. In the console, OID values can be seen by running the 'print oid' command. In API, these properties have a name that ends with ".oid", and can be retrieved by adding their name to the value of '.proplist'. An example: /system/resource/prin...
1
!trap
When for some reason API sentence fails trap is sent in return accompanied by amessageattribute and on some occasionscategoryargument.
1
message
When an API sentence fails, some generic message or message from the used internal process is returned to give more details about the failure ``` <<< /ip/address/add <<< =address=192.168.88.1 <<< =interface=asdf <<< >>> !trap >>> =category=1 >>> =message=input does not match any value of interface ```
1
category
if it is a general error, it is categorized and the error category is returned. possible values for this attribute are
1
Command examples
1
/system/package/getall
/system/package/getall !re =.id=*5802 =disabled=no =name=routeros-x86 =version=3.0beta2 =build-time=oct/18/2006 16:24:41 =scheduled= !re =.id=*5805 =disabled=no =name=system =version=3.0beta2 =build-time=oct/18/2006 17:20:46 =scheduled= ... more !re sentences ... !re =.id=*5902 =disabled=no =name=advanced-tools =versio...
1
/user/active/listen
/user/active/listen !re =.id=*68 =radius=no =when=oct/24/2006 08:40:42 =name=admin =address=0.0.0.0 =via=console !re =.id=*68 =.dead=yes ... more !re sentences ...
1
/cancel, simultaneous commands
/login !done =ret=856780b7411eefd3abadee2058c149a3 /login =name=admin =response=005062f7a5ef124d34675bf3e81f56c556 !done --first start listening for interface changes (tag is 2) /interface/listen .tag=2 --disable interface (tag is 3) /interface/set =disabled=yes =.id=ether1 .tag=3 --this is done for disable command (ta...
1
Example client
A simpleAPI client in Python3 Example output: ``` 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 >>> =.i...
1
See also
1
API examples
API implementations in different languages, provided by different sources. They are not ordered in any particular order. * in C++17by Ayman Al-Qadhi
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
AP Controller (CAPsMAN)
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/1409149/AP+Controller+CAPsMAN
31
Overview
CAPsMAN allows applying wireless settings to multiple MikroTik AP devices from a central configuration interface. More specifically, the Controlled Access Point system Manager (CAPsMAN) allows centralization of wireless network management and if necessary, data processing. When using the CAPsMAN feature, the network wi...
1
Simple setup of a CAPsMAN system
Before deep-diving into the details of CAPsMAN operation, let us quickly illustrate how to set up the most basic system where you have a MikroTik router that manages two MikroTik AP devices. The benefit of CAPsMAN is that the CAP units don't need to be configured, all settings are done in the CAPsMAN server. The CAPsMA...
1
CAP to CAPsMAN Connection
For the CAPsMAN system to function and provide wireless connectivity, a CAP must establish management connection with CAPsMAN. A management connection can be established using MAC or IP layer protocols and is secured using 'DTLS'. A CAP can also pass the client data connection to the Manager, but the data connection is...
1
CAP Auto Locking to CAPsMAN
CAP can be configured to automatically lock to a particular CAPsMAN server. Locking is implemented by recording certificate CommonName of CAPsMAN that CAP is locked to and checking this CommonName for all subsequent connections. As this feature is implemented using certificate CommonName, use of certificates is mandato...
1
Auto Certificates
To simplify CAPsMAN and CAP configuration when certificates are required (e.g. for automatic locking feature), CAPsMAN can be configured to generate necessary certificates automatically and CAP can be configured to request certificate from CAPsMAN. Automatic certificates do not provide full public key infrastructureand...
1
CAP Configuration
When an AP is configured to be controlled by CAPsMAN, configuration of the managed wireless interfaces on the AP is ignored(exceptions: antenna-gain,antenna-mode). Instead, AP accepts configuration for the managed interfaces from CAPsMAN. CAP behavior of AP is configured in/interface wireless capmenu. From there you ca...
1
CAPsMAN Global Configuration
Settings to enable CAPsMAN functionality are found in/caps-man managermenu: Property | Description ---------------------- enabled(yes | no; Default:no) | Disable or enable CAPsMAN functionality certificate(auto | certificate name | none; Default:none) | Device certificate ca-certificate(auto | certificate name | none; ...
1
Radio Provisioning
CAPsMAN distinguishes between CAPs based on an identifier. The identifier is generated based on the following rules: When the DTLS connection with CAP is successfully established (which means that CAP identifier is known and valid), CAPsMAN makes sure there is no stale connection with CAP using the same identifier. Cur...
1
ADDRESS IDENT STATE RADIOS
0 00:0C:42:00:C0:32/27044 MT-000C4200C032 Run 1 ``` CAPsMAN distinguishes between actual wireless interfaces (radios) based on their builtin MAC address (radio-mac). This implies that it is impossible to manage two radios with the same MAC address on one CAPsMAN. Radios currently...
1
RADIO-MAC INTERFACE REMOTE-AP-IDENT
0 P 00:03:7F:48:CC:07 cap1 MT-000C4200C032 ``` When CAP connects, CAPsMAN at first tries to bind each CAP radio to CAPsMAN master interface based on radio-mac. If an appropriate interface is found, radio gets set up using master interface configuration and configuration of slave inte...
1
Interface Configuration
CAPsMAN interfaces are managed in/caps-man interfacemenu: ``` [admin@CM] > /caps-man interface print Flags: M - master, D - dynamic, B - bound, X - disabled, I - inactive, R - running
1
NAME RADIO-MAC MASTER-INTERFACE
0 M BR cap2 00:0C:42:1B:4E:F5 none 1 B cap3 00:00:00:00:00:00 cap2 ```
1
Master Configuration Profiles
Configuration profiles permit pre-defined 'top level' master settings to be applied to CAP radios being provisioned. Configuration Profiles are configured in/caps-man configurationmenu: Property | Description ---------------------- channel(list; Default: ) | User defined list taken from Channel names (/caps-man channel...
1
Channel Groups
Channel group settings allows for the configuration of lists of radio channel related settings, such as radio band, frequency, Tx Power extension channel and width. Channel group settings are configured in the Channels profile menu/caps-man channels Property | Description ---------------------- band(2ghz-b | 2ghz-b/g |...
1
Datapath Configuration
Datapath settings control data forwarding related aspects. On CAPsMAN datapath settings are configured in datapath profile menu/caps-man datapathor directly in a configuration profile or interface menu as settings withdatapath.prefix. There are 2 major forwarding modes: Forwarding mode is configured on a per-interface ...
1
Local Forwarding Mode
In this mode wireless interface on CAP behaves as a normal interface and takes part in normal data forwarding. Wireless interface will accept/pass data to networking stack on CAP. CAPsMAN will not participate in data forwarding and will not process any of data frames, it will only control interface configuration and cl...
1
NAME TYPE MTU L2MTU MAX-L2MTU
... 2 RS ;;; managed by CAPsMAN ;;; channel: 5180/20-Ceee/ac, SSID: master, local forwarding wlan2 wlan 1500 1600 3 DRS ;;; managed by CAPsMAN ;;; SSID: slave, local forwarding wlan6 wlan 1500 1600 ... [admin@CAP] /interface> wireless pr Flags...
1
Manager Forwarding Mode
In this mode CAP sends all data received over wireless to CAPsMAN and only sends out over wireless, data received from CAPsMAN. CAPsMAN has full control over data forwarding including client-to-client forwarding. Wireless interface on CAP is disabled and does not participate in networking: ``` ... 1 X  ;;; managed by C...
1
Access List
Access list on CAPsMAN is an ordered list of rules that is used to allow/deny clients to connect to any CAP under CAPsMAN control. When client attempts to connect to a CAP that is controlled by CAPsMAN, CAP forwards that request to CAPsMAN. As a part of registration process, CAPsMAN consults access list to determine if...
1
Registration Table
Registration table contains a list of clients that are connected to radios controlled by CAPsMAN and is available in/caps-man registration-tablemenu: ``` [admin@CM] /caps-man> registration-table print
1
INTERFACE MAC-ADDRESS UPTIME RX-SIGNAL
0 cap1 00:03:7F:48:CC:0B 1h38m9s210ms -36 ```
1
Examples
1
Basic configuration with master and slave interface
Create security profile for WPA2 PSK, without specifying passphrase: ``` [admin@CM] /caps-man security>add name="wpa2psk" authentication-types=wpa2-psk encryption=aes-ccm ``` Create configuration profile to be used by master interface ``` [admin@CM] /caps-man configuration> add name=master-cfg ssid=master security=wpa2...
1
NAME RADIO-MAC MASTER-INTERFACE
0 MDB  ;;; unsupported band or channel cap3 00:0C:42:1B:4E:FF none ... ``` We can override channel settings for this particular radio in interface settings, without affecting master-cfg profile: ``` [admin@CM] /caps-man interface> set cap3 channel.frequency=2142 channel.band=2ghz-b/g ```...
1
Configuration with certificates
You would want to configure certificates in your CAPsMAN to use options asRequire Peer CertificateandLock To Caps Man. These options increase security and in some cases stability of your CAPsMAN network. CAPs won't connect to CAPsMAN without a specific certificate and vice versa.
1
Fast and easy configuration
This is a basic configuration for using certificates in your CAPsMAN setup. This example assumes that you already have basic configuration on your CAPsMAN and CAP. It is best to use this configuration in CAPsMAN networks which are not constantly growing. For more details read aboutCAP to CAPsMAN Connection. CAPsMAN dev...
1
NAME COMMON-NAME SUBJECT-ALT-NAME FINGERPRINT
0 A T _0 CAPsMAN-CA-D4CA6D987C26 383e63d7b... 1 K CAP-D4CA6D7F45BA CAP-D4CA6D7F45BA d495d1a94... ``` On CAPsMAN device in Certificate menu three certificates are cre...
1
NAME COMMON-NAME SUBJECT-ALT-NAME FINGERPRINT
0 K A T CAPsMAN-CA-D4CA6D987C26 CAPsMAN-CA-D4CA6D987C26 383e63d7b... 1 K I CAPsMAN-D4CA6D987C26 CAPsMAN-D4CA6D987C26 02b0f7ff4... 2 I issued_1 CAP-D4CA6D7F45BA ...
1
Manual certificates and issuing with SCEP
With this example, you can create your own certificates for CAPsMAN and take control over issuing certificates to CAPs. This configuration can be useful in big, growing CAPsMAN networks. Many segments of this example can be done differently depending on your situation and needs. At this point, some knowledge aboutCerti...
1
NAME COMMON-NAME SUBJECT-ALT-NAME FINGERPRINT
0 K L A T CA CA 752775b457a37... 1 K A CAPsMAN CAPsMAN 12911ba445b3b... 2 I issued_1 CAP1 5b9a52b6ce3fb...
1
NAME COMMON-NAME SUBJECT-ALT-NAME FINGERPRINT
0 L A T cert_exp... CA 752775b457a37... 1 K T CAP1 CAP1 5b9a52b6ce3fb... ```
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
ARP
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/100892687/ARP
10
Summary
Sub-menu:/ip arp ``` /ip arp ``` Even though IP packets are addressed usingIP addresses, hardware addresses must be used to transport data from one host to another. Address Resolution Protocol is used to map OSI level 3 IP addresses to OSI level 2 MAC addresses. A router has a table of currently used ARP entries. Norma...
1
Properties
This section describes the ARP table configuration options. Property | Description ---------------------- address(IP; Default:) | IP address to be mapped interface(string; Default:) | Interface name the IP address is assigned to mac-address(MAC; Default:00:00:00:00:00:00) | MAC address to be mapped to published(yes | n...
1
ARP Modes
It is possible to set several ARP modes on the interface configuration. ``` disabled ``` ``` enabled ``` ``` local-proxy-arp ``` ``` proxy-arp ``` ``` reply-only ```
1
Disabled
If the ARP feature is turned off on theinterface, i.e.,arp=disabledis used, ARP requests from clients are not answered by the router. Therefore, a static ARP entry should be added to the clients as well. For example, the router's IP and MAC addresses should be added to the Windows workstations using the arp command: ``...
1
Enabled
This mode is enabled by default on all interfaces. ARPs will be discovered automatically and new dynamic entries will be added to the ARP table.
1
Proxy ARP
A router with a properly configured proxy ARP feature acts as a transparent ARP proxy between different networks. This behavior can be useful, for example, if you want to assign dial-in (ppp, pppoe, pptp) clients' IP addresses from the same address space as used on the connected LAN. Proxy ARP can be enabled on each in...
1
NAME MTU MAC-ADDRESS ARP
0 R ether1 1500 00:30:4F:0B:7B:C1 enabled 1 R ether2 1500 00:30:4F:06:62:12 proxy-arp ```
1
Reply Only
If ARP property is set toreply-onlyon the interface, then the router only replies to ARP requests. Neighbor MAC addresses will be resolved only using statically configured entries from the "/ip arp" menu, but there will be no need to add the router's MAC address to other hosts' ARP tables like in case if ARP isdisabled...
1
Local Proxy Arp
If the ARP property is set tolocal-proxy-arpon an interface, then the router performs proxy ARP to/from this interface only. i.e. for traffic that comes in and goes out of the same interface. In a normal LAN, the default behavior is for two network hosts to communicate directly with each other, without involving the ro...
1
Gratuitous ARP
It is possible to create Gratuitous ARP requests in RouterOS. To do so you must use the Traffic-Generator tool, below is an example of how to generate a Gratuitous ARP request to update the ARP table on a remote device: ``` /tool traffic-generator inject interface=ether2 \ data="ffffffffffff4c5e0c14ef780806000108000604...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Authentication, Authorization, Accounting
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/119144604/Authentication+Authorization+Accounting
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
AWS LoRaWAN configuration
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/232816782/AWS+LoRaWAN+configuration
9
AWS - Registering the gateway
The first step is to register the LoRaWAN gateway. Navigate to theGatewayssection (underLPWAN devices). Click on the "Add gateway" button.
1
Step 1 - add gateway
Finish the step by clicking on the "Add gateway" once again. In RouterOS settings, gateway's EUI and frequency plan can be checked underIoT>LoRa>Devicestab:
1
Step 2 - configure your gateway
Finish the step by clicking on "Submit". You will be redirected to the page where your newly created gateway should appear.
1
RouterOS - Connecting the gateway
1
Uploading and importing certificates
Before we proceed with the setup, you need to downloadAmazon Root CAand upload it, together with the gateway certificate file and its key, into the RouerOS file list menu: After the files were uploaded, import the certificates, one by one (underSystem>Certificates): Make sure to upload the gateway certificate first and...
1
Server configuration
1
LNS scenario
Navigate to theIoT>LoRa>Serverstab and add a new server: ``` wss:// ``` ``` :443 ``` Make sure to apply newly configured server underIoT>LoRa>Devicestab: And then,enablethe LoRa interface.
1
CUPS scenario
Navigate to theIoT>LoRa>Serverstab and add a new server: ``` https:// ``` ``` :443 ``` Make sure to apply newly configured server underIoT>LoRa>Devicestab: And then,enablethe LoRa interface.
1
Connection verification
If everything is configured correctly, you should see "connected" status on the AWS portal:
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Backup
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/40992852/Backup
6
Summary
The RouterOS backup feature allows cloning a router configuration in binary format, which can then be re-applied on the same device. The system's backup file also contains the device's MAC addresses, which are restored when the backup file is loaded. We recommend restoring the backup on the same version of RouterOS.
1
Saving a backup
Sub-menu:/system backup save ``` /system backup save ``` Property | Description ---------------------- dont-encrypt(yes | no; Default:no) | Disable backup file encryption. Note that since RouterOS v6.43 without a providedpassword,the backup file is unencrypted. encryption(aes-sha256 | rc4; Default:aes-sha256) | The enc...
1
Loading a backup
Load units backup without password: ``` [admin@MikroTik] > system/backup/load name=auto-before-reset.backup password="" ``` Property | Description ---------------------- name(string; Default: ) | File name for the backup file. password(string; Default: ) | Password for the encrypted backup file.
1
Example
To save the router's configuration to file test and a password: ``` [admin@MikroTik] > /system backup save name=test password=<YOUR_PASSWORD> Configuration backup saved [admin@MikroTik] > /system backup ``` To see the files stored on the router: ``` [admin@MikroTik] > /file print
1
NAME TYPE SIZE CREATION-TIME
0 test.backup backup 12567 sep/08/2018 21:07:50 [admin@MikroTik] > ``` To load the saved backup file test: ``` [admin@MikroTik] > /system backup load name=test password: <YOUR_PASSWORD> Restore and reboot? [y/N]: y Restoring system configuration System configuration restored, rebooting now ```
1
Cloud backup
Since RouterOS v6.44 it is possible to securely store your device's backup file on MikroTik's Cloud servers, read more about this feature on theIP/Cloudpage.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Back To Home
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/197984280/Back+To+Home
10
2Overview2.1Enabling BTH using the app2.2Sharing the BTH connection with another phone user2.3Sharing the BTH tunnel with a computer via the WireGuard(TM) app2.4Configuring BTH manually in RouterOS (optional, if no smartphone is available to you)2.5Removing and disabling connections3Property reference3.1IP Cloud3.2Back...
1
Overview
Sub-menu:/ip cloudPackages required:routerosRouterOS version required:v7.12 and newerHardware requirements:ARM/ARM64/TILE architecture devices ``` /ip cloud ``` ``` routeros ``` Back To Home is a convenience feature, that configures your device for secure VPN access from anywhere in the world to your router and your ne...
1
Enabling BTH using the app
To set up Back to Home, you should have a smartphone with the BTH app and should be inside your home, connected to your routers WiFi network. | | | | | Tap "Create new" | Provide your router credentials | Connection established | Allow VPN to be added | If device is not supported, error is shown -------------------...
1
Sharing the BTH connection with another phone user
It is possible to create Guest tunnels for your friends and family. You can even specify if you want these people to access your local network as well, or if they should be restricted to only use the internet via your router. Once you create shared tunnels, you can send Invitation links via any chat application in your...
1
Sharing the BTH tunnel with a computer via the WireGuard(TM) app
Since there is no BTH app for PCs, you can useWireGuard(TM) appto connect to the shared tunnel. You can even share your connection with yourself, by "inviting" your computer to connect. Let's make a new share, this time for yourself, for using from the PC. | | | | | --------------- Create | Specify name and access ...
1
Configuring BTH manually in RouterOS (optional, if no smartphone is available to you)
``` /ip/cloud/set ddns-enabled=yes ``` ``` /ip/cloud/set back-to-home-vpn=enabled ``` ``` /ip/cloud/print ``` ``` vpn-wireguard-client-config-qrcode ``` ``` vpn-wireguard-client-config ```
1
Removing and disabling connections
In the smartphone app, the VPN configuration is added to the System VPN settings. In this regard, the Back to Home app only acts as a wizard. It supplies needed config to the operating system (this is why iPhone will warn you about altering system configuration). To remove the created connection, go into the smartphone...
1
Property reference
1
IP Cloud
Sub-menu:/ip/cloud/ ``` /ip/cloud/ ``` Back to Home shares the menu with IP Cloud. Back to Home parameters: Property | Description ---------------------- back-to-home-vpn(enabled | revoked-and-disabled; Default:revoked-and-disabled) | Enables or revokes and disables the Back to Home service. ddns-enabled has to be set ...
1
Back to Home users
Sub-menu:/ip/cloud/back-to-home-users/ ``` /ip/cloud/back-to-home-users/ ``` Since RouterOS 7.14 there is a new back to home specific user manager available in the menu/ip/cloud/back-to-home-users>where you can see all the users that are added by the Back to Home mobile app, change their firewall preference and also ad...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bandwidth Test
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/7962644/Bandwidth+Test
4
Summary
``` Sub-menu: /tool Packages required: system ``` The Bandwidth Tester can be used to measure the throughput to another MikroTik router (either wired or wireless) and thereby help to discover network "bottlenecks". The TCP test uses the standard TCP protocol with acknowledgments and follows the TCP algorithm on how man...
1
Bandwidth Test Server
``` Sub-menu: /tool bandwidth-server ``` Property | Description ---------------------- allocate-udp-ports-from(integer 1000..64000; Default:2000) | Beginning of UDP port range authenticate(yes | no; Default:yes) | Communicate only with authenticated clients enabled(yes | no; Default:yes) | Defines whether bandwidth ser...
1
CLIENT PROTOCOL DIRECTION USER
0 35.35.35.1 udp send admin 1 25.25.25.1 udp send admin 2 36.36.36.1 udp send admin [admin@MikroTik] /tool bandwidth-server session> ``` To enablebandwidth-testserver without client authentication: ``` [admin@MikroTik] /tool bandwidth-server> set enabled=yes authenticate=no ...
1
Bandwidth Test Client
``` Sub-menu: /tool bandwidth-test ``` Property | Description ---------------------- address(IP address | IPv6 prefix[%interface]; Default:) | IP address of host direction(both | receive | transmit; Default:receive) | Direction of data flow duration(time; Default:) | Duration of the test interval(time: 20ms..5s; Defaul...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Basic VLAN switching
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/103841826/Basic+VLAN+switching
5
Introduction
Many MikroTik devices come with built-in switch chips that usually have an option to do VLAN switching on a hardware level, this means that you can achieve wire-speed performance using VLANs if a proper configuration method is used. The configuration method changes across different models, this guide will focus on sett...
1
CRS3xx, CRS5xx series switches, CCR2116, CCR2216 andRTL8367, 88E6393X, 88E6191X, 88E6190, MT7621 and MT7531 switch chips
``` /interface bridge add name=bridge1 frame-types=admit-only-vlan-tagged /interface bridge port add bridge=bridge1 interface=ether1 frame-types=admit-only-vlan-tagged add bridge=bridge1 interface=ether2 pvid=20 frame-types=admit-only-untagged-and-priority-tagged add bridge=bridge1 interface=ether3 pvid=30 frame-types=...
1
CRS1xx/CRS2xx series switches
``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether1 add bridge=bridge1 interface=ether2 add bridge=bridge1 interface=ether3 /interface ethernet switch ingress-vlan-translation add ports=ether2 customer-vid=0 new-customer-vid=20 add ports=ether3 customer-vid=0 new-customer-v...
1
Other devices with a built-in switch chip
``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether1 add bridge=bridge1 interface=ether2 add bridge=bridge1 interface=ether3 /interface ethernet switch vlan add ports=ether1,ether2 switch=switch1 vlan-id=20 add ports=ether1,ether3 switch=switch1 vlan-id=30 add ports=ether1,s...
1
Other devices without a built-in switch chip
It is possible to do VLAN filtering using the CPU, there are multiple ways to do it, but it is highly recommended to use bridge VLAN filtering. ``` /interface bridge add name=bridge1 frame-types=admit-only-vlan-tagged /interface bridge port add bridge=bridge1 interface=ether1 frame-types=admit-only-vlan-tagged add brid...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
BFD
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/191299691/BFD
6
Summary
Bidirectional Forwarding Detection (BFD) is a low-overhead and short-duration protocol intended to detect faults in the bidirectional path between two forwarding engines, including physical interfaces, sub-interfaces, data link(s), and to the extent possible the forwarding engines themselves, with potentially very low ...
1
Features not yet supported
1
Configuration
Allowing or forbidding BFD sessions can be done from the/routing bfd configurationmenu. For example: ``` /routing bfd configuration ``` ``` /routing bfd configuration add interfaces=sfp12 forbid-bfd=yes add interfaces=static ``` Configuration entries are order sensitive, which means that in the example above we are for...
1
BFD with BGP
To enable the use of BFD for BGP sessions, enableuse-bfdfor required entries in/routing bgp connectionmenu. ``` use-bfd ``` ``` /routing bgp connection ``` A useful feature is that the BGP session will show that the BFD session for that particular BGP session is down: ``` [admin@dr_02_BGP_MUM] /routing/bgp/session> pri...
1
BFD with OSPF
To enable the use of BFD for OSPF neighbors, enableuse-bfdfor required entries in/routing ospf interface-templatemenu. ``` use-bfd ``` ``` /routing ospf interface-template ```
1
Session Status
The status of the currently available sessions can be observed from/routing bfd sessionmenu: ``` /routing bfd session ``` ``` [admin@dr_02_BGP_MUM] /routing/bfd/session> print Flags: U - up, I - inactive 0 I ;;; BFD forbidden for destination address multihop=yes remote-address=10.155.101.183 local-address="" desired-tx...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
BGP
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328220/BGP
15
Summary
The Border Gateway Protocol (BGP) allows setting up an inter-domain dynamic routing system that automatically updates routing tables of devices running BGP in case of network topology changes. BGP is an inter-autonomous system routing protocol based on the distance-vector algorithm. It is used to exchange routing infor...
1
BGP Terminology
1
BGP Basics
BGP routers exchange reachability information by means of a transport protocol, which in the case of BGP is TCP (port 179). Upon forming a TCP connection these routers exchangeOPENmessages to negotiate and confirm supported capabilities. After agreeing on capabilities to use, the session is considered to be established...
1
Connection Menu
Let's look at a very basic eBGP configuration example assuming, that Router1 IP is 192.168.1.1, AS 65531 and Router2 IP 192.168.1.2, AS 65532: ```
1
Router1
/routing/bgp/connection add name=toR2 remote.address=192.168.1.2 as=65531 local.role=ebgp ``` ```
1
Router2
/routing/bgp/connection add name=toR1 remote.address=192.168.1.1 as=65532 local.role=ebgp ``` The BGP connection menu defines BGP outgoing connections as well as acts as a template matcher for incoming BGP connections. local.roleparameter is used to indicate that this connection will be the eBGP. Also, notice that the ...
1
Session Menu
To see the actual active sessions with selected template parameters and negotiated capabilities refer to the BGP sessions menu: ``` [admin@MikroTik] /routing/bgp/session> print Flags: E - established 0 E name="toR2" remote.address=192.168.1.2 .as=65532 .id=192.168.1.1 .refused-cap-opt=no .capabilities=mp,rr,as4 .afi=ip...
1
Template Menu
The template contains all BGP protocol-related configuration options. It can be used as a template for dynamic peers and to apply a similar configuration to a group of peers. Note that this is not the same as peer groups on Cisco devices, where the group is more than just a common configuration. List of available templ...
1
Best-Path Selection
BGP routers can receive multiple copies of the global routing table from multiple providers. There should be some way to compare those multiple BGP routing tables and select the best route to the destination, the solution is the BGP Best Path Selection Algorithm. The route is evaluated by the algorithm only if it is va...
1
Routing Filter Notes
On BGP output routing filters are executed before BGP itself is modifying attributes, for example, ifnexthop-choiceis set toforce-self, then the gateway set in the routing filters will be overridden. ``` nexthop-choice ``` ``` force-self ``` On BGP input routing filters are applied to the received attributes, which mea...
1
Running More than One Instance
As we already know for best path selection to work properly, BGP routes must be received from the same instance. But in certain scenarios it is necessary to run multiple BGP instances with their own separate tables.BGP determines whether sessions belongs to the same instance by comparing configured local router IDs.For...
1
VPLS
``` VPLS ``` Sub Menu:/routing/bgp/vpls ``` Sub Menu: ``` ``` /routing/bgp/vpls ``` This menu lists all the configured BGP-based VPLS instances. These instances allow the router to advertise VPLS BGP NLRI and indicate that the router belongs to a specific customer VPLS network. MP-BGP-based autodiscovery and signaling ...
1
VPN
``` VPN ``` Sub Menu:/routing/bgp/vpn ``` Sub Menu: ``` ``` /routing/bgp/vpn ```
1
Route Distinguisher
Route Distinguisher is a 64-bit integer, which is divided into three parts: Currently, there are three format types defined. 2bytes | 2bytes | 2bytes | 2bytes | Type1 | Type2 | Type3 --------------------------------------------------------- ASN | 4byte value 4-byte IP | value 4-byte ASN | value
1
Properties
disabled(yes | no) | export- a group of parameters associated with the vpnv4 export | .filter-chain(name) | The name of the routing filter chain that is used to filter prefixes before exporting. .filter-select(name) | The name of the select filter chain that is used to select prefixes to be exported exporting. .redistr...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bluetooth
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/78086201/Bluetooth
21
Summary
Bluetooth is a short-range wireless technology that allows broadcasting the data over specific Bluetooth channels. There are 40 unique bands (channels) and each band has a 2 MHz separation. 37, 38, and 39 channels are used for primary advertising, and 0-36 are used for data transmission. During the advertising process,...
1
Configuration
Sub-menu:/iot bluetooth ``` /iot bluetooth ``` note:iotpackage is required for a device with a build-in Bluetooth chip, like theKNOT note:if your device is ARM, ARM64 architecture and it has a USB slot,iot-bt-extrapackage can enable Bluetooth functionality via USB-Bluetooth dongle. Not all Bluetooth adapters were teste...
1
Devices
In this menu you can check and set general Bluetooth chip parameters: ``` /iot bluetooth print Columns: NAME, PUBLIC-ADDRESS, RANDOM-STATIC-ADDRESS, ANTENNA
1
NAM PUBLIC-ADDRESS RANDOM-STATIC-ADD ANTENNA
0 bt1 00:00:00:00:00:00 F4:4E:E8:04:77:3A internal /iot bluetooth set ``` note:Public address is the IEEE registered, permanent address. This address can not be changed. In the "print" example above, the device does not have a public address assigned (all octets are set to 0). Configurable settings are shown below:...
1
NAM RX-BYTE TX- R T RX-EV TX R T
0 bt1 1857835 235 0 0 46677 45 0 0 ```
1
Advertisers
In this menu, it is possible to set up the Bluetooth chip to broadcast advertising packets. You can check and set advertiser settings with the commands: ``` /iot bluetooth advertisers print Flags: X - DISABLED Columns: DEVICE, MIN-INTERVAL, MAX-INTERVAL, OWN-ADDRESS-TYPE, CHANNEL-MAP, AD-SIZE
1
DEVICE MIN-INTERVAL MAX-INTERVAL OWN-ADDRESS-TYPE CHANNEL-MAP AD-SIZE
0 X bt1 1280ms 2560ms random-static 37 0 38 39 /iot bluetooth advertisers set ``` Configurable settings are shown below: Property | Description ---------------------- ad-structures(string; Default: ) | Choose a pre-configured structure for the advertisement packets. For more inform...
1
AD structures
This section allows you to define the payload for the advertising packets that are going to be broadcasted by the Bluetooth chip. Currently, only 4 types are supported: 0x08 "Shortened Local Name"; 0x09 "Complete Local Name"; 0xFF "Manufacturer Specific Data"; "Service Data" You can check and set "AD structures" settin...
1
NAME TYPE DATA
0 test short-local-name TEST /iot bluetooth advertisers ad-structures set ``` Configurable properties are shown below: Property | Description ---------------------- data(string; Default: ) | Define advertising packet's AdvData part of the payload name(string; Default: ) | Descriptive name of AD structure type(comple...
1
Connections
Currenetly, only "central" role is supported. "Pheriperal device" role, "pairing" and "encryption" options are not supported. ``` central ``` ``` Pheriperal device ``` ``` airing ``` ``` encryption ``` Availible sections are: Section | Description --------------------- async-data | used to view subscribed data. charact...
1
PDEV NAME UUID
0 DC:2C:6E:0F:C0:3D Service Changed 2a05 1 DC:2C:6E:0F:C0:3D Database Hash 2b2a 2 DC:2C:6E:0F:C0:3D Client Supported Features 2b29 3 DC:2C:6E:0F:C0:3D Device Name 2a00 4 DC:2C:6E:0F:C0:3D Appearance 2a01 ... ... ... ```...
1
Scanners
In this menu, you can set up the scanner settings for the Bluetooth chip. When disabled, the device is no longer able to receive advertising reports. When enabled, you can monitor advertising reports in the "Advertising reports" tab (which will be explained later in the guide). You can check and set scanner settings wi...
1
DEVICE TYPE INTERVAL WINDOW OWN-ADDRESS-TYPE FILTER-POLICY FIL
0 X bt1 passive 10ms 10ms random-static default off /iot bluetooth scanners set ``` Configurable properties are shown below: Property | Description ---------------------- disabled(yes | no; Default:no) | An option to disable or enable the Bluetooth chip to receive advertising reports. filter-dup...
1
Advertising reports
In this section, it is possible to monitor Bluetooth advertising reports (from the nearby broadcasters). The list is limited to 1024 entries (if the list gets full with 1024 entries, each new payload received will overwrite the "oldest" one). You can monitor advertising reports with the command: ``` /iot bluetooth scan...
1
DEV PDU-TYPE TIME ADDRES ADDRESS RSSI
0 bt1 adv-noconn-ind jul/28/2021 09:30:56 public 2C:C8:1B:93:16:49 -24dBm 1 bt1 adv-noconn-ind jul/28/2021 09:30:56 random 0B:16:17:9E:7B:EF -60dBm ``` It is possible to set up a filter for the reports with the command: ``` /iot bluetooth scanners advertisements print where ``` For example, to print reports...
1
DEVICE PDU-TYPE TIME ADD... ADDRESS RSSI LENGTH DATA
79 bt1 adv-noconn-ind jul/28/2021 09:46:38 public XX:XX:XX:XX:XX:XX        -70dBm 30 02010... 80 bt1 adv-noconn-ind jul/28/2021 09:46:43 public XX:XX:XX:XX:XX:XX        -67dBm 30 02010... 81 bt1 adv-noconn-ind jul/28/2021 09:46:44 public XX:XX:XX:XX:XX:XX        -70dBm 28 1bff0...
1
DEVICE PDU-TYPE TIME ADDRESS-TYPE ADDRESS RSSI LENGTH DATA
307 bt1 adv-noconn-ind jul/29/2021 10:11:31 public 2C:C8:1B:93:16:49 -24dBm 22 15ff4f09.> 308 bt1 adv-noconn-ind jul/29/2021 10:11:31 public 2C:C8:1B:93:16:49 -26dBm 22 15ff4f09.> ``` Possible filters (you can filter the list of advertising reports with th...
1
Whitelist
In this tab, it is possible to configure a whitelist that is going to be used in the filter policy in the "Scanners" section. In other words, an option to specify which Bluetooth addresses are going to be scanned (displayed in the "Advertising reports"). You can view the whitelisted entries with the command: ``` /iot b...
1
DEVICE ADDRESS-TYPE ADDRESS
0 bt1 any *:*:*:*:*:* ``` You can add a new whitelist entry with the command: ``` /iot bluetooth whitelist add ``` Configurable properties: Property | Description ---------------------- address(MAC address; Default: ) | Advertiser's address address-type(any | public | random; Default:) | Advertiser's addr...
1
Peripheral Devices
This section displays decoded Eddystone TLM, Eddystone UID, iBeacon and MikroTik Bluetooth payloads. If the "Peripheral Devices" captures other beacon types, they will not be decoded. You can view a decoded list with aprint detailcommand: ``` print detail ``` ``` /iot bluetooth peripheral-devices print detail 0 address...
1
Decode-ad
In this menu, you can decode static MikroTik, Eddystone TLM, Eddystone UID and iBeacon payloads. To decode a payload, just input it into the "data" field: ``` /iot bluetooth decode-ad data=0201060303AAFE1116AAFE20000B6E158402353AF20238576B type: eddystone-tlm version: 0 battery-voltage: 2.926V temperature: 21.515C pack...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bluetooth tag-tracking using MQTT and ThingsBoard
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/176914435/Bluetooth+tag-tracking+using+MQTT+and+ThingsBoard
32
Introduction
Bluetooth interface implementation in RouterOS allows the device to capture Bluetooth advertising packets that are broadcasted over 37, 38, and 39 advertising channels. More information can be found in theguide here. Bluetooth tags like, for example,TG-BT5-INandTG-BT5-OUT, do exactly that. They broadcast advertising pa...
1
DEVICE PDU-TYPE TIME ADDRESS-TYPE ADDRESS RSSI LENGTH DATA
0 bt1 adv-noconn-ind mar/07/2023 12:11:57 public DC:2C:6E:0F:C0:3D -51dBm 22 15ff4f09010079100000ffff0000cf188a6b2b000064 1 bt1 adv-noconn-ind mar/07/2023 12:11:58 public 2C:C8:1B:4B:BB:0A -49dBm 22 15ff4f090100168dfefffffffeffa51ae1362200005e ``` The example above shows us, th...
1
Setup requirements:
1
Scenario explanation
Let's take a look at a basic example first. We have two KNOTs (KNOT-A and KNOT-B). We've tested Bluetooth ranges in our environment and could verify that both KNOTs are able to capture the tag at a 70-meter distance. If we install KNOT-A and KNOT-B 140 meters apart, their Bluetooth ranges will not overlap or overlap ju...
1
Example # 1
One of the use cases is shown in the topology below: We have a warehouse area andwe have 3 assets(pallets) that we are interested in tracking.Wealsohave 3 zones: zoneA, where newly arrived pallets are stored; zoneB, where our assets are relocated to be inspected; and zoneC, where assets are moved after inspection. To a...
1
Configuration
In this example, we will showcase a basic topology, when two KNOTs are used and we just want to know whether the tag is located in one part of the building or the other one (whether it is inside zone A or zone B).
1
ThingsBoard preparation
Check the guide overhereto understand how the ThingsBoard and the RouterOS can be set up to utilize MQTT communication. Create 2 KNOTs under the ThingsBoard GUI and make them "gateways". Go to the "Devices" section, click on "+" button and "Add new device": Name the device and checkbox the "Is gateway" option: Do that ...
1
RouterOS configuration
1
Preparation
Before we proceed, we need to confirm that our Bluetooth tag actually appears in the KNOT's Bluetooth range and that the KNOT detects them. To do that, you can issue the command "/iot bluetooth scanners advertisements print": ``` /iot bluetooth scanners advertisements print ``` ``` /iot bluetooth scanners advertisement...
1
DEVICE PDU-TYPE TIME ADDRESS-TYPE ADDRESS RSSI LENGTH DATA
0 bt1 adv-noconn-ind mar/08/2023 12:35:15 public 2C:C8:1B:4B:BB:0A -50dBm 22 15ff4f090100b0110100ffff00000019d68d2300005d 1 bt1 adv-noconn-ind mar/08/2023 12:35:16 public DC:2C:6E:0F:C0:3D -39dBm 22 15ff4f0901008f3cfcfffbfffaff301783c22c000064 2 bt1 adv-n...
1
DEVICE PDU-TYPE TIME ADDRESS-TYPE ADDRESS RSSI LENGTH DATA
0 bt1 adv-noconn-ind mar/08/2023 12:41:06 public DC:2C:6E:0F:C0:3D -49dBm 22 15ff4f0901005ab20100fdfffdff4017e1c32c000064 1 bt1 adv-noconn-ind mar/08/2023 12:41:26 public DC:2C:6E:0F:C0:3D -40dBm 22 15ff4f090100349704000000fcff4017f5c32c000064 2 bt1 adv-noco...
1
MQTT broker
On each KNOT setup MQTT broker. For KNOT A: ``` /iot/mqtt/brokers/add name=tb address=x.x.x.x port=1883 username=knot-A_access_token ``` Where: ``` name ``` ``` address ``` ``` port ``` ``` username ``` For KNOT B → Do the same step. Just changeusernameto the respective access token that was generated for the KNOT B de...
1
Script
Import the script shown below to each KNOT. To do that, just copy the below shown "code" and paste it into a new terminal window and press "ENTER": ``` /system script add dont-require-permissions=no name=tracking owner=admin policy=\ ftp,reboot,read,write,policy,test,password,sniff,sensitive,romon source="# Requ\ ired ...
1
\r\
\n# Name of an existing MQTT broker that should be used for publishing\r\ \n:local broker \"tb\"\r\ \n\r\ \n# MQTT topic where the message should be published\r\ \n:local topic \"v1/gateway/telemetry\"\r\ \n\r\ \n# POSIX regex for filtering advertisement Bluetooth addresses. E.g. \"^BC:33:\ AC\"\r\ \n# would only inclu...
1
\r\
\n:put (\"[*] Gathering Bluetooth info...\")\r\ \n\r\ \n:global makeRecord do={\r\ \n :local jsonStr \"{\\\"ts\\\":\$ts,\\\"values\\\":{\\\"reporter\\\":\\\"\$\ gwName\\\",\\\"rssi\\\":\$rssi}}\"\r\ \n :return \$jsonStr\r\ \n} \r\ \n\r\ \n# array of record strings collected for each advertising MAC address\r\ \...
1
Scheduler
Apply a scheduler to the script, so that RouterOS periodically initiates the script by itself: ``` /system/scheduler/add name=bluetoothscheduler interval=30s on-event="/system/script/run tracking" ``` You can set up shorter and longer intervals. If you want to send data more often, so that the data is "fresher" →  set ...
1
ThingsBoard data visualization and result verification
After you run the script with/system script run trackingor via a scheduler and refresh the GUI portal → all MAC addresses (tags) that are found in the JSON message, will be made into new devices under the ThingsBoard GUI: ``` /system script run tracking ``` To help you visualize the data, you can use the built-inwidget...
1
Example # 2
In the second example, we will showcase another topology: We have a few warehouses, a few company delivery vehicles, and 3 assets that we are interested in tracking. Our assets are pallets that hold cargo and our goals are to know: To achieve Bluetooth asset-tracking, just install x1 KNOT per warehouse, x1 KNOT per veh...
1
Configuration
In this example, we will showcase a basic topology with 2 warehouses, 1 vehicle/truck traveling between them, and 1 asset/pallet/tag.
1
ThingsBoard preparation
Check the guide overhereto understand how the ThingsBoard and the RouterOS can be set up to utilize MQTT communication. Create 3 KNOTs under the ThingsBoard GUI and make them "gateways". Go to the "Devices" section, click on "+" button and "Add new device": Name the device and checkbox the "Is gateway" option: Do that ...
1
RouterOS configuration
1
Preparation
Before we proceed, we need to confirm that our Bluetooth tag actually appears in the KNOT's Bluetooth range and that the KNOT detects them. To do that, you can issue the command "/iot bluetooth scanners advertisements print": ``` /iot bluetooth scanners advertisements print ``` ``` /iot bluetooth scanners advertisement...
1
DEVICE PDU-TYPE TIME ADDRESS-TYPE ADDRESS RSSI LENGTH DATA
0 bt1 adv-noconn-ind mar/08/2023 12:35:15 public 2C:C8:1B:4B:BB:0A -50dBm 22 15ff4f090100b0110100ffff00000019d68d2300005d 1 bt1 adv-noconn-ind mar/08/2023 12:35:16 public DC:2C:6E:0F:C0:3D -39dBm 22 15ff4f0901008f3cfcfffbfffaff301783c22c000064 2 bt1 adv-n...
1
DEVICE PDU-TYPE TIME ADDRESS-TYPE ADDRESS RSSI LENGTH DATA
0 bt1 adv-noconn-ind mar/08/2023 12:41:06 public DC:2C:6E:0F:C0:3D -49dBm 22 15ff4f0901005ab20100fdfffdff4017e1c32c000064 1 bt1 adv-noconn-ind mar/08/2023 12:41:26 public DC:2C:6E:0F:C0:3D -40dBm 22 15ff4f090100349704000000fcff4017f5c32c000064 2 bt1 adv-noco...
1
MQTT broker
On each KNOT setup MQTT broker. For KNOT_1: ``` /iot/mqtt/brokers/add name=tb address=x.x.x.x port=1883 username=knot-1_access_token ``` Where: ``` name ``` ``` address ``` ``` port ``` ``` username ``` For KNOT_2 and KNOT_3 → Do the same steps. Just changeusernameto the respective access token that was generated. ``` ...
1
Script
Import the script shown below to each KNOT. To do that, just copy the below shown "code" and paste it into a new terminal window and press "ENTER": ``` /system script add dont-require-permissions=no name=tracking owner=admin policy=\ ftp,reboot,read,write,policy,test,password,sniff,sensitive,romon source="# Required pa...
1
Script that includes temperature data (optional)
In case you wish to add temperature reports to the structured message, use the script below: ``` /system script add dont-require-permissions=no name=tracking+temp owner=admin policy=\ ftp,reboot,read,write,policy,test,password,sniff,sensitive,romon source="# Required package\ s: iot\r\ \n\r\ \n# Configuration # \r\ \n#...
1
Script that includes GPS data (optional)
In case you also wish to include GPS data (longitude and latitude values from the KNOTs), use the script shown below: ``` /system script add dont-require-permissions=no name=tracking+gps+temp owner=admin policy=\ ftp,reboot,read,write,policy,test,password,sniff,sensitive,romon source="# Required package\ s: iot\r\ \n\r...
1
Scheduler
Apply a scheduler to the script, so that RouterOS periodically initiates the script by itself: ``` /system/scheduler/add name=bluetoothscheduler interval=50s on-event="/system/script/run tracking" ``` You can set up shorter and longer intervals. If you want to send data more often, so that the data is "fresher" →  set ...
1
ThingsBoard data visualization and result verification
After you run the script with/system script run trackingor via a scheduler and refresh the GUI portal → all MAC addresses (tags) that are found in the JSON message, will be made into new devices under the ThingsBoard GUI: ``` /system script run tracking ``` To help you visualize the data, you can use the built-inwidget...
1
Temperature visualization (optional)
Select the tag's MAC address from the list of devices, go to the "Latest telemetry" section, checkbox "temp" parameter, and click on the "Show on widget" button: ``` temp ``` Select a widget that you wish to use, for example under the "Charts" bundle, "Timeseries Line Chart". Click on "Add to dashboard", and choose the...
1
GPS coordinate visualization (optional)
Per the script in theScript that includes GPS datasection, the script sends x2 MQTT messages. Each message is sent to a different MQTT topic. GPS coordinate message will be posted to a topic named "1/devices/me/telemetry", while Bluetooth data will be posted to a topic named "v1/gateway/telemetry". Coordinates will be ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bonding
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/8323193/Bonding
18
2Summary3Quick Setup Guide4Link monitoring4.1ARP Monitoring4.2MII monitoring5Bonding modes5.1802.3ad5.2balance-xor5.3balance-rr5.4active-backup5.5broadcast5.6balance-tlb5.6.1Configuration example5.7balance-alb6Bonding monitoring7Property Description8See also
1
Summary
Bonding is a technology that allows aggregation of multiple ethernet-like interfaces into a single virtual link, thus getting higher data rates and providing failover.
1
Quick Setup Guide
Let us assume that we have two Ethernet interfaces on each router (Router1 and Router2) and want to get the maximum data rate between these two routers. To make this possible, follow these steps: /ip address add address=172.16.0.1/24 interface=bond1 /ip address add address=172.16.0.2/24 interface=bond1 SEQ HOST ...
1
Link monitoring
It is critical that one of the available link monitoring options is enabled. In the above example, if one of the bonded links were to fail, the bonding driver will still continue to send packets over the failed link which will lead to network degradation. Bonding in RouterOS currently supports two schemes for monitorin...
1
ARP Monitoring
ARP monitoring sends ARP queries and uses the response as an indication that the link is operational. The ARP replies are not validated, any received packet by the slave interface will result in the slave interface considered as active. This gives assurance that traffic is actually flowing over the links. If balance-rr...
1
MII monitoring
MII monitoring monitors only the state of the local interface.MII Type 1- a device driver determines whether a link is up or down. If the device driver does not support this option then the link will appear as always up. The main disadvantage is that MII monitoring can't tell if the link can actually pass packets or no...
1
Bonding modes
1
802.3ad
802.3ad mode is an IEEE standard also called LACP (Link Aggregation Control Protocol). It includes automatic configuration of the aggregates, so minimal configuration of the switch is needed. This standard also mandates that frames will be delivered in order and connections should not see misordering of packets. The st...
1
balance-xor
This mode balances outgoing traffic across the active ports based on the hashed protocol header information and accepts incoming traffic from any active port. The mode is very similar toLACPexcept that it is not standardized and works withlayer-3-and-4hash policy. The mode can work together with static Link Aggregation...
1
balance-rr
If this mode is set, packets are transmitted in sequential order from the first available slave to the last. The balance-rr is the only mode that will send packets across multiple interfaces that belong to the same TCP/IP connection. When utilizing multiple sending and multiple receiving links, packets are often receiv...
1
active-backup
This mode uses only one active slave to transmit packets. The additional slave only becomes active if the primary slave fails. The MAC address of the bonding interface is presented onto the active port to avoid confusing the switch. Active-backup is the best choice in high availability setups with multiple switches tha...
1
broadcast
When ports are configured with broadcast mode, all slave ports transmit the same packets to the destination to provide fault tolerance. This mode does not provide load balancing.
1
balance-tlb
This mode balances outgoing traffic by peer. Each link can be a different speed and duplex mode and no specific switch configuration is required as for the other modes. The downside of this mode is that only MII link monitoring is supported (ARP link monitoring is ignored when configured) and incoming traffic is not ba...
1
Configuration example
Let's assume that the router has two links -ether1max bandwidth is 10Mbps andether2max bandwidth is 5Mbps. The first link has more bandwidth so we set it as a primary link: ``` /interface bonding add mode=balance-tlb slaves=ether1,ether2 primary=ether1 ``` No additional configuration is required for the switch. The ima...
1
balance-alb
The mode is basically the same as balance-tlb but incoming IPv4 traffic is also balanced. The receive load balancing is achieved by ARP negotiation. The bonding driver intercepts locally generated ARP messages on their way out and overwrites the source hardware address with the unique address of one of the slaves in th...
1
Bonding monitoring
Since RouterOS 6.48 version, it is possible to monitor the bonding interface and bonding ports. For the802.3adbonding mode, more detailed monitoring options are available. ``` 802.3ad ``` ``` /interface bonding monitor [find] mode: 802.3ad active-backup active-ports: ether4 ether6 ether5 inactive-p...
1
Property Description
This section describes the available bonding settings. Property | Description ---------------------- arp(disabled | enabled | proxy-arp | reply-only; Default:enabled) | Address Resolution Protocol for the interface.disabled- the interface will not use ARPenabled- the interface will use ARPproxy-arp- the interface will ...
1
See also
* Bonding Examples
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bonding Examples
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/132349985/Bonding+Examples
5
Bonding EoIP tunnels over two wireless links
This is an example of aggregating multiple network interfaces into a single pipe. In particular, it is shown how to aggregate multiple virtual (EoIP) interfaces to get maximum throughput (MT) with emphasis on availability.
1
Network Diagram
Two routers R1 and R2 are interconnected via wireless links. Wireless interfaces on both sides have assigned IP addresses.
1
Configuration
Bonding could be used only on OSI layer 2 (Ethernet level) connections. Thus we need to create EoIP interfaces on each of the wireless links. This is done as follows: on router R1: ``` /interface eoip add remote-address=10.0.1.1/24 tunnel-id=1 /interface eoip add remote-address=10.2.2.1/24 tunnel-id=2 ``` and on router...
1
Test the configuration
Now two routers are able to reach each other using addresses from the 192.168.0.0/24 network. To verify bonding interface functionality, do the following: R1: ``` /interface monitor-traffic eoip-tunnel1,eoip-tunnel2 ``` R2: ``` /tool bandwidth-test 192.168.0.1 direction=transmit ``` You should see that traffic is distr...
1
Link Monitoring
It is easy to notice that with the configuration above as soon as any individual link fails, the bonding interface throughput collapses. That's because no link monitoring is performed, consequently, the bonding driver is unaware of problems with the underlying links. Enabling link monitoring is a must in most bonding c...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Branding
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/69664784/Branding
10
Options
Options that can be configured using a branding package:
1
Custom files
Custom files such as the WebFig login page, WebFig logo, hotspot, skins, Default configuration, LCD logo, Custom files and CAPs mode script can be included in the branding package.
1
WebFig login page
The WebFig login page is a customized default RouterOS login interface that appears when accessing the router's IP address. This page can be customized to meet branding or functional requirements. Customization Files: ``` /index2.html ``` ``` /assets/style.css ``` ``` /assets/script.js ``` Required Elements for thescri...
1
WebFig logo
RouterOS WebFig page (configuration page) logo. To overwrite the MikroTik logo on the WebFig login page, upload your custom logo named "mikrotik_logo.png".
1
hotspot
Hotspot login page logo. The file must be named "logobottom.png".
1
skins
1
Default configuration
A RouterOS default configuration file that will override RouterOS default configuration. This configuration will persist even after a RouterOS reset. Factory passwords can be reapplied using the read-only variables$defconfPasswordand$defconfWifiPassword(access to factory passwords is available starting RouterOS 7.10).
1
LCD logo
LCD logo will be displayed on devices equipped with LCD screen. A Logo size cannot be larger than 160px width and 72px height. CCR1xxx series has white (0xffffff) background, 2011 series have black (0x000000) background.
1
Custom files
Custom files will be copied into a folder named "branding" and will be accessible from within RouterOS.
1
CAPs mode script
A RouterOS CAPs mode script that will override RouterOS default CAPs mode script. It is possible to reapply the factory passwords by utilizing the read-only variables$defconfPasswordand$defconfWifiPassword(available starting from RouterOS 7.15).
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bridge IGMP/MLD snooping
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/59277403/Bridge+IGMP+MLD+snooping
10
Introduction
IGMP (Internet Group Management Protocol) and MLD (Multicast Listener Discovery) snooping allow the bridge to listen to IGMP/MLD communication and make forwarding decisions for multicast traffic based on the received information. By default, bridges are flooding multicast traffic to all bridge ports just like broadcast...
1
Configuration options
This section describes the IGMP and MLD snooping bridge configuration options. Sub-menu:/interface bridge ``` /interface bridge ``` Property | Description ---------------------- igmp-snooping(yes | no; Default:no) | Enables IGMP and MLD snooping. igmp-version(2 | 3; Default:2) | Selects the IGMP version in which IGMP m...
1
Monitoring and troubleshooting
This section describes the IGMP/MLD snooping bridge monitoring and troubleshooting options. To monitor learned multicast database (MDB) entries, use theprintcommand. ``` print ``` Sub-menu:/interface bridge mdb ``` /interface bridge mdb ``` Property | Description ---------------------- bridge(read-only:name) | Shows th...
1
GROUP VID ON-PORTS BRIDGE
0 D ff02::2 1 bridge1 bridge1 1 D ff02::6a 1 bridge1 bridge1 2 D ff02::1:ff00:0 1 bridge1 bridge1 3 D ff02::1:ff01:6a43 1 bridge1 bridge1 4 D 229.1.1.1 10 ether2 bridge1 5 D 229.2.2.2 10 ether3 bridge1 ether2 6 D ff02::2 10 ether5 ...
1
Configuration examples
Below are described the most common configuration examples. Some examples are using a bridge with VLAN filtering, so make sure to understand the filtering principles first -bridge VLAN filtering,bridge VLAN table.
1
Basic IGMP snooping configuration
The first example consists only of a single IGMP snooping bridge, a single multicast source device, and a couple of multicast client devices. See a network scheme below. First, create a bridge interface with enabled IGMP snooping. In this example, there is no active IGMP querier (no multicast router or proxy), so a loc...
1
IGMP snooping configuration with VLANs
The second example adds some complexity. There are two IGMP snooping bridges and we need to isolate the multicast traffic on a different VLAN. See a network scheme below. First, create a bridge on both devices and add the needed interfaces as bridge ports. To change untagged VLAN for a bridge port, use thepvidsetting. ...
1
Static MDB entries
Since RouterOS version 7.7, it is possible to create static MDB entries for IPv4 and IPv6 multicast groups. For example, to create a static MDB entry for multicast group 229.10.10.10 on ports ether2 and ether3 on VLAN 10, use the command below: ``` /interface bridge mdb add bridge=bridge1 group=229.10.10.10 ports=ether...
1
GROUP VID ON-PORTS BRIDGE
12 229.10.10.10 10 ether2 bridge1 ether3 ``` In case a certain IPv6 multicast group does not need to be snooped and it is desired to be flooded on all ports and VLANs, it is possible to create a static MDB entry on all VLANs and ports, including the bridge interface itself. Use the command below to create a stati...
1
GROUP VID ON-PORTS BRIDGE
0 ff02::2 bridge1 15 D ff02::2 1 bridge1 bridge1 16 D ff02::2 10 bridge1 bridge1 ether2 ether3 ether4 ether5 17 D ff02::2 20 bridge1 bridge1 ether2 ether3 18 D ff02::2 30 bridge1 bridge1 ether2 ether3 ```
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bridge VLAN Table
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/28606465/Bridge+VLAN+Table
7
Summary
It is possible to use a bridge to filter out VLANs in your network. To achieve this, you should use theBridge VLAN Filteringfeature. This feature should be used instead of many known VLAN misconfigurations that are most likely causing you either performance issues or connectivity issues, you can read about one of the m...
1
Background
Before explaining bridge VLAN filtering in-depth, you should understand a few basic concepts that are involved in bridge VLAN filtering. ``` /interface bridge vlan ``` ``` /interface bridge vlan ``` ``` tag-stacking=yes ```
1
Trunk/Access port setup
Below you can find a very common diagram for a very typical type of setup that consists of a trunk port and multiple access ports: This setup is very common since it gives the possibility to divide your network into multiple segments while using a single switch and maybe a single router, such a requirement is very comm...
1
BRIDGE VLAN-IDS CURRENT-TAGGED CURRENT-UNTAGGED
0 bridge1 20 ether1 ether2 1 bridge1 30 ether1 ether3 2 D bridge1 1 bridge1 ether1 ``` There is a dynamic entry added forVLAN1sincePVID=1is set by default to all bridge ports (including ou...
1
BRIDGE VLAN-IDS CURRENT-TAGGED CURRENT-UNTAGGED
0 bridge1 20 ether1 1 bridge1 30 ether1 ether3 2 D bridge1 1 ether1 3 bridge1 99 bridge1 ether3 ``` Whileframe-typecan be used to drop a certain type of packet, theingress-filteringcan be used to filter out packets before they c...
1
VLAN Tunnelling setup
In some cases, you might want to forward already tagged traffic through certain switches. This is a quite common setup for backbone infrastructures since it provides a possibility to encapsulate traffic from, for example, your edge routers and seamlessly forward it over your backbone to another edge router. Below you c...
1
Tag Stacking
In theVLAN Tunnelling setup,we were adding a new VLAN tag that was different from the VLAN tag, but it is possible to add a new VLAN tag regardless of the packet contents. The difference between the regular VLAN tunneling setup is that the bridge does not check if the packet is tagged or untagged, it assumes that all p...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bridging and Switching
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328068/Bridging+and+Switching
63
Summary
Ethernet-like networks (Ethernet, Ethernet over IP, IEEE 802.11 in ap-bridge or bridge mode, WDS, VLAN) can be connected together using MAC bridges. The bridge feature allows the interconnection of hosts connected to separate LANs (using EoIP, geographically distributed networks can be bridged as well if any kind of IP...
1
Bridge Interface Setup
To combine a number of networks into one bridge, a bridge interface should be created. Later, all the desired interfaces should be set up as its ports. By default, bridge MAC address will be chosen automatically, depending on the bridge port configuration. To avoid unwanted MAC address changes, it is recommended to dis...
1
Example
To add and enable a bridge interface that will forward L2 packets: ``` [admin@MikroTik] > interface bridge add [admin@MikroTik] > interface bridge print Flags: X - disabled, R - running 0 R name="bridge1" mtu=auto actual-mtu=1500 l2mtu=65535 arp=enabled arp-timeout=auto mac-address=5E:D2:42:95:56:7F protocol-mode=rstp ...
1
Bridge Monitoring
To monitor the current status of a bridge interface, use themonitorcommand. ``` monitor ``` Sub-menu:/interface bridge monitor ``` /interface bridge monitor ``` Property | Description ---------------------- current-mac-address(MAC address) | Current MAC address of the bridge designated-port-count(integer) | Number of d...
1
Spanning Tree Protocol
RouterOS bridge interfaces are capable of running Spanning Tree Protocol to ensure a loop-free and redundant topology. For small networks with just 2 bridges STP does not bring many benefits, but for larger networks properly configured STP is very crucial, leaving STP-related values to default may result in a completel...
1
Per-port STP
There might be certain situations where you want to limit STP functionality on single or multiple ports. Below you can find some examples for different use cases.
1
Create edge ports
Setting a bridge port as an edge port will restrict it from sending BPDUs and will ignore any received BPDUs: ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether1 edge=yes add bridge=bridge1 interface=ether2 ```
1
Drop received BPDUs
The bridge filter or NAT rules cannot drop BPDUs when the bridge has STP/RSTP/MSTP enabled due to the special processing of BPDUs. However, dropping received BPDUs on a certain port can be done on some switch chips using ACL rules: On CRS3xx: ``` /interface ethernet switch rule add dst-mac-address=01:80:C2:00:00:00/FF:...
1
Enable BPDU guard
In this example, ifether1receives a BPDU, it will block the port and will require you to manually re-enable it. ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether1 bpdu-guard=yes add bridge=bridge1 interface=ether2 ```
1
Enable Root guard
In this example,ether1is configured withrestricted-role=yes.It prevented the port from becoming the root port for the CIST or any MSTI, regardless of its best spanning tree priority vector. Such a port will be selected as an Alternate Port (discarding state) and remains so as long as it continues to receive superior BP...
1
Bridge Settings
Under the bridge settings menu, it is possible to control certain features for all bridge interfaces and monitor global bridge counters. Sub-menu:/interface bridge settings ``` /interface bridge settings ``` Property | Description ---------------------- use-ip-firewall(yes | no; Default:no) | Force bridged traffic to a...
1
Port Settings
Port submenu is used to add interfaces in a particular bridge. Sub-menu:/interface bridge port ``` /interface bridge port ``` Property | Description ---------------------- auto-isolate(yes | no; Default:no) | When enabled, prevents a port moving from discarding into forwarding state if no BPDUs are received from the ne...
1
Example
To group ether1 and ether2 in the already created bridge1 interface. ``` [admin@MikroTik] /interface bridge port add bridge=bridge1 interface=ether1 [admin@MikroTik] /interface bridge port add bridge=bridge1 interface=ether2 [admin@MikroTik] /interface bridge port print Flags: X - disabled, I - inactive, D - dynamic, H...
1
INTERFACE       BRIDGE       HW  PVID PRIORITY  PATH-COST INTERNAL-PATH-COST    HORIZON
0     ether1          bridge1      yes  100     0x80         10                 10       none 1     ether2          bridge1      yes  200     0x80         10                 10       none ```
1
Interface lists
Starting with RouterOS v6.41 it possible to add interface lists as a bridge port and sort them. Interface lists are useful for creating simpler firewall rules. Below is an example how to add an interface list to a bridge: ``` /interface list add name=LAN1 add name=LAN2 /interface list member add interface=ether1 list=L...
1
INTERFACE       BRIDGE       HW  PVID PRIORITY  PATH-COST INTERNAL-PATH-COST    HORIZON
0     LAN1            bridge1      yes    1     0x80         10                 10       none 1  D  ether1          bridge1      yes    1     0x80         10                 10       none 2  D  ether2          bridge1      yes    1     0x80         10                 10       none 3     LAN2            bridge1      yes...
1
INTERFACE       BRIDGE       HW  PVID PRIORITY  PATH-COST INTERNAL-PATH-COST    HORIZON
0     LAN2            bridge1      yes    1     0x80         10                 10       none 1  D  ether3          bridge1      yes    1     0x80         10                 10       none 2  D  ether4          bridge1      yes    1     0x80         10                 10       none 3     LAN1            bridge1      yes...
1
INTERFACE BRIDGE HW PVID PRIORITY HORIZON
0 vlan10_untagged bridge1 yes 10 0x80 none 1 DH ether2 bridge1 yes 10 0x80 none 2 DH ether3 bridge1 yes 10 0x80 none 3 vlan20_untagged bridge1 yes 20 0x80 none 4 DH ether4 bridge1 yes 20 0x80 none 5 vlan_tagged bridge1 yes ...
1
BRIDGE VLAN-IDS CURRENT-TAGGED CURRENT-UNTAGGED
;;; added by pvid 0 D bridge1 10 ether2 ether3 ;;; added by pvid 1 D bridge1 20 ether4 2 bridge1 10 sfp-sfpplus1 3 bridge1 20 sfp-sfpplus1
1
make necessary changes to interface list members:
/interface list member add list=vlan20_untagged interface=ether5 /interface list member add list=vlan_tagged interface=sfp-sfpplus2
1
verify changes in bridge port and vlan menus:
[admin@MikroTik] > /interface bridge port print Flags: D - DYNAMIC; H - HW-OFFLOAD Columns: INTERFACE, BRIDGE, HW, PVID, PRIORITY, HORIZON
1
INTERFACE BRIDGE HW PVID PRIORITY HORIZON
0 vlan10_untagged bridge1 yes 10 0x80 none 1 DH ether2 bridge1 yes 10 0x80 none 2 DH ether3 bridge1 yes 10 0x80 none 3 vlan20_untagged bridge1 yes 20 0x80 none 4 DH ether4 bridge1 yes 20 0x80 none 5 DH ether5 bridge1 yes ...
1
BRIDGE VLAN-IDS CURRENT-TAGGED CURRENT-UNTAGGED
;;; added by pvid 0 D bridge1 10 ether2 ether3 ;;; added by pvid 1 D bridge1 20 ether4 ether5 2 bridge1 10 sfp-sfpplus1 sfp-sfpplus2 3 bridge1 20 sfp-sfpplus1 sfp-sfpplus2 ```
1
Bridge Port Monitoring
To monitor the current status of bridge ports, use themonitorcommand. ``` monitor ``` Sub-menu:/interface bridge port monitor ``` /interface bridge port monitor ``` Property | Description ---------------------- actual-path-cost(integer: 1..200000000) | Shows the actual port path-cost. Either manually applied or automat...
1
Hosts Table
MAC addresses that have been learned on a bridge interface can be viewed in thehostmenu. Below is a table of parameters and flags that can be viewed. Sub-menu:/interface bridge host ``` /interface bridge host ``` Property | Description ---------------------- bridge(read-only: name) | The bridge the entry belongs to dis...
1
Monitoring
To get the active hosts table: ``` [admin@MikroTik] /interface bridge host print Flags: X - disabled, I - invalid, D - dynamic, L - local, E - external
1
MAC-ADDRESS        VID ON-INTERFACE            BRIDGE
0   D   B8:69:F4:C9:EE:D7      ether1                  bridge1 1   D   B8:69:F4:C9:EE:D8      ether2                  bridge1 2   DL  CC:2D:E0:E4:B3:38      bridge1                 bridge1 3   DL  CC:2D:E0:E4:B3:39      ether2                  bridge1 ```
1
Static entries
It is possible to add a static MAC address entry into the host table. This can be used to forward a certain type of traffic through a specific port. Another use case for static host entries is to protect the device resources by disabling dynamic learning and relying only on configured static host entries. Below is a ta...
1
Multicast Table
WhenIGMP/MLD snoopingis enabled, the bridge will start to listen to IGMP/MLD communication, create multicast database (MDB) entries, and make forwarding decisions based on the received information. Packets with link-local multicast destination addresses 224.0.0.0/24 andff02::1 are not restricted and are always flooded ...
1
GROUP VID ON-PORTS BRIDGE
0 D ff02::2 1 bridge1 bridge1 1 D ff02::6a 1 bridge1 bridge1 2 D ff02::1:ff00:0 1 bridge1 bridge1 3 D ff02::1:ff01:6a43 1 bridge1 bridge1 4 D 229.1.1.1 10 ether2 bridge1 5 D 229.2.2.2 10 ether3 bridge1 ether2 6 D ff02::2 10 ether5 ...
1
Static entries
Since RouterOS version 7.7, it is possible to create static MDB entries for IPv4 and IPv6 multicast groups. Sub-menu:/interface bridge mdb ``` /interface bridge mdb ``` Property | Description ---------------------- bridge(name; Default: ) | The bridge interface to which the MDB entry is going to be assigned. disabled(y...
1
GROUP VID ON-PORTS BRIDGE
12 229.10.10.10 10 ether2 bridge1 ether3 ``` In case a certain IPv6 multicast group does not need to be snooped and it is desired to be flooded on all ports and VLANs, it is possible to create a static MDB entry on all VLANs and ports, including the bridge interface itself. Use the command below to create a stati...
1
GROUP VID ON-PORTS BRIDGE
0 ff02::2 bridge1 15 D ff02::2 1 bridge1 bridge1 16 D ff02::2 10 bridge1 bridge1 ether2 ether3 ether4 ether5 17 D ff02::2 20 bridge1 bridge1 ether2 ether3 18 D ff02::2 30 bridge1 bridge1 ether2 ether3 ```
1
Bridge Hardware Offloading
It is possible to switch multiple ports together if a device has a built-in switch chip. While a bridge is a software feature that will consume CPU's resources, the bridge hardware offloading feature will allow you to use the built-in switch chip to forward packets. This allows you to achieve higher throughput if confi...
1
Example
Port switching with bridge configuration and enabled hardware offloading: ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether3 hw=yes add bridge=bridge1 interface=ether4 hw=yes add bridge=bridge1 interface=ether5 hw=yes ``` Make sur...
1
INTERFACE       BRIDGE       HW  PVID PRIORITY  PATH-COST INTERNAL-PATH-COST    HORIZON
0   H ether2          bridge1      yes    1     0x80         10                 10       none 1   H ether3          bridge1      yes    1     0x80         10                 10       none 2   H ether4          bridge1      yes    1     0x80         10                 10       none 3 H ether5          bridge1      yes...
1
Bridge VLAN Filtering
Bridge VLAN Filtering provides VLAN-aware Layer 2 forwarding and VLAN tag modifications within the bridge. This set of features makes bridge operation more similar to a traditional Ethernet switch and allows overcoming Spanning Tree compatibility issues compared to the configuration when VLAN interfaces are bridged. Br...
1
Bridge VLAN table
Bridge VLAN table represents per-VLAN port mapping with an egress VLAN tag action.Thetaggedports send out frames with a corresponding VLAN ID tag.Theuntaggedports remove a VLAN tag before sending out frames. Bridge ports withframe-typesset toadmit-alloradmit-only-untagged-and-priority-taggedwill be automatically added ...
1
Bridge port settings
Each bridge port have multiple VLAN related settings, that can change untagged VLAN membership, VLAN tagging/untagging behavior and packet filtering based on VLAN tag presence. Sub-menu:/interface bridge port ``` /interface bridge port ``` Property | Description ---------------------- frame-types(admit-all | admit-only...
1
Bridge host table
Bridge host table allows monitoring learned MAC addresses. Whenvlan-filteringis enabled, it shows learned VLAN ID as well (enabled independent-VLAN-learning or IVL). ``` vlan-filtering ``` ``` [admin@MikroTik] > /interface bridge host print where !local Flags: X - disabled, I - invalid, D - dynamic, L - local, E - exte...
1
MAC-ADDRESS        VID ON-INTERFACE       BRIDGE
0   D   CC:2D:E0:E4:B3:AA  300 ether3             bridge1 1   D   CC:2D:E0:E4:B3:AB  400 ether4             bridge1 ```
1
VLAN Example - Trunk and Access Ports
Create a bridge with disabledvlan-filteringto avoid losing access to the device before VLANs are completely configured. If you need a management access to the bridge, see theManagement access configurationsection. ``` vlan-filtering ``` ``` /interface bridge add name=bridge1 vlan-filtering=no ``` Add bridge ports and s...
1
VLAN Example - Trunk and Hybrid Ports
Create a bridge with disabledvlan-filteringto avoid losing access to the router before VLANs are completely configured. If you need a management access to the bridge, see theManagement access configurationsection. ``` vlan-filtering ``` ``` /interface bridge add name=bridge1 vlan-filtering=no ``` Add bridge ports and s...
1
VLAN Example - InterVLAN Routing by Bridge
Create a bridge with disabledvlan-filteringto avoid losing access to the router before VLANs are completely configured.If you need a management access to the bridge, see theManagement access configurationsection. ``` vlan-filtering ``` ``` /interface bridge add name=bridge1 vlan-filtering=no ``` Add bridge ports and sp...
1
Management access configuration
There are multiple ways to set up management access on a device that uses bridge VLAN filtering. Below are some of the most popular approaches to properly enable access to a router/switch. Start by creating a bridge without VLAN filtering enabled: ``` /interface bridge add name=bridge1 vlan-filtering=no ```
1
Untagged access without VLAN filtering
In case VLAN filtering will not be used and access with untagged traffic is desired, the only requirement is to create an IP address on the bridge interface. ``` /ip address add address=192.168.99.1/24 interface=bridge1 ```
1
Tagged access without VLAN filtering
In case VLAN filtering will not be used and access with tagged traffic is desired, create a routable VLAN interface on the bridge and add an IP address on the VLAN interface. ``` /interface vlan add interface=bridge1 name=MGMT vlan-id=99 /ip address add address=192.168.99.1/24 interface=MGMT ```
1
Tagged access with VLAN filtering
In case VLAN filtering is used and access with tagged traffic is desired, additional steps are required. In this example, VLAN 99 will be used to access the device. A VLAN interface on the bridge must be created and an IP address must be assigned to it. ``` /interface vlan add interface=bridge1 name=MGMT vlan-id=99 /ip...
1
Untagged access with VLAN filtering
In case VLAN filtering is used and access with untagged traffic is desired, the VLAN interface must use the same VLAN ID as the untagged port VLAN ID (pvid). Just like in the previous example, start by creating a VLAN interface on the bridge and add an IP address for the VLAN. ``` pvid ``` ``` /interface vlan add inter...
1
Changing untagged VLAN for the bridge interface
In case VLAN filtering is used, it is possible to change the untagged VLAN ID for the bridge interface using thepvidsetting. Note that creating routable VLAN interfaces and allowing tagged traffic on the bridge is a more flexible and generally recommended option. ``` pvid ``` First, create an IP address on the bridge i...
1
VLAN Tunneling (QinQ)
Since RouterOS v6.43 the RouterOS bridge is IEEE 802.1ad compliant and it is possible to filter VLAN IDs based on Service VLAN ID (0x88a8) rather than Customer VLAN ID (0x8100). The same principles can be applied as with IEEE 802.1Q VLAN filtering (the same setup examples can be used). Below is a topology for a commonP...
1
Tag stacking
Since RouterOS v6.43 it is possible to forcefully add a new VLAN tag over any existing VLAN tags, this feature can be used to achieve a CVID stacking setup, where a CVID (0x8100) tag is added before an existing CVID tag. This type of setup is very similar totheProvider bridgesetup, to achieve the same setup but with mu...
1
MVRP
Multiple VLAN Registration protocol (MVRP) is a protocol based on Multiple Registration Protocol (MRP) which allows to register attributes (VLAN IDs in case of MVRP) with other members of Bridged LAN. An MRP application can make or withdraw declarations of attributes which result in registration or leaving of those att...
1
Property Reference
Sub-menu:/interface bridge ``` /interface bridge ``` Property | Description ---------------------- mvrp(yes|no; Default:no) | Enables MVRP for bridge. It ensures that the MAC address 01:80:C2:00:00:21 is trapped and not forwarded, thevlan-filteringmust be enabled. Property Description mvrp(yes|no; Default:no) Enables M...
1
BRIDGE PORT VLAN-ID REGISTRAR-STATE APPLICANT-STATE LAST-EVENT
1 bridge67 sfp-sfpplus1 10 IN Quiet Active JoinIn 9 bridge67 sfp-sfpplus5 10 MT Quiet Active JoinEmpty 17 bridge67 sfp-sfpplus9 10 MT Quiet Active JoinEmpty 25 bridge67 sfp-sfpplus13 10 IN Quiet Active JoinIn ...
1
Fast Forward
Fast Forward allows forwarding packets faster under special conditions. When Fast Forward is enabled, then the bridge can process packets even faster since it can skip multiple bridge-related checks, including MAC learning. Below you can find a list of conditions thatMUSTbe met in order for Fast Forward to be active: `...
1
IGMP/MLD Snooping
The bridge supports IGMP/MLD snooping. It controls multicast streams and prevents multicast flooding on unnecessary ports. Its settings are placed in the bridge menu and it works independently in every bridge interface. Software-driven implementation works on all devices with RouterOS, but CRS3xx, CRS5xx series switche...
1
DHCP Snooping and DHCP Option 82
DHCP Snooping and DHCP Option 82 is supported by bridge. The DHCP Snooping is a Layer2 security feature, that limits unauthorized DHCP servers from providing malicious information to users. In RouterOS, you can specify which bridge ports are trusted (where known DHCP server resides and DHCP messages should be forwarded...
1
Controller Bridge and Port Extender
Controller Bridge (CB) and Port Extender (PE) is an IEEE 802.1BR standard implementation in RouterOS for CRS3xx, CRS5xx series switches and CCR2116, CCR2216 routers. It allows virtually extending the CB ports with a PE device and managing these extended interfaces from a single controlling device. Such configuration pr...
1
Bridge Firewall
The bridge firewall implements packet filtering and thereby provides security functions that are used to manage data flow to, from, and through the bridge. Packet flow diagramshows how packets are processed through the router. It is possible to force bridge traffic to go through/ip firewall filterrules (see the bridge ...
1
Bridge Packet Filter
This section describes specific bridge filter options. Sub-menu:/interface bridge filter ``` /interface bridge filter ``` Property | Description ---------------------- action(accept | drop | jump | log | mark-packet | passthrough | return | set-priority; Default:accept) | Action to take if the packet is matched by the ...
1
Bridge NAT
This section describes specific bridge NAT options. Sub-menu:/interface bridge nat ``` /interface bridge nat ``` Property | Description ---------------------- action(accept | drop | jump | mark-packet | redirect | set-priority | arp-reply | dst-nat | log | passthrough | return | src-nat; Default:accept) | Action to tak...
1
See also
* VLANs on Wireless
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bridging and Switching Case Studies
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/119144611/Bridging+and+Switching+Case+Studies
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Bruteforce prevention
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/268337176/Bruteforce+prevention
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Btrfs
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/295239711/Btrfs
14
Summary
Btrfs is a feature-rich copy-on-write file system, most significant features are the following:
1
Examples
1
Two disk Btrfs-RAID (RAID1)
In case you want to create a reliable data storage solution with just two disks (for example, NAS), then you can follow this these steps to successfully create a RAID1 array with Btrfs: ``` /disk print ``` ``` <disk-name-1> ``` ``` /disk format-drive <disk-name-1> file-system=btrfs ``` ``` /disk/btrfs/filesystem print ...
1
Creating subvolumes
The main benefit of creating subvolumes is to organize data on your Btrfs main (root) subvolume. Consider subvolumes as folders with features of a partition, while still sharing the total disk space between all subvolumes. You can later use these subvolumes for much more advanced tasks and it is recommended to create s...
1
Creating snapshots
Snapshots are space efficient way to create backups for your data. By creating a snapshot you save the current state of your data which you can later access.
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Documents/document1.txt 4 BtrfsDisk/Photos/photo1.jpg /disk/btrfs/subvolume/add read-only=yes parent=Photos fs=BtrfsDisk name=Snapshots/Photos-22012025
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Snapshots 4 BtrfsDisk/Documents/document1.txt 5 BtrfsDisk/Photos/photo1.jpg 6 BtrfsDisk/Snapshots/Documents-22012025 7 BtrfsDisk/Snapshots/Photos-22012025 8 BtrfsDisk/Snapshots/Documents-22012025/document1.txt 9 BtrfsDisk/Snapshots/Photos-22012025/photo1....
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Snapshots 4 BtrfsDisk/Documents/document1.txt 5 BtrfsDisk/Documents/document2.txt 6 BtrfsDisk/Photos/photo1.jpg 7 BtrfsDisk/Photos/photo2.jpg 8 BtrfsDisk/Snapshots/Photos-22012025 9 BtrfsDisk/Snapshots/Documents-22012025 10 BtrfsDisk/Snapshots/Documents-2...
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Snapshots 4 BtrfsDisk/Documents/document1.txt 5 BtrfsDisk/Documents/document2.txt 6 BtrfsDisk/Photos/photo1.jpg 7 BtrfsDisk/Photos/photo2.jpg 8 BtrfsDisk/Snapshots/Photos-22012025 9 BtrfsDisk/Snapshots/Documents-22012025 10 BtrfsDisk/Snapshots/Documents-2...
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Documents/document1.txt 4 BtrfsDisk/Photos/photo1.jpg ``` ``` /Btrfs/Documents ``` ``` /Btrfs/Photos/ ``` ``` /disk/btrfs/subvolume/print ``` ``` Snapshots ``` ``` /disk/btrfs/subvolume/add name=Snapshots fs=BtrfsDisk ``` ``` Documents ``` ``` Photos ``` ...
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Snapshots 4 BtrfsDisk/Documents/document1.txt 5 BtrfsDisk/Photos/photo1.jpg 6 BtrfsDisk/Snapshots/Documents-22012025 7 BtrfsDisk/Snapshots/Photos-22012025 8 BtrfsDisk/Snapshots/Documents-22012025/document1.txt 9 BtrfsDisk/Snapshots/Photos-22012025/photo1....
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Snapshots 4 BtrfsDisk/Documents/document1.txt 5 BtrfsDisk/Documents/document2.txt 6 BtrfsDisk/Photos/photo1.jpg 7 BtrfsDisk/Photos/photo2.jpg 8 BtrfsDisk/Snapshots/Photos-22012025 9 BtrfsDisk/Snapshots/Documents-22012025 10 BtrfsDisk/Snapshots/Documents-2...
1
NAME
0 BtrfsDisk 1 BtrfsDisk/Documents 2 BtrfsDisk/Photos 3 BtrfsDisk/Snapshots 4 BtrfsDisk/Documents/document1.txt 5 BtrfsDisk/Documents/document2.txt 6 BtrfsDisk/Photos/photo1.jpg 7 BtrfsDisk/Photos/photo2.jpg 8 BtrfsDisk/Snapshots/Photos-22012025 9 BtrfsDisk/Snapshots/Documents-22012025 10 BtrfsDisk/Snapshots/Documents-2...
1
Transfer your snapshots
Btrfs allows to easily send a snapshot between two devices that is using Btrfs. In this example we will use two RouterOS devices running ROSE-storage package. The RouterOS device containing snapshots that need to be backed up is going to be calledRouterAand the RouterOS device that is going to receive backups is going ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Building Advanced Firewall
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328513/Building+Advanced+Firewall
11
1Overview1.1Interface Lists1.2Protect the Device1.3Protect the Clients1.4Masquerade Local Network2RAW Filtering2.1IPv4 Address Lists2.2IPv4 RAW Rules2.3IPv6 Address Lists2.4IPv6 RAW RulesOverview
From everything we have learned so far, let's try to build an advanced firewall. In this firewall building example, we will try to use as many firewall features as we can to illustrate how they work and when they should be used the right way. Most of the filtering will be done in the RAW firewall, a regular firewall wi...
1
Interface Lists
Two interface lists will be usedWANandLANfor easier future management purposes. Interfaces connected to the global internet should be added to the WAN list, in this case, it isether1! ``` /interface list add comment=defconf name=WAN add comment=defconf name=LAN /interface list member add comment=defconf interface=bridg...
1
Protect the Device
The main goal here is to allow access to the router only from LAN and drop everything else. Notice that ICMP is accepted here as well, it is used to accept ICMP packets that passed RAW rules. ``` /ip firewall filter add action=accept chain=input comment="defconf: accept ICMP after RAW" protocol=icmp add action=accept c...
1
Protect the Clients
Before the actual set of rules, let's create a necessaryaddress-listthat contains all IPv4/6 addresses that cannot be forwarded. ``` address-list ``` Notice that in this list multicast address range is added. It is there because in most cases multicast is not used. If you intend to use multicast forwarding, then this a...
1
Masquerade Local Network
For local devices behind the router to be able to access the internet, local networks must be masqueraded. In most cases, it is advised to use src-nat instead of masquerade, however in this case when the WAN address is dynamic it is the only option. ``` /ip firewall nat add action=accept chain=srcnat comment="defconf: ...
1
RAW Filtering
1
IPv4 Address Lists
Before setting RAW rules, let's create some address lists necessary for our filtering policy. RFC 6890 will be used as a reference. First,address-listcontains all IPv4 addresses that cannot be used as src/dst/forwarded, etc. (will be dropped immediately if such address is seen) ``` /ip firewall address-list add address...
1
IPv4 RAW Rules
Raw IPv4 rules will perform the following actions: ``` /ip firewall raw add action=accept chain=prerouting comment="defconf: enable for transparent firewall" disabled=yes add action=accept chain=prerouting comment="defconf: accept DHCP discover" dst-address=255.255.255.255 dst-port=67 in-interface-list=LAN protocol=udp...
1
IPv6 Address Lists
List of IPv6 addresses that should be dropped instantly ``` /ipv6 firewall address-list add address=::1/128 comment="defconf: RFC6890 lo" list=bad_ipv6 add address=::ffff:0:0/96 comment="defconf: RFC6890 IPv4 mapped" list=bad_ipv6 add address=2001::/23 comment="defconf: RFC6890" list=bad_ipv6 add address=2001:db8::/32 ...
1
IPv6 RAW Rules
Raw IPv6 rules will perform the following actions: ``` /ipv6 firewall raw add action=accept chain=prerouting comment="defconf: enable for transparent firewall" disabled=yes add action=accept chain=prerouting comment="defconf: RFC4291, section 2.7.1" src-address=::/128 dst-address=ff02:0:0:0:0:1:ff00::/104 icmp-options=...
1
Be aware that different operating systems originate packets with different default TTL values
add action=drop chain=icmp6 comment="defconf: rfc4890 drop ll if hop-limit!=255" dst-address=fe80::/10 hop-limit=not-equal:255 protocol=icmpv6 add action=accept chain=icmp6 comment="defconf: dst unreachable" icmp-options=1:0-255 protocol=icmpv6 add action=accept chain=icmp6 comment="defconf: packet too big" icmp-option...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CAKE
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/196345874/CAKE
9
CAKE (Common Applications Kept Enhanced)
1
Description:
CAKE (Common Applications Kept Enhanced) is a modern, advanced queue management algorithm designed to cope with varying network conditions and different types of traffic. It was developed to address the limitations of older algorithms and provide an all-in-one solution to several common network problems. CAKE's approac...
1
Overhead Schemes
The overhead compensation feature in CAKE allows it to account for the extra bytes added by various link layer technologies, which can be significant in some cases. This is important because CAKE operates on the packet sizes reported by the Linux kernel, which do not include these extra bytes. If the overhead is not ac...
1
RTT Schemes
The CAKE queue discipline allows you to specify the Round Trip Time (RTT) it should consider when managing traffic. This is important because the time it takes for a packet to travel from a source to a destination and back impacts how CAKE manages network congestion. If the actual RTT of your network is close to the va...
1
FLOW ISOLATION PARAMETER
When flow isolation is enabled, CAKE puts packets from different flows into different queues. Each queue maintains its own Active Queue Management (AQM) state, and packets are delivered from each queue fairly using a DRR++ (Deficit Round Robin++) algorithm. This algorithm works to minimize latency for "sparse" flows, o...
1
Ack Filter
ACK or acknowledgement filters are a feature of the Cake algorithm that allows for the handling of TCP ACK (acknowledgment) packets. TCP ACK packets are essential to the function of the TCP protocol; they acknowledge the receipt of TCP segments, providing a form of flow control. However, these packets can consume a sig...
1
Wash
The "wash" option in the CAKE queue discipline is used to address the issue of frequently mis-marked traffic entering or exiting a DiffServ (Differentiated Services) domain. When traffic passes through networks or providers, there is a chance that the DSCP (Differentiated Services Code Point) markings could be modified...
1
Diffserv RFC2474 and RFC2475
Diffserv (Differentiated Services) is a mechanism used to prioritize and classify network traffic based on the Diffserv field in the IP packet header. CAKE (Common Applications Kept Enhanced) provides Diffserv support, allowing traffic to be divided into "tins" (traffic classes) and applying different treatment to each...
1
"unlimited" or "autorate-ingress"
When using the "unlimited" or "autorate-ingress" option in the CAKE queue discipline, CAKE automatically determines the download speed based on observed packet arrival times. Here's how it works: Monitoring Packet Arrival Times: CAKE continuously monitors the arrival times of incoming packets. It keeps track of the tim...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CAPsMAN
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/7962638/CAPsMAN
21
CAPsMAN AAA
Settings to configure CAPsMAN AAA functionality are found inthe/caps-man aaamenu: Property | Description ---------------------- mac-format(string; Default:XX:XX:XX:XX:XX:XX) | Controls how the MAC address of the client is encoded by Access Point in the User-Name attribute of the MAC authentication and MAC accounting RA...
1
Example
Assuming that rest of the settings are already configured and only the "Security" part has been left.
1
Radius authentication with one server
1. Create CAPsMAN security configuration 1. Configure Radius server client 1. Assign the configuration to your master profile (or directly to CAP itself) ``` /caps-man security add authentication-types=wpa2-eap eap-methods=passthrough encryption=aes-ccm group-encryption=aes-ccm name=radius /radius add address=x.x.x.x s...
1
Radius authentication with different radius servers for each SSID
1. Create CAPsMAN security configuration 1. Configure AAA settings 1. Configure Radius server clients 1. Assign the configuration to your master profile (or directly to CAP itself) ``` /caps-man security add authentication-types=wpa2-eap eap-methods=passthrough encryption=aes-ccm group-encryption=aes-ccm name=radius /c...
1
CAPsMAN Access-list
Access list on CAPsMAN is an ordered list of rules that is used to allow/deny clients to connect to any CAP under CAPsMAN control. When a client attempts to connect to a CAP that is controlled by CAPsMAN, CAP forwards that request to CAPsMAN. As a part of the registration process, CAPsMAN consults an access list to det...
1
CAPsMAN channel
Channel group settings allow for the configuration of lists of radio channel related settings, such as radio band, frequency, Tx Power extension channel, and width. Channel group settings are configured in the Channels profile menu/caps-man channels Property | Description ---------------------- band(2ghz-b | 2ghz-b/g |...
1
CAPsMAN configuration
Configuration profiles permit pre-defined 'top-level' master settings to be applied to CAP radios being provisioned. Configuration Profiles are configured in/caps-man configurationmenu: Property | Description ---------------------- channel(list; Default: ) | User defined list taken from Channel names (/caps-man channel...
1
CAPsMAN datapath
Datapath settings control data forwarding related aspects. On CAPsMAN datapath settings are configured in the datapath profile menu/caps-man datapathor directly in a configuration profile or interface menu as settings withdatapath.prefix. There are 2 major forwarding modes: Forwarding mode is configured on a per-interf...
1
CAPsMAN interface
CAPsMAN interfaces are managed in/caps-man interfacemenu: ``` [admin@CM] > /caps-man interface print Flags: M - master, D - dynamic, B - bound, X - disabled, I - inactive, R - running
1
NAME RADIO-MAC MASTER-INTERFACE
0 M BR cap2 00:0C:42:1B:4E:F5 none 1 B cap3 00:00:00:00:00:00 cap2 ```
1
CAPsMAN manager
Property | Description ---------------------- enabled(yes | no; Default:no) | Disable or enable CAPsMAN functionality certificate(auto | certificate name | none; Default:none) | Device certificate ca-certificate(auto | certificate name | none; Default:none) | Device CA certificate require-peer-certificate(yes | no; Def...
1
CAPsMAN provisioning
CAPsMAN distinguishes between CAPs based on a common-name identifier. The identifier is generated based on the following rules: When the DTLS connection with CAP is successfully established (which means that CAP identifier is known and valid), CAPsMAN makes sure there is no stale connection with CAP using the same iden...
1
ADDRESS IDENT STATE RADIOS 0 00:0C:42:00:C0:32/27044 MT-000C4200C032 Run 1
``` CAPsMAN distinguishes between actual wireless interfaces (radios) based on their built-in MAC address (radio-mac). This implies that it is impossible to manage two radios with the same MAC address on one CAPsMAN. Radios currently managed by CAPsMAN (provided by connected CAPs) are listed in/caps-man radiomenu: ``` ...
1
RADIO-MAC INTERFACE REMOTE-AP-IDENT
0 P 00:03:7F:48:CC:07 cap1 MT-000C4200C032 ``` When CAP connects, CAPsMAN at first tries to bind each CAP radio to CAPsMAN master interface based on radio-mac. If an appropriate interface is found, radio gets set up using master interface configuration and configuration of slave interfaces that refer to a particular ma...
1
CAPsMAN radio
see /caps-man provisioning
1
CAPsMAN rates
see /caps-man configuration
1
CAPsMAN registration-table
Registration table contains a list of clients that are connected to radios controlled by CAPsMAN and is available in/caps-man registration-tablemenu: ``` [admin@CM] /caps-man> registration-table print
1
INTERFACE MAC-ADDRESS UPTIME RX-SIGNAL
0 cap1 00:03:7F:48:CC:0B 1h38m9s210ms -36 ```
1
CAPsMAN remote-cap
see /caps-man provisioning
1
CAPsMAN security
1
Example
Assuming that rest of the settings are already configured and only the "Security" part has been left. Radius authentication with one server 1. Create CAPsMAN security configuration 1. Configure Radius server client 1. Assign the configuration to your master profile (or directly to CAP itself) ``` /caps-man security add...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CAPsMAN with VLANs
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/137986075/CAPsMAN+with+VLANs
13
Summary
It is possible to create a centralized Access Point management setup for a home or office environment that is scalable to many Access Points, such a setup is quite easy to configure and has been explained in theSimple CAPsMAN setupguide, but for more complex setups VLANs might be required. CAPsMAN has the functionality...
1
Using Local Forwarding Mode
In Local Forwarding Mode, the CAPsMAN router is distributing the configuration across all CAPs that are being provisioned by the CAPsMAN router. In Local Forwarding Mode traffic is not required to be sent to the CAPsMAN router, rather it can be sent to a different router without involving the CAPsMAN router when forwar...
1
CAPsMAN Router:
``` /caps-man configuration add country=latvia datapath.local-forwarding=yes datapath.vlan-id=10 datapath.vlan-mode=use-tag name=Config_WORK security.authentication-types=wpa-psk,wpa2-psk \ security.passphrase=secret_work_password ssid=WiFi_WORK add country=latvia datapath.local-forwarding=yes datapath.vlan-id=20 datap...
1
Switch:
In this example, we are going to be usingBridge VLAN Filteringto filter unknown VLANs and to assign other devices to the same networks. Some devices are capable of offloading this to the built-in switch chip, checkBasic VLAN switchingguide to see how to configure it on different types of devices. ``` /interface bridge ...
1
CAPs:
``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether1 ``` ``` /interface wireless cap set bridge=bridge1 discovery-interfaces=bridge1 enabled=yes interfaces=wlan1 ``` ``` [admin@CAP_1] /interface bridge port pr Flags: X - disabled, I - inactive, D - dynamic, H - hw-offload
1
INTERFACE BRIDGE HW PVID PRIORITY PATH-COST INTERNAL-PATH-COST HORIZON
0 H ether1 bridge1 yes 1 0x80 10 10 none 1 D wlan1 bridge1 10 0x80 10 10 none 2 D wlan5 bridge1 20 0x8...
1
Using CAPsMAN Forwarding Mode
In CAPsMAN Forwarding Mode all traffic that is coming from a CAP is encapsulated with a special CAPsMAN header, which can only be removed by a CAPsMAN router, this means that a switch will not be able to distinguish the VLAN ID set by the CAP since the VLAN tag is also going to be encapsulated. This mode limits the pos...
1
CAPsMAN router:
``` /interface bridge add name=bridge1 vlan-filtering=yes /interface bridge port add bridge=bridge1 interface=ether1 pvid=10 add bridge=bridge1 interface=ether2 pvid=20 /interface bridge vlan add bridge=bridge1 tagged=bridge1 untagged=ether1 vlan-ids=10 add bridge=bridge1 tagged=bridge1 untagged=ether2 vlan-ids=20 ``` ...
1
CAPs:
``` /interface wireless capset discovery-interfaces=ether1 enabled=yes interfaces=wlan1 ``` ``` [admin@CAPsMAN_Router] /interface bridge port print Flags: X - disabled, I - inactive, D - dynamic, H - hw-offload
1
INTERFACE BRIDGE HW PVID PRIORITY PATH-COST INTERNAL-PATH-COST HORIZON
0 ether1 bridge1 yes 10 0x80 10 10 none 1 ether2 bridge1 yes 20 0x80 10 10 none 2 D cap16 bridge1 ...
1
BRIDGE VLAN-IDS CURRENT-TAGGED CURRENT-UNTAGGED
0 D bridge1 1 bridge1 1 bridge1 10 cap16 ether1 2 bridge1 20 cap17 ether2 ``` That is it! Connect Wireless clients to yo...
1
Case studies
1
Without Virtual APs
Not everyone wants to create Virtual APs since that does decrease the total throughput. If you want to use multiple devices to create multiple SSIDs, then it is possible to assign a certain configuration on a CAP based on its identity. To achieve this you should use CAPsMAN provisioning rules along with RegEx expressio...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Certificates
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/2555969/Certificates
16
Overview
``` /certificate ``` The general menu is used to manage certificates, add templates, issue certificates, and manage CRL and SCEP Clients.
1
Certificate Template
Certificate templates are used to prepare a desired certificate for signing. Certificate template is deleted right after a certificate is signed or a certificate request command is executed ``` /certificate add name=CA-Template common-name=CAtemp key-usage=key-cert-sign,crl-sign add name=Server common-name=server add n...
1
Certificate properties
Property | Description ---------------------- common-name(string) | Certificate common name copy-from(name) | Certificate name from which to copy general settings country(string) | Certificate issuer country days-valid(days Default: 365) | Days certificate will be valid after signing digest-algorithm(md5 | sha1 | sha25...
1
Certificate read-only properties
After a certificate is signed, most of a certificate template properties are converted to read-only (exceptnameandtrusted) Property | Description ---------------------- serial-number | Certificate serial number fingerprint | akid | Certificate authority ID skid | Certificate subject ID invalid-before | Date and time be...
1
Sign Certificate
Certificates should be signed. In the following example, we will sign certificates and add CRL URL for the server certificate: ``` /certificate sign CA-Template sign Client sign Server ca-crl-host=192.168.88.1 name=ServerCA ``` Let`s check is the certificates are signed: ``` [admin@MikroTik] /certificate> print Flags: ...
1
NAME COMMON FINGERPRINT
0 K AT CA-Template CAtemp 0c7aaa7607a4dde1bbf33deaae6be7bac9fe4064ba47d64e8a73dcefad6cfc38 1 K AT Client client b3ff25ecb166ea41e15733a7493003f3ea66310c10390c33e98fe32364c3659f 2 KLAT ServerCA server 152b88c9d81f4b765a59e2302e01efd1fbf11ceeed6e59f4974e87787a5bb980 ``` For a video example clickhere.
1
Export Certificate
It is possible to export client certificates with keys and CA certificates in two formats - PEM or PCKS12. Property | Description ---------------------- export-passphrase(stringDefault: none) | Passphrase that will be used for exported certificate private key encryption. file-name(stringDefault: cert_export_[Certificat...
1
NAME TYPE SIZE CREATION-TIME
0 skins directory jan/19/2019 00:00:04 1 flash directory jan/19/2019 01:00:00 2 pub directory jan/19/2019 02:42:16 3 cert_export_CA-Template.crt .crt file 1119 jan/19/2019 04:15:21 4 cert_export_ServerCA.crt .crt...
1
Import Certificate
To import certificates, certificates must be uploaded to a device using one of the file upload methods. Certificates must be imported as a file. Supported arePEM, DER, CRT, PKCS12 formats. Property | Description ---------------------- name(stringDefault: file-name_number) | A certificate name that will be shown in the ...
1
NAME COMMON-NAME
0 KT name_example cert 1 T name_example_1 ca ```
1
Settings
/certificate settingsallows configuring Certificate Revocation List (CRL) settings. By default, CRL is not utilized, and certificates are not verified for revocation status. Property | Description ---------------------- crl-download(yes | noDefault: no) | Whether to automatically download/update CRL crl-store(ram | syt...
1
Let's Encrypt certificates
RouterOS v7 has Let's Encrypt (letsencrypt) certificate support for the 'www-ssl' service. To enable the Let's Encrypt certificate service with automatic certificate renewal, use the 'enable-ssl-certificate' command: ``` /certificate enable-ssl-certificate dns-name=my.domain.com ``` Note that the DNS name must point to...
1
Different acme servers
Support has been added starting from 7.15beta7, you can use not only Let's Encrypt certificate service, but any other you like.
1
Server properties
Property | Description ---------------------- directory-url(string) | ACME directory url. eab-hmac-key(string) | HMAC key for ACME External Account Binding (optional). eab-kid(string) | Key identifier (optional). Key identifier (optional).
1
Example:
``` /certificate/enable-ssl-certificate directory-url=https://acme.zerossl.com/v2/DV90 dns-name=mydomain.abc eab-hmac-key=4ac7xuxAdV4mIncwIIEhLjExsFZ4v1rWgDkX4SKXD25pMVtF85GZJYSF8UKXUOjzSr2g3-v4lhL57NHFaQ42Ff eab-kid=GHWaP2_Ghx73vcU8ricAKU ``` Watch avideoon Let's encrypt setup.
1
SCEP
SCEP is using HTTP protocol and base64 encoded GET requests. Most of the requests are without authentication and cipher, however, important ones can be protected if necessary (ciphered or signed using a received public key). SCEP client in RouterOS will: The SCEP server supports the issuance of one certificate only. Ro...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CHR: Hetzner Cloud Installation
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/263749814/CHR+Hetzner+Cloud+Installation
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CHR: installing on VirtualBox
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/262864931/CHR+installing+on+VirtualBox
6
CHR VirtualBox installation.Video instruction
Download VirtualBox: Install the latest version of VirtualBox from the official website. Download CHR Image: Download and unpack the latest Stable or Testing version of the CHR (Cloud Hosted Router) VDI image from theMikroTik website.
1
Step 1: Create a New Virtual Machine
Launch the VirtualBox application. Create a New VM: Click onNewto create a new virtual machine. Name: Enter a name for your VM (e.g., MikroTik_CHR). Version: SelectOther Linux (64-bit). ClickNext.
1
Step 2: Configure Memory Size
1
Step 3: Create a Virtual Hard Disk
Check the settings and clickFinish.
1
Step 4: Configure Virtual Machine Settings
1
Step 5: Start the Virtual Machine
``` admin ``` Congratulations! You have successfully installed MikroTik CHR on VirtualBox. You can now proceed with configuring your network settings and using the full features of MikroTik RouterOS.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CHR ProxMox installation
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/48660553/CHR+ProxMox+installation
11
Alternative approach
``` qemu-img convert -f raw -O qcow2 chr-6.40.3.img vm-(VM_ID)-disk-1.qcow2 ```
1
Bash script approach
If you have access to the ProxMox host then CHR VM can also be created quickly via BASH script. Below is an example of one such script. What this script does: ```
1
!/bin/bash
1
vars
version="nil" vmID="nil" echo "# Start of Script # # Checking if temp dir is available..." if [ -d /root/temp ] then echo "-- Directory exists!" else echo "-- Creating temp dir!" mkdir /root/temp fi
1
Ask user for version
echo "# Preparing for image download and VM creation!" read -p "Please input CHR version to deploy (6.38.2, 6.40.1, etc):" version
1
Check if image is available and download if needed
if [ -f /root/temp/chr-$version.img ] then echo "-- CHR image is available." else echo "-- Downloading CHR $version image file." cd /root/temp echo "---------------------------------------------------------------------------" wget https://download.mikrotik.com/routeros/$version/chr-$version.img.zip unzip chr-$version....
1
List already existing VM's and ask for vmID
echo "== Printing list of VM's on this hypervisor!" qm list echo "" read -p "Please Enter free vm ID to use:" vmID echo ""
1
Create storage dir for VM if needed.
if [ -d /var/lib/vz/images/$vmID ] then echo "-- VM Directory exists! Ideally try another vm ID!" read -p "Please Enter free vm ID to use:" vmID else echo "-- Creating VM image dir!" mkdir /var/lib/vz/images/$vmID fi
1
Creating qcow2 image for CHR.
echo "-- Converting image to qcow2 format " qemu-img convert \ -f raw \ -O qcow2 \ /root/temp/chr-$version.img \ /var/lib/vz/images/$vmID/vm-$vmID-disk-1.qcow2
1
Creating VM
echo "-- Creating new CHR VM" qm create $vmID \ --name chr-$version \ --net0 virtio,bridge=vmbr0 \ --bootdisk virtio0 \ --ostype l26 \ --memory 256 \ --onboot no \ --sockets 1 \ --cores 1 \ --virtio0 local:$vmID/vm-$vmID-disk-1.qcow2 echo "# End of Script # " ```
1
Useful tips
``` sed -i -e 's/\r$//' *.sh ```
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CHR Vultr installation
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/146997259/CHR+Vultr+installation
6
Step 1: Deploy a server in rescue mode
In this step, you'll deploy a new server at Vultr with SystemRescue, a bootable Linux ISO. When the server finishes deploying, proceed to the next step.
1
Step 2: Write the CHR image to the disk
Substitute your version for x.x.x in the examples that follow. ```
1
wget https://download.mikrotik.com/routeros/x.x.x/chr-x.x.x.img.zip
``` Unzip the downloaded file. ```
1
unzip chr-x.x.x.img.zip
``` Write the MikroTik CHR image to the server's disk with dd. ```
1
dd if=chr-x.x.x.img of=/dev/vda
``` This procedure takes a couple of minutes; proceed to the next step when complete.
1
Step 3: Connect to MikroTik CHR
SSH as admin to the server's IP address. ``` $ ssh admin@192.0.2.2 ``` This completes the basic installation. Pleasesecure your MikroTik CHR routerand consult thedocumentationto configure the server for production use. Visit Vultr site forconfiguration manualand for theirfirewallfeatures.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Clock
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/40992866/Clock
4
Introduction
RouterOS uses data from theTZ database, Most of the time zones from this database are included, and have the same names. Because local time on the router is used mostly for timestamping and time-dependent configuration, and not for historical date calculations, time zone information about past years is not included. Cu...
1
Properties
Property | Description ---------------------- time(HH:MM:SS); | whereHH- hour 00..24,MM- minutes 00..59,SS- seconds 00..59). date(mmm/DD/YYYY); | wheremmm- month, one ofjan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec,DD- date, 00..31,YYYY- year, 1970..2037):dateandtimeshow current local time on the router. These values...
1
Active time zone information
1
Manual time zone configuration
These settings are available in/system clock manualconsole path and in the "Manual Time Zone" tab of the "System > Clock" WinBox window. These settings have an effect only whentime-zone-name=manual. It is only possible to manually configure single daylight saving time period. * dst-start,dst-end(mmm/DD/YYYY HH:MM: SS- ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Cloud
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/97779929/Cloud
12
Summary
MikroTik offers multiple services for your RouterBOARD devices that are connected to the Internet. These services are meant to ease the inconveniences when configuring, setting up, controlling, maintaining, or monitoring your device. A more detailed list of available services that IP/Cloud can provide can be found belo...
1
Services
1
DDNS
DDNS or Dynamic DNS is a service that updates the IPv4 address for A records and the IPv6 address for AAAA records periodically. Such a service is very useful when your ISP has provided a dynamic IP address that changes periodically, but you always need an address that you can use to connect to your device remotely. Be...
1
Update time
Correct time on a device is important, it causes issues with the system's logs, breaks HTTPS connectivity to the device, tunnel connectivity, and other issues. To have your system's clock updated, you can useNTPorSNTP, though it requires you to specify an IP address for the NTP Server. In most cases, NTP/SNTP is not re...
1
Backup
It is possible to store your device'sbackupon MikroTik's Cloud server. The backup service allows you to upload an encrypted backup file, download it and apply the backup file to your device as long as your device is able to reach MikroTik's Cloud server. Below you can find operation details that are relevant to the IP/...
1
OR
[admin@MikroTik] > /system backup cloud download-file action=download secret-download-key=AbCdEfGhIjKlM1234567890 ``` To remove the uploaded backup: ``` /system backup cloud remove-file number=0 ``` To replace an existing file with a new backup file, use the following command: ``` /system/backup/cloud/upload-file actio...
1
Back to Home
For more info about Back to Home (BTH) service, see the separatedocumentation page.
1
File share
For more info about File Share service, see the separatedocumentation page.
1
Relay service
Back to home and File Share both partially rely on the MikroTik cloud relay service. All transmissions through the relay service are end-to-end encrypted, relay is purely to faclilitate connection and is designed to never require decryption of user data or metadata. See respective manuals for details on how each servic...
1
Properties
Sub-menu:/ip cloud ``` /ip cloud ``` Property | Description ---------------------- ddns-enabled(yes | auto; Default:auto) | If set toyes, then the device will send an encrypted message to MikroTik's Cloud server. The server will then decrypt the message and verify that the sender is an authentic MikroTik device. If all...
1
Advanced
Sub-menu:/ip cloud advanced ``` /ip cloud advanced ``` Property | Description ---------------------- use-local-address(yes | no; Default:no) | By default, the DNS name will be assigned to the detected public address (from the UDP packet header). If you wish to send your "local" or "internal" IP address, then set this t...
1
Cloud backup
Sub-menu:/system backup cloud ``` /system backup cloud ``` Below you can find commands and properties that are relevant to the specific command, other properties will not have any effect. Property | Description ---------------------- action(download) | Downloads an uploaded backup file from MikroTik's Cloud server. num...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Cloud Hosted Router, CHR
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/18350234/Cloud+Hosted+Router+CHR
54
System Requirements
The minimum required RAM depends on interface count and CPU count. You can get an approximate number by using the following formula: Note:We recommend allocating at least 1024MiB of RAM for CHR instances.
1
CHR has been tested on the following platforms:
Warning:Hypervisors that provide paravirtualization are not supported.
1
Usable Network and Disk interfaces on various hypervisors:
Note:SCSI controller Hyper-V and ESX are usable just for secondary disks, system image must be used with IDE controller! Warning:We do not recommend using the E1000 network interface if better synthetic interface options are available on a specific Hypervisor!
1
How to Install a virtual RouterOS system with CHR images
We provide 4 different virtual disk images to choose from. Note that they are only disk images, and you can't simply run them. Steps to install CHR Please note that running CHR systems can be cloned and copied, but the copy will be aware of the previous trial period, so you cannot extend your trial time by making a cop...
1
CHR Licensing
The CHR (Cloud Hosted Router) has 4 license levels: The 60-day free trial license is available for all paid license levels. To get the free trial license, you have to have an account onMikroTik.comas all license management is done there. Perpetual is a lifetime license (buy once, use forever). It is possible to transfe...
1
Paid licenses
p1 p1(perpetual-1) license level allows CHR to run indefinitely. It is limited to 1Gbps upload per interface. All the rest of the features provided by CHR are available without restrictions. It is possible to upgrade from P1 to P10 or P-Unlimited. Once the upgrade is purchased at the full price, the former license will...
1
Free licenses
There are several options to use and try CHR free of charge. free Thefreelicense level allows CHR to run indefinitely. It is limited to 1Mbps upload per interface. All the rest of the features provided by CHR are available without restrictions. To use this, all you have to do is download the disk image file from our do...
1
Prepaid Key
A Prepaid Key is a type of license key you can purchase in advance for MikroTik products, such as the CHR, or convert into a license key to apply to an x86 system's Software ID. It allows you to buy a license without immediately assigning it to a specific device. Once you have a Prepaid Key, you can use it to upgrade a...
1
How to Purchase a Prepaid Key to License a CHR
Access the "Purchase a RouterOS License Key" Section. Input the quantity of prepaid keys you wish to purchase; Review and Complete Your Purchase Congratulations! You have successfully purchased a Prepaid Key.
1
Getting and Upgrading the License
After the initial setup, a CHR instance will be assigned a free trial license. You can upgrade this license to a higher tier through your MikroTik account. All license management, including upgrades, is handled on theaccount server.
1
Initial Upgrade from Free to P1 License Level or Higher
Initial upgrade from thefreetier to anything higher than that incurs CHR instance registration on theaccount server. To do that you have to enter yourMikroTik.comusername and password and the desired license level you want to acquire. To upgrade from thefreetier to a higher license level, you need to register the CHR i...
1
Upgrade license level using WinBox
(System -> License menu):
1
Upgrade license level using the command-line interface
``` [admin@MikroTik] > /system license print system-id: 6lR1ZP/utuJ level: free [admin@MikroTik] > /system/license/renew account: mymikrotikcomaccount password: ********************* level: p1status: done[admin@MikroTik] > /system/license/printsystem-id: 6lR1ZP/utuJlevel: p1limited-upgrades: nonext-renewal-at: 2024-08-...
1
Payment
To acquire a higher-level trial, set up a new CHR instance, renew the license, and select the desired level. To upgrade from a Trial license to a Paid one, go to theMikroTik account serverand choose "All CHR keys" in the "CHR LICENCES" section. The list of your CHR instances and their corresponding licenses will be dis...
1
License Update
In the System-License menu, the router will indicate "next-renewal-at" - the time when it will reattempt to contact the server located onlicence.mikrotik.com. Communication attempts will be performed once an hour after the date on "next-renewal-at" and will not cease until the server responds with an error. If the "dea...
1
Upgrading the Level of Perpetual License
It is possible to upgrade the Level of Perpetual License from P1 to P10 or P-Unlimited. Once the upgrade is purchased at the full price, the former license will become available for later use on your account. It is also possible to upgrade the Level of Perpetual License from P10 to P-Unlimited. Once the upgrade is purc...
1
License Transfer
CHR installations are tied directly to the account on our website. It is possible to transfer a perpetual license to another CHR instance registered under the same account. First, register the new machine under the sameMikroTik accountwhere the old CHR is registered using theCLI command"/system license renew". Once bot...
1
Virtual Network Adapters
RouterOS v6 does not support Fast Path.
1
Troubleshooting
1
Running on VMware ESXi
1
Changing MTU
VMware ESXi supports MTU of up to 9000 bytes. To get the benefit of that, you have to adjust your ESXi installation to allow a higher MTU. Virtual Ethernet interface addedafterthe MTU change will be properly allowed by the ESXi server to pass jumbo frames. Interfaces added prior to MTU change on the ESXi server will be...
1
NAME MTU MAC-ADDRESS ARP
0 R ether1 9000 00:0C:29:35:37:5C enabled 1 R ether2 1500 00:0C:29:35:37:66 enabled ```
1
Using bridge on Linux
If Linux bridge supports IGMP snooping, and there are problems with IPv6 traffic it is required to disable that feature as it interacts with MLD packets (multicast) and is not passing them through. ``` echo -n 0 > /sys/class/net/vmbr0/bridge/multicast_snooping ```
1
Packets not passing from guests
The problem: after configuring a software interface (VLAN, EoIP, bridge, etc.) on the guest CHR it stops passing data to the outside world beyond the router. The solution: check your VMS (Virtualization Management System) security settings, if other MAC addresses are allowed to pass and if packets with VLAN tags are al...
1
Using VLANs on CHR in various Hypervisors
In some hypervisors, before VLAN can be used on VMs, they need to first be configured on the hypervisor itself.
1
ESXI
Enable Promiscuous mode in a port group or virtual switch that you will use for a specific VM. ESX documentation:
1
Hyper-V
Hyper-V documentation:
1
bhyve hypervisor
It won't be possible to run CHR on this hypervisor. CHR cannot be run as a para-virtualized platform.
1
Linode
When creating multiple Linodes with the same disk size, new Linodes will have the same systemID. This will cause issues to get a Trial/Paid license. To avoid this, run the command/system license generate-new-idafter the first boot and before you request a trial or paid license. This will make sure the ID is unique. ```...
1
Guest tools
1
VMWare
1
Time synchronization
Must be enabled from GUI ('Synchronize guest time with host'). Backward synchronization is disabled by default - if the guest is ahead of the host by more than ~5 seconds, synchronization is not performed
1
Power operations
1
Quiescing/backup
Guest filesystem quiescing is performed only if requested.
1
Guest info
Networking, disk, and OS info are reported to the hypervisor every 30 seconds (GuestStats (memory) are disabled by default, and can be enabled by setting 'guestinfo.disable-perfmon = "FALSE"' in VM config).
1
Provisioning
You can use theProcessManagerfrom Vim API to execute scripts. Python bindings areavailable After usingGuestProgramSpectogether with an instance ofGuestAuthenticationas arguments toStartProgramInGuestuniqueJobIDis obtained. Script progress can be tracked by using theListProcessesInGuestcommand.ListProcessesInGuestaccept...
1
Python example
```
1
!/usr/bin/env python
1
-*- coding: utf-8 -*-
import sys,time from pyVim import connect from pyVmomi import vmodl,vim def runInline(content,vm,creds,source): ''' Execute script source on vm ''' if isinstance(source, list): source = '\n'.join(source) ps = vim.vm.guest.ProcessManager.ProgramSpec( programPath = 'console', arguments = source ) return content.guestOper...
1
------------------------------------------------------------------------------# if __name__ == '__main__':
host = sys.argv[1] # ip or something user = 'root' pwd = 'MikroTik' vmName = 'chr-test' dataStoreName = 'datastore1' service = connect.SmartConnectNoSSL(host=host,user=user,pwd=pwd) if not service: _FAILURE("Could not connect to the specified host using specified username and password") content = service.RetrieveConten...
1
---------------------------------------------------------------------------
1
Find datacenter and datastore
datacenter,datastore = findDatastore(content,dataStoreName) if not datacenter or not datastore: connect.Disconnect(service) _FAILURE('Could not find datastore \'{}\'',dataStorename)
1
---------------------------------------------------------------------------
1
Locate vm
vmxPath = '[{0}] {1}/{1}.vmx'.format(dataStoreName, vmName) vm = content.searchIndex.FindByDatastorePath(datacenter, vmxPath) if not vm: connect.Disconnect(service) _FAILURE("Could not locate vm")
1
---------------------------------------------------------------------------
1
Setup credentials from user name and pasword
creds = vim.vm.guest.NamePasswordAuthentication(username = 'admin', password = '')
1
---------------------------------------------------------------------------
1
Run script
pm = content.guestOperationsManager.processManager try:
1
Run script
src = [':ip address add address=192.168.0.1/24 interface=ether1;'] jobID = runInline(content, vm, creds, src)
1
Or run file (from FTP root)
1
jobID = runFromFile(content,vm,creds, 'scripts/provision.rsc')
1
---------------------------------------------------------------------------
1
Wait for job to finish
pm = content.guestOperationsManager.processManager jobInfo = pm.ListProcessesInGuest(vm, creds, [jobID])[0] while jobInfo.endTime is None: time.sleep(1.0) jobInfo = pm.ListProcessesInGuest(vm, creds, [jobID])[0] if jobInfo.exitCode != 0: _FAILURE('Script failed!') except: raise else: connect.Disconnect(service) ```
1
KVM
QEMU guest agent is available. Supported agent commands can be retrieved by using the guest-info command. Host-guest file transfer can be performed by using guest-file-* commands. Guest networking information can be retrieved by using the guest-network-get-interfaces command. * An additional agent channel ('chr.provisi...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Command Line Interface
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328134/Command+Line+Interface
20
Login Options
Console login options enable or disable various console features like color, terminal detection, and many other. Additional login parameters can be appended to the login name after the '+' sign. ``` login_name ::= user_name [ '+' parameters ] parameters ::= parameter [ parameters ] parameter ::= [ number ] 'a'..'z' num...
1
Banner and Messages
The login process will display the MikroTik banner and short help after validating the user name and password. ``` MMM MMM KKK TTTTTTTTTTT KKK MMMM MMMM KKK TTTTTTTTTTT KKK MMM MMMM MMM III KKK KKK RRRRRR OOOOOO TTT III KK...
1
Command Prompt
At the end of the successful login sequence, the login process prints a banner that shows the command prompt, and hands over control to the user. Default command prompt consists of user name, system identity, and current command path /> For example, change the current path from the root to the interface then go back to...
1
Hierarchy
The console allows the configuration of the router's settings using text commands. Since there is a lot of available commands, they are split into groups organized in a way of hierarchical menu levels. The name of a menu level reflects the configuration information accessible in the relevant section. For example, you c...
1
DST-ADDRESS GATEWAY DISTANCE
0 XS 4.4.4.4 10.155.101.1 D o 0.0.0.0/0 10.155.101.1 110 1 AS 0.0.0.0/0 10.155.101.1 1 D b 1.0.4.0/24 10.155.101.1 20 D b 1.0.4.0/24 10.155.101.1 20 DAb 1.0.4.0/24 10.155.101.1 20 [admin@MikroTik] > ``` In...
1
DST-ADDRESS GATEWAY DISTANCE
0 XS 4.4.4.4 10.155.101.1 D o 0.0.0.0/0 10.155.101.1 110 1 AS 0.0.0.0/0 10.155.101.1 1 D b 1.0.4.0/24 10.155.101.1 20 D b 1.0.4.0/24 10.155.101.1 20 DAb 1.0.4.0/24 10.155.101.1 20 [admin@MikroTik] > ``` Ea...
1
DST-ADDRESS GATEWAY DISTANCE
0 XS 4.4.4.4 10.155.101.1 D o 0.0.0.0/0 10.155.101.1 110 1 AS 0.0.0.0/0 10.155.101.1 1 D b 1.0.4.0/24 10.155.101.1 20 D b 1.0.4.0/24 10.155.101.1 20 DAb 1.0.4.0/24 10.155.101.1 20 [admin@MikroTik] > ``` No...
1
NAME PORTS
0 ftp 21 1 tftp 69 2 irc 6667 3 h323 4 sip 5 pptp [admin@MikroTik] /ip/firewall/nat> ```
1
Item Names and Numbers
Many of the command levels operate with arrays of items: interfaces, routes, users, etc. Such arrays are displayed in similarly-looking lists. All items in the list have an item number followed by flags and parameter values. To change the properties of an item, you have to use the set command and specify the name or nu...
1
Item Names
Some lists have items with specific names assigned to each of them. Examples are interface or user levels. There you can use item names instead of item numbers. You do not have to use the print command before accessing items by their names, which, as opposed to numbers, are not assigned by the console internally, but a...
1
Item Numbers
Item numbers are assigned by the print command and are not constant - it is possible that two successive print commands will order items differently. But the results of the last print commands are memorized and, thus, once assigned, item numbers can be used even after add, remove and move operations (since version 3, m...
1
NAME TYPE MTU
0 R ether1 ether 1500 1 R ether2 ether 1500 2 R ether3 ether 1500 3 R ether4 ether 1500 [admin@MikroTik] > interface set 0,1,2 mtu=1460 [admin@MikroTik] > interface print Flags: X - disabled, D - dynamic, R - running
1
NAME TYPE MTU
0 R ether1 ether 1460 1 R ether2 ether 1460 2 R ether3 ether 1460 3 R ether4 ether 1500 [admin@MikroTik] > ```
1
General Commands
There are some commands that are common to nearly all menu levels, namely:print, set, remove, add, find, get, export, enable, disable, comment, move.These commands have similar behavior throughout different menu levels. Property | Description ---------------------- add | This command usually has all the same arguments ...
1
Input Modes
It is possible to switch between several input modes:
1
Quick Typing
There are two features in the console that help entering commands much quicker and easier - the [Tab] key completions, and abbreviations of command names. Completions work similarly to the bash shell in UNIX. If you press the [Tab] key after a part of a word, the console tries to find the command within the current con...
1
Console Search
Console search allows performing keyword search through the list of RouterOS menus and the history. The search prompt is accessible with the[Ctrl+r]shortcut.
1
Internal Chat System
RouterOS console has a built-in internal chat system. This allows remotely located admins to talk to each other directly in RouterOS CLI. To start the conversation prefix the intended message with the # symbol, anyone who is logged in at the time of sending the message will see it. ``` [admin@MikroTik] > # ready to bre...
1
List of Keys
Key | Description ----------------- Control-C | keyboard interrupt Control-D | log out (if an input line is empty) Control-K | clear from the cursor to the end of the line Control-U | clear from the cursor to the beginning of the line Control-X or F4 | toggle safe mode F7 | toggle hot-lock mode Control-R or F3 | toggle...
1
| Send a message to an internal chat system
Delete | remove character at the cursor Control-H or Backspace | removes character before cursor and moves the cursor back one position. Control-\ | split line at cursor. Insert newline at the cursor position. Display second of the two resulting lines. Control-B or Left | move cursor backward one character Control-F or...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Common Firewall Matchers and Actions
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/250708064/Common+Firewall+Matchers+and+Actions
7
Common Actions and Associated properties
Property | Description ---------------------- action(action name; Default:accept) | Action to take if a packet is matched by the rule:accept- accept the packet. A packet is not passed to the next firewall rule.add-dst-to-address-list- add destination address toaddress listspecified byaddress-listparameteradd-src-to-add...
1
Stats
To view matching statistics by firewall rules, run/ip firewall filter print statscommand or/ipv6 firewall filter print statsfor IPv6 firewall. ``` /ip firewall filter print stats ``` ``` /ipv6 firewall filter print stats ``` Property | Description ---------------------- bytes(integer) | The total amount of bytes matche...
1
CHAIN                                                                                                                 ACTION                            BYTES         PACKETS
0  D ;;; special dummy rule to show fasttrack counters forward                                                                                                               passthrough              50 507 925 242      50 048 246 1    ;;; defconf: drop invalid forward                                                     ...
1
Other Useful Commands
By default print is equivalent toprint staticand shows only static rules. ``` print static ``` To print also dynamic rules useprint all. ``` print all ``` Or to print only dynamic rules useprint dynamic. ``` print dynamic ```
1
Matchers
Tables below shows all the properties that can be used as a matchers in the firewall rules. Matchers are executed in a specific order. For IPv4: For IPv6: Properties are split in two parts:
1
Stateless Properties
Property | Description ---------------------- chain(name; Default: ) | Specifies to which chain rule will be added. If the input does not match the name of an already defined chain, a new chain will be created comment(string; Default: ) | Descriptive comment for the rule content(string; Default: ) | Match packets that ...
1
Stateful Properties
Property | Description ---------------------- connection-bytes(integer-integer; Default: ) | Matches packets only if a given amount of bytes has been transferred through the particular connection.0 - means infinity, for exampleconnection-bytes=2000000-0means that the rule matches if more than 2MB has been transferred t...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Configuration Management
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328155/Configuration+Management
23
Overview
This article describes a set of commands used for configuration management.
1
Configuration Undo and Redo
Any action done in the GUI or any command executed from the CLI is recorded in/system history.  You can undo or redo any action by runningundoorredocommands from the CLI or by clicking on Undo, and Redo buttons from the GUI. ``` /system history ``` A simple example to demonstrate the addition of the firewall rule and h...
1
Safe Mode
It is sometimes possible to change router configuration in a way that will make the router inaccessible (except from the local console). Usually, this is done by accident, but there is no way to undo the last change when the connection to the router is already cut. Safe mode can be used to minimize such risk. The"Safe ...
1
System Backup and Restore
System backupis the way to completely clone router configuration in binary format. More information about Backup and Restore is foundhere.
1
Configuration Export and Import
RouterOS allows exporting and importing parts of the configuration in plain text format. This method can be used to copy bits of configuration between different devices, for example, clone the whole firewall from one router to another. An export command can be executed from each menu (resulting in configuration export ...
1
Configuration Export
The following command parameters are accepted: Property | Description ---------------------- compact | Output only modified configuration, the default behavior file | Export configuration to a specified file. When the file is not specified export output will be printed to the terminal show-sensitive(yes|no; Default: no...
1
ADDRESS NETWORK BROADCAST INTERFACE
0 10.1.0.172/24 10.1.0.0 10.1.0.255 bridge1 1 10.5.1.1/24 10.5.1.0 10.5.1.255 ether1 [admin@MikroTik] > /ip address export file=address [admin@MikroTik] > /file print
1
NAME TYPE SIZE CREATION-TIME
0 address.rsc script 315 dec/23/2003 13:21:48 [admin@MikroTik] > ``` By default, the export command writes only user-edited configuration, RouterOS defaults are omitted. For example, the IPSec default policy will not be exported, and if we change one property then only our change will ...
1
apr/02/1970 17:59:14 by RouterOS 6.22
1
software id = DB0D-LK67
1
[admin@rack1_b4] /ip ipsec policy> set 0 protocol=gre
[admin@rack1_b4] /ip ipsec policy> export
1
apr/02/1970 17:59:30 by RouterOS 6.22
1
software id = DB0D-LK67
1
/ip ipsec policy
set 0 protocol=gre ``` Here is the list of all menus containing default system entries Menu | Default Entry -------------------- /interface wireless security-profiles | default /ppp profile | "default", "default-encryption" /ip hotspot profile | default /ip hotspot user profile | default /ip ipsec policy | default /ip ...
1
Configuration Import
Root menu command import allows running configuration script from the specified file. Script file (with extension ".rsc") can contain any console command including complex scripts. For example, load saved configuration file ``` [admin@MikroTik] > import address.rsc Opening script file address.rsc Script file loaded and...
1
Auto Import
It is also possible toautomaticallyexecute scripts after uploading to the router with FTP or SFTP. The script file must be named with the extension *.auto.rsc. Once the commands in the file are executed, a new *.auto.log file is created which contains import success or failure information.
1
Import troubleshooting
1
Configuration parts to watch out for in exported .rsc files
Things that should be removed from export files that were created with "/export", before attempting import on a new device. ``` /interface ethernet set [ find default-name=ether5 ] auto-negotiation=no name=ether1-gateway set [ find default-name=ether6 ] name=ether2 set [ find default-name=ether7 ] name=ether3 set [ fin...
1
Startup delay
If your configuration relies on interfaces that might not yet have started up upon command execution, it is suggested to introduce delays or to monitor until all needed interfaces are available. This example script allows you to set how many interfaces you are expecting, and how long to wait until they become available...
1
Number of interfaces. It is necessary to reconfigure this number for each device (/interface print count-only)
:local x 10
1
Max time to wait
:local t 30 while ($i < $t && [:len [/interface find]] < $x) do={ :put $i :set $i ($i + 1) :delay 1 } if ($i = $t) do={ :log warning message="Could not load all physical interfaces" } else={
1
Rest of your script
} } ``` The above script will wait until there are 10 interfaces visible, or 30 seconds. If there are no 10 interfaces at this time, it will put a message in the log. Modify the variables according to your needs.
1
Configuration Reset
RouterOS allows resetting configuration with/systemreset-configurationcommand ``` /systemreset-configuration ``` This command clears all configuration of the router and sets it to the factory defaults including the login name and password ('admin' with an empty passwordor, for some models, check user and wireless passw...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Connection rate
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/131366985/Connection+rate
8
Introduction
Connection Rate is a firewall matcher that allows capturing traffic based on the present speed of the connection.
1
Theory
Each entry in the connection tracking table represents bidirectional communication. Every time a packet gets associated with a particular entry, the packet size value (including the IP header) is added to the "connection-bytes" value for this entry. (in other words "connection-bytes" includes both - upload and download...
1
Rule Example
These rules will capture TCP/UDP traffic that was going through the router when the connection speed was below 100kbps: ``` /ip firewall filter add action=accept chain=forward connection-rate=0-100k protocol=tcp add action=accept chain=forward connection-rate=0-100k protocol=udp ```
1
Application Example - Traffic Prioritization
Connection-rate can be used in various ways, that still need to be realized, but the most common setup will be to detect and set lower priorities to the "heavy connections" (connections that maintain a fast rate for long periods (such as P2P, HTTP, FTP downloads). By doing this you can prioritize all other traffic that...
1
Quick Start for Impatient
``` /ip firewall mangle add chain=forward action=mark-connection connection-mark=!heavy_traffic_conn new-connection-mark=all_conn add chain=forward action=mark-connection connection-bytes=500000-0 connection-mark=all_conn connection-rate=200k-100M new-connection-mark=heavy_traffic_conn protocol=tcp add chain=forward ac...
1
Explanation
In mangle, we need to separate all connections into two groups, and then mark packets from their 2 groups. As we are talking about client traffic most logical place for marking would be the mangle chain forward. Keep in mind that as soon as a "heavy" connection will have lower priority and queue will hit max-limit - he...
1
IP Firewall mangle
This rule will ensure that that "heavy" connections will remain heavy". and mark the rest of the connections with the default connection mark: ``` /ip firewall mangle add chain=forward action=mark-connection connection-mark=!heavy_traffic_conn new-connection-mark=all_conn ``` These two rules will mark all heavy connect...
1
Queue
This is a simple queue tree that is placed on the Interface HTB - "public" is an interface where your ISP is connected, and "local" is where are your clients. If you have more than 1 "public" or more than 1 "local" you will need to mangle upload and download separately and place the queue tree in global-out: ``` /queue...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Connection tracking
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/130220087/Connection+tracking
11
Introduction
Connection tracking allows the kernel to keep track of all logical network connections or sessions, and thereby relate all of the packets which may make up that connection. NAT relies on this information to translate all related packets in the same way. Because of connection tracking you can use stateful firewall funct...
1
PR.. SRC-ADDRESS DST-ADDRESS TCP-STATE TIMEOUT
0 udp 10.5.8.176:5678 255.255.255.255:5678 0s 1 udp 10.5.101.3:646 224.0.0.2:646 5s 2 ospf 10.5.101.161 224.0.0.5 9m58s 3 udp 10.5.8.140:5678 255.255.255.255:5678 8s 4 SA tcp 10.5.101.147:48984 10.5.101....
1
PRO.. SRC-ADDRESS DST-ADDRESS TCP-STATE
0 udp fe80::d6ca:6dff:fe77:3698 ff02::1 1 udp fe80::d6ca:6dff:fe98:7c28 ff02::1 2 ospf fe80::d6ca:6dff:fe73:9822 ff02::5 ```
1
Connection states
Based on connection table entries arrived packet can get assigned one of the connection states:new, invalid, established, related,oruntracked. There are two different methods when the packet is considerednew. The first one is in the case of stateless connections (like UDP) when there is no connection entry in the conne...
1
FastTrack
IPv4 FastTrack is a special handler that bypasses Linux facilities allowing for faster packet forwarding. The handler is used forTCPandUDPconnections marked with "fasttrack-connection" action. IPv4 FastTrack handler supports NAT (SNAT, DNAT, or both). ``` fasttrack-connection ``` Note that not all packets of the connec...
1
Requirements
IPv4 FastTrack is active if the following conditions are met:
1
Example
For example, for SOHO routers with factory default configuration, you could FastTrack all LAN traffic with this one rule placed at the top of the Firewall Filter. The same configuration accept rule is required: ``` /ip firewall filter add chain=forward action=fasttrack-connection connection-state=established,related /i...
1
Connection tracking settings
Connection tracking settings are managed from/ip firewall connection trackingmenu. ``` /ip firewall connection tracking ```
1
Properties
Property | Description ---------------------- enabled(yes | no | auto; Default:auto) | Allows to disable or enable connection tracking. With disabled connection tracking  firewall features listed above will stop working. If set to "auto" connection tracking is disabled until at least one firewall rule is added. loose-t...
1
Connection List
List of tracked connections ban be seen in/ip firewall connectionfor ipv4 and/ipv6firewall connectionfor IPv6.
1
Properties
All properties in the connection list are read-only Property | Description ---------------------- assured(yes | no) | Indicates that this connection is assured and that it will not be erased if the maximum possible tracked connection count is reached. confirmed(yes | no) | Connection is confirmed and a packet is sent o...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Console
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/8978498/Console
19
Overview
The console is used for accessing the MikroTik Router's configuration and management features using text terminals, either remotely using a serial port, telnet, SSH, or console screen within Winbox, or directly using a monitor and keyboard. The console is also used for writing scripts. This manual describes the general...
1
Hierarchy
The console allows the configuration of the router's settings using text commands. Since there are a lot of available commands, they are split into groups organized in a way of hierarchical menu levels. The name of a menu level reflects the configuration information accessible in the relevant section, eg./ip hotspot.
1
Example
For example, you can issue the/ip route printcommand: ``` [admin@MikroTik] > ip route print Flags: X - disabled, A - active, D - dynamic, C - connect, S - static, r - rip, b - bgp, o - ospf, m - mme, B - blackhole, U - unreachable, P - prohibit
1
DST-ADDRESS PREF-SRC G GATEWAY DIS INTE...
0 A S 0.0.0.0/0 r 10.0.3.1 1 bridge1 1 ADC 1.0.1.0/24 1.0.1.1 0 bridge1 2 ADC 1.0.2.0/24 1.0.2.1 0 ether3 3 ADC 10.0.3.0/24 10.0.3.144 0 bridge1 4 ADC 10.10.10.0/24 10.10.10.1 0 wlan1 [admin@MikroTik] > ``` Instead of typing/ip routepath before each command, the path can be typed only once to move into this particular ...
1
NAME PORTS
0 ftp 21 1 tftp 69 2 irc 6667 3 h323 4 sip 5 pptp [admin@MikroTik] ip firewall nat> ```
1
Item Names and Numbers
Many of the command levels operate with arrays of items: interfaces, routes, users, etc. Such arrays are displayed in similarly looking lists. All items in the list have an item number followed by flags and parameter values. To change the properties of an item, you have to usethesetcommand and specify the name or numbe...
1
Item Names
Some lists have items with specific names assigned to each of them. Examples areinterfaceoruserlevels. There you can use item names instead of item numbers. You do not have to use theprintcommand before accessing items by their names, which, as opposed to numbers, are not assigned by the console internally, but are pro...
1
Item Numbers
Item numbers are assigned by the print command and are not constant - two successive print commands may order items differently. But the results of the last print commands are memorized and, thus, once assigned, item numbers can be used even afteradd,remove,andmoveoperations. Item numbers are assigned on a per-session ...
1
NAME TYPE MTU
0 R ether1 ether 1500 1 R ether2 ether 1500 2 R ether3 ether 1500 3 R ether4 ether 1500 [admin@MikroTik] > interface set 0,1,2 mtu=1460 [admin@MikroTik] > interface print Flags: X - disabled, D - dynamic, R - running
1
NAME TYPE MTU
0 R ether1 ether 1460 1 R ether2 ether 1460 2 R ether3 ether 1460 3 R ether4 ether 1500 [admin@MikroTik] > ``` Warning:Do not use Item numbers in scripts, it is not a reliable way to edit items inthescheduler. scripts, etc. Instead, usethe "find"command. More infoherealso look atscripting examples.
1
Quick Typing
Two features in the console help entering commands much quicker and easier - the[Tab]key completions, and abbreviations of command names. Completions work similarly to the bash shell in UNIX. If you press the[Tab]key after a part of a word, the console tries to find the command within the current context that begins wi...
1
General Commands
Some commands are common to nearly all menu levels, namely:print,set,remove,add,find,get,export,enable,disable,comment, andmove. These commands have similar behavior throughout different menu levels.
1
Modes
The console line editor works either in multiline mode or in single-line mode. In multiline mode line editor displays the complete input line, even if it is longer than a single terminal line. It also uses a full-screen editor for editing large text values, such as scripts. In single-line mode, only one terminal line i...
1
Settings
In "/console/settings" menu, it is possible to enable option for replacing reserved characters with underscores for file name. Property | Description ---------------------- sanitize-names(yes| noDefault:no) | Replace reserved characters (\ / : * ?  |)  with underscores
1
List of keys
``` F1 Give the list of available commands command F1 Give help on the command and list of arguments [Tab] Complete the command/word. If the input is ambiguous, a second [Tab] gives possible options F3 or Ctrl-R Search command history F4 or Ctrl-X Toggle safe mode F5 or Ctrl-L Repai...
1
Built-in Help
The console has built-in help. PressF1for general console usage Help. The general rule is that Help shows what you can type in a position where theF1was pressed (similarly to pressing[Tab]key twice, but in verbose form and with explanations).
1
Safe Mode
It is sometimes possible to change router configuration in a way that will make the router inaccessible (except from the local console). Usually, this is done by accident, but there is no way to undo the last change when the connection to the router is already cut. Safe mode can be used to minimize such risk. The"Safe ...
1
HotLock Mode
When HotLock mode is enabled commands will be auto-completed. To enter/exit HotLock mode pressF7. ``` [admin@MikroTik] /ip/address> [F7] [admin@MikroTik] /ip/address>> ``` Double>>is an indication that HotLock mode is enabled. For example, if you type "/in et", it will be auto-completed to ``` >> ``` ``` /in et" ``` ``...
1
Lock Mode
The ":lock" command locks the screen. ``` [admin@MikroTik] > :lock ... MMM MMM KKK TTTTTTTTTTT KKK MMMM MMMM KKK TTTTTTTTTTT KKK MMM MMMM MMM III KKK KKK RRRRRR OOOOOO TTT III KKK KKK MMM MM MMM III KKKKK RRR RRR...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Container
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/84901929/Container
17
Summary
Sub-menu:/containerPackages required:container ``` /container ``` ``` container ``` A container is MikroTik's implementation of Linux containers, allowing users to run containerized environments within RouterOS. The container feature was added in RouterOS v7.4beta4. Containers are compatible with images from Docker Hub...
1
Disclaimer
1
Security risks:
when a security expert publishes his exploit research - anyone can apply such an exploit;someone will build a container image that will do the exploit AND provide a Linux root shell;by using a root shell someone may leave a permanent backdoor/vulnerability in your RouterOS system even after the container image is remov...
1
Requirements
Container package is compatible witharm arm64andx86architectures. Using of remote-image (similar to docker pull) functionality requires a lot of free space in main memory, 16MB SPI flash boards may use pre-build images on USB or other disk media. ``` /container ```
1
Properties
Property | Description ---------------------- cmd(string; Default: ) | The main purpose of a CMD is to provide defaults for an executing container. These defaults can include an executable, or they can omit the executable, in which case you must specify an ENTRYPOINT instruction as well. comment(string; Default: ) | Sh...
1
Container configuration
``` /container/config/ ``` Property | Description ---------------------- registry-url | external registry url from where the container will be downloaded tmpdir | container extraction directory ram-high | RAM usage limit.  (0 for unlimited) username | Specifies the username for authentication ( starting from ROS 7.8) p...
1
Container use example
Prerequisites:
1
Enable Container mode
enable container mode ``` /system/device-mode/update container=yes ``` You will need to confirm the device-mode with a press of the reset button, or a cold reboot, if using container on X86.
1
Create network
Add veth interface for the container: ``` /interface/veth/add name=veth1 address=172.17.0.2/24 gateway=172.17.0.1 ``` Create a bridge for containers and add veth to it: ``` /interface/bridge/add name=containers /ip/address/add address=172.17.0.1/24 interface=containers /interface/bridge/port add bridge=containers inter...
1
Add environment variables and mounts (optional)
Create environment variables for container(optional): ``` /container/envs/add name=pihole_envs key=TZ value="Europe/Riga" /container/envs/add name=pihole_envs key=WEBPASSWORD value="mysecurepassword" /container/envs/add name=pihole_envs key=DNSMASQ_USER value="root" ``` Define mounts (optional): ``` /container/mounts/a...
1
a) get an image from an external library
Set registry-url (for downloading containers from Docker registry)  and set extract directory (tmpdir) to attached USB media: ``` /container/config/set registry-url=https://registry-1.docker.io tmpdir=disk1/pull ``` pull image: ``` /container/add remote-image=pihole/pihole:latest interface=veth1 root-dir=disk1/pihole m...
1
b) import image from PC
These links arelatestas of16th of June, 2022. Please make sure to download the right version that matches Your RouterOS device's architecture.Update sha256 sum from docker hub to get the latest image files ``` latest ``` ``` arm64: docker pull pihole/pihole:latest@sha256:4cef8a7b32d318ba218c080a3673b56f396d2e2c74d375be...
1
c) build an image on PC
1
Steps for Linux systems
To use Dockerfile and make your own docker package - docker needs to be installed as well as buildx or other builder toolkit. Easiest way is to download and install Docker Engine:https://docs.docker.com/engine/install/ After install check if extra architectures are available: ``` docker buildx ls ``` should return: ```...
1
Start container
Make sure container has been added andstatus=stoppedby using/container/print ``` status=stopped ``` ``` /container/print ``` ``` /container/start 0 ``` You should be able to access the PiHole web panel by navigating tohttp://172.17.0.2/admin/in your web browser. ``` http://172.17.0.2/admin/ ```
1
Forward ports to internal container
Ports can be forwarded using dst-nat (where 192.168.88.1 routers IP address): ``` /ip firewall nat add action=dst-nat chain=dstnat dst-address=192.168.88.1 dst-port=80 protocol=tcp to-addresses=172.17.0.2 to-ports=80 ``` For Pihole container - set DNS server to containers veth interface IP address - ``` /ip dns set ser...
1
Tips and tricks
``` /container/config/set ram-high=200M ``` this will soft limit RAM usage - if a RAM usage goes over the high boundary, the processes of the cgroup are throttled and put under heavy reclaim pressure. 0 name="2e679415-2edd-4300-8fab-a779ec267058" tag="test_arm64:latest" os="linux" arch="arm" interface=veth2 root-dir=di...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Container - freeradius server
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/172294200/Container+-+freeradius+server
10
Introduction
The introduction of the container feature into the RouterOS made it possible to run all kinds of servers for all sorts of tasks inside the router. This is especially relevant for people, who want to reduce the number of devices in their network. Instead of running a server on a separate device/machine, why not run it i...
1
Summary
Sub-menu:/container ``` /container ``` note:containerpackage is required. Make sure to study ourcontainerguide before proceeding with the configuration. Make sure to check thedisclaimerandrequirementssections to understand all the risks and necessary steps you might be required to do. At the time, when the guide was pu...
1
Configuration
1
Container mode
Enable container mode: ``` /system/device-mode/update container=yes ``` You will need to confirm the device-mode with a cold reboot if using the container on X86.
1
Networking
Add veth interface for the container: ``` /interface/veth/add name=veth3 address=172.17.0.2/24 gateway=172.17.0.1 ``` Create a bridge for the container, assign an IP network to it, and add veth to the bridge: ``` /interface/bridge/add name=dockerfreeradius /ip/address/add address=172.17.0.1/24 interface=dockerfreeradiu...
1
Getting image
To simplify the configuration, we will get the image from an external library but you can also import it via the.tarfile. Make sure that you have "Registry URL" set accordingly, limit RAM usage (if necessary), and set up a directory for the image: ``` /container/config/set registry-url=https://registry-1.docker.io tmpd...
1
Starting the container
After you make sure that the container has been added and the status changed tostatus=stoppedafter using/container/print→ you can initiate it: ``` status=stopped ``` ``` /container/print ``` ``` /container/start 0 ```
1
Altering the server's configuration files
To access the server's configuration files (clients.confandauthorize), we will need to use SFTP (file transfer over SSH) protocol, so make sure that SSHserviceis enabled. Open your command terminal ("CMD", as Administrator, for Windows users, or "Linux Shell or Command Terminal" for Linux users) and navigate it to the ...
1
Result verification
In RouterOS, add a new RADIUS client configuration: ``` /radius/add service=login address=172.17.0.2 secret="client_password" ``` ,where theaddressis the IP address of the veth3 interface,secretis the secret that we configured in theclients.conffile andserviceis the allowed service that you wish to use. ``` address ```...
1
WHEN NAME ADDRESS VIA
0 feb/16/2023 16:31:21 admin xx.xx.xx.xx winbox 1 feb/16/2023 16:38:46 admin xx.xx.xx.xx console 2 R feb/16/2023 16:38:53 bob 10.55.8.53 ssh ``` you will be able to verify, that a new user "bob" is "active" and has a flag "R" assigned, which indicates it is a RADIUS user.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Container - HomeAssistant
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/204341276/Container+-+HomeAssistant
10
Introduction
The introduction of the container feature into the RouterOS made it possible to run all kinds of servers for all sorts of tasks inside the router. This is especially relevant for people, who want to reduce the number of devices in their network. Instead of running a server on a separate device/machine, why not run it i...
1
Summary
Make sure to study ourcontainerguide before proceeding with the configuration. Make sure to check thedisclaimerandrequirementssections to understand all the risks and necessary steps you might be required to do. You can find supported architectures by following thelink. At the time, when the guide was published,home-as...
1
Container configuration
Sub-menu:/container ``` /container ``` note:containerpackage is required.
1
Container mode
Enable container mode: ``` /system/device-mode/update container=yes ``` You will need to confirm the device-mode with a press of the reset button, or a cold reboot, if using container on X86.
1
Networking
Add veth interface: ``` /interface/veth/add name=veth2 address=172.19.0.2/24 gateway=172.19.0.1 ``` Create a bridge for both containers and add veth interfaces to it: ``` /interface/bridge/add name=ha /ip/address/add address=172.19.0.1/24 interface=ha /interface/bridge/port add bridge=ha interface=veth2 ``` Forward TCP...
1
Environment variables and mounts
Per the home-assist documentation, define mounts for the configuration files (where,/usb1is our external USB storage folder): ``` /usb1 ``` ``` /container mounts add dst=/config name=ha_config src=/usb1/ha_config ``` Create an environmental variable for home-assistant: ``` /container envs add key=TZ name=ha_env value=A...
1
Getting image
To simplify the configuration, we will get the images from an external library. Make sure that you have "Registry URL" set accordingly, limit RAM usage (if necessary), and set up a directory for the images: ``` /container/config/set registry-url=https://registry-1.docker.io tmpdir=/usb1/pull ``` Pull home-assistant ima...
1
Starting the container
After you make sure that the container has been added and the status changed tostatus=stoppedafter using/container/print→ you can initiate it: ``` status=stopped ``` ``` /container/print ``` ``` /container/start 0 ```
1
Home-Assistant setup
Open your preferred web browser and access the Home-Assistant management portal by specifying management port ":8123": Proceed with the setup. More information is explained in theHome-Assistant onboarding guide.
1
Resources
Just running theHome Assistanton L009 (without any load/traffic) takes up ~300 MB of RAM: ``` /system resource print uptime: 4m27s version: 7.13.3 (stable) build-time: Jan/24/2024 13:16:46 factory-software: 7.10 free-memory: 143.0MiB total-memory: 448.0MiB cpu: ARM ``` With the load, it will increase, but for testing, ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Container - mosquitto MQTT server
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/169246787/Container+-+mosquitto+MQTT+server
14
Introduction
The introduction of the container feature into the RouterOS made it possible to run all kinds of servers for all sorts of tasks inside the router. This is especially relevant for people, who want to reduce the number of devices in their network. Instead of running a server on a separate device/machine, why not run it i...
1
Summary
Make sure to study ourcontainerguide before proceeding with the configuration. Make sure to check thedisclaimerandrequirementssections to understand all the risks and necessary steps you might be required to do. You can find supported architectures by following thelink. At the time, when the guide was published,eclipse...
1
Container configuration
Sub-menu:/container ``` /container ``` note:containerpackage is required.
1
Container mode
Enable container mode: ``` /system/device-mode/update container=yes ``` You will need to confirm the device-mode with a press of the reset button, or a cold reboot, if using container on X86.
1
Networking
Add veth interface for the container: ``` /interface/veth/add name=veth2 address=172.19.0.2/24 gateway=172.19.0.1 ``` Create a bridge for containers and add veth to it: ``` /interface/bridge/add name=msqt /ip/address/add address=172.19.0.1/24 interface=msqt /interface/bridge/port add bridge=msqt interface=veth2 ``` For...
1
Environment variables and mounts
Per the eclipse-mosquitto docker hub, define a mount for the configuration file. We will mount not just the configuration file, but the whole folder, because, for SSL MQTT, we will need to upload certificates into the folder as well: ``` /container mounts add src=/mosquitto_mounted dst=/mosquitto/config name=msqt_confi...
1
Getting image
To simplify the configuration, we will get the image from an external library but you can also import it via the.tarfile. In this example, we will use the device's own storage. RB1100AHx4 has 128 MB disk space and a basic mosquitto installation should not take up more than ~15 MB. Make sure that you have "Registry URL"...
1
Setting up mosquitto configuration file
To get themosquttio.conffile, we will need to use SFTP (file transfer over SSH) protocol, so make sure that SSHserviceis enabled. You can also use FTP. Open your command terminal ("CMD", as Administrator, for Windows users, or "Linux Shell or Command Terminal" for Linux users) and navigate it to the directory where you...
1
Starting the container
After you make sure that the container has been added and the status changed tostatus=stoppedafter using/container/print→ you can initiate it: ``` status=stopped ``` ``` /container/print ``` ``` /container/start 0 ``` If you have enabled container logging, you would see something like this in theLogssection: ``` 12:12:...
1
MQTT publish and subscribe
Sub-menu:/iot mqtt ``` /iot mqtt ``` note:iotpackage is required. Add an MQTT broker: ``` /iot/mqtt/brokers/add name=mosquitto username=test address=172.19.0.2 ``` Subscribe to the MQTT broker and the required topic: ``` /iot/mqtt/subscribe broker=mosquitto topic=test/topic ``` Publish a static MQTT message: ``` /iot/m...
1
SSL MQTT
Usingnon-SSL MQTTfor a production environmentis not secure. One can easilycapture/sniffthe packet exchange between the broker and the publisher and, as a result, will be able to obtain user credentials and other sensitive information. To increase security, use SSL MQTT. The first step is to generate the certificates. I...
1
Server configuration
You should have generated ca.crt (Certificate Authority file), server.crt (server certificate) and server.key (server's key): ``` C:\Users\Administrator\Desktop\Container>dir Directory of C:\Users\Administrator\Desktop\Container 07/12/2023 10:58 AM <DIR> . 07/12/2023 10:58 AM <DIR> .. 07/12/20...
1
Testing the connection
Upload CA certificate (ca.crt) into RouterOS, into the device's "File List": ``` /file print Columns: NAME, TYPE, SIZE, CREATION-TIME
1
NAME TYPE SIZE CREATION-TIME
0 skins directory 1970-01-01 03:00:02 1 pub directory 2023-01-04 11:05:04 2 disk7 disk 2023-07-12 09:52:07 3 mosquitto container store 2023-07-12 09:52:09 4 mosquitto_mounted container store 2023-07-25...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Container - ThingsBoard MQTT/HTTP server
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/166920348/Container+-+ThingsBoard+MQTT+HTTP+server
43
Introduction
The introduction of the container feature into the RouterOS made it possible to run all kinds of servers for all sorts of tasks inside the router. This is especially relevant for people, who want to reduce the number of devices in their network. Instead of running a server on a separate device/machine, why not run it i...
1
Summary
Sub-menu:/container ``` /container ``` note:containerpackage is required. RouterOS versions that are older than v7.8 will not be able to run this scenario. Make sure to study ourcontainerguide before proceeding with the configuration. Make sure to check thedisclaimerandrequirementssections to understand all the risks a...
1
Configuration
1
Container mode
Enable container mode: ``` /system/device-mode/update container=yes ``` You will need to confirm the device-mode with a press of the reset button, or a cold reboot, if using container on X86.
1
Networking
Add veth interface for the container: ``` /interface/veth/add name=veth1 address=172.18.0.2/24 gateway=172.18.0.1 ``` Create a bridge for the container, assign an IP network to it, and add veth to the bridge: ``` /interface/bridge/add name=dockertb /ip/address/add address=172.18.0.1/24 interface=dockertb /interface/bri...
1
Environment variables and mounts
Checkdocker-thingsboarddocumentation for exact mounts and variables that need to be added. Environment variables: ``` /container/envs/add name=tb_envs key=TB_QUEUE_TYPE value="in-memory" ``` Mounts: ``` /container/mounts/add name=mytb-data src=tb/mytb-data dst=/data /container/mounts/add name=mytb-logs src=tb/mytb-logs...
1
Getting image
To simplify the configuration, we will get the image from an external library but you can also import it via the.tarfile. Make sure that you have "Registry URL" set accordingly, limit RAM usage (if necessary), and set up a directory for the image. ``` /container/config/set registry-url=https://registry-1.docker.io tmpd...
1
Starting the container
After you make sure that the container has been added and the status changed tostatus=stoppedafter using/container/print→ you can initiate it: ``` status=stopped ``` ``` /container/print ``` ``` /container/start 0 ``` Wait for a couple of minutes for the container to fully load.
1
Verification
1
Management access
After the container is started and installed, access it using any browser, by going to →http://192.168.88.1:9090(where the IP address is the address used in the DNAT rule): By default, credentials are (Username/Password): The login prompt should confirm that the server is running.
1
MQTT test
Name it, however, you like, and click on "Add": Check your device access token by clicking on the device you've just created and selecting the "Manage credentials" setting (copy the access token generated or type in your own →  "YOUR_TOKEN"): After these steps, go to the RouterOS settings (back to CHR settings) and cre...
1
Enabling HTTPS and SSL MQTT
By default, HTTP and MQTT protocols are used. As mentioned previously in the "Networking" section, working with non-SSL HTTP and non-SSL MQTT is not very safe (unless they are used within heavily protected networks with a well-configured firewall/restricted access) andwe advise enabling HTTPSandSSL MQTT. Please check T...
1
Create certificates
Create a certificate for HTTPS: ``` /certificate add name=TBhttps common-name=172.18.0.2 /certificate sign TBhttps ``` Create a certificate for MQTT: ``` /certificate add name=TBmqtt common-name=172.18.0.2 /certificate sign TBmqtt ``` Confirm that they were added with the help of/certificate/printcommand: ``` /certific...
1
NAME COMMON-NAME FINGERPRINT
0 KAT TBhttps 172.18.0.2 863f4547c74ce3ec70c3e82172502711517b52bbc055d18c24ba4aafec46152c 1 KAT TBmqtt 172.18.0.2 ebf3ff5d03ed4cc73546e058da9bc414cdaf24ce45da29b203348045fbbd21ae ``` Export the certificates using PKCS12 format and set up a password/passphrase for them: ``` /certificate/export-certificate file-na...
1
NAME TYPE SIZE CREATION-TIME
0 tb/mytb-data container store jan/19/2023 13:43:16 1 container-log.0.txt .txt file 2240.5KiB jan/27/2023 15:37:41 2 skins directory jan/18/2023 15:12:22 3 tb/mytb-logs container store jan/27/2023 12:24:30 4 pull dire...
1
Download the ThingsBoard's configuration file
Open your command terminal ("CMD", as Administrator, for Windows users, or "Linux Shell or Command Terminal" for Linux users) and navigate it to the directory where the certificates are: ``` C:\Windows\System32>cd c:\Users\Admin\Desktop\ThingsBoard C:\Users\Admin\Desktop\ThingsBoard>dir Directory of C:\Users\Admin\Desk...
1
Alter the ThingsBoard's settings
Open "thingsboard.yml" via your preferred text editor (notepad or any other), and alter a few lines. You can backup this file and save it with a different name to have a copy of the default settings, in case, of misconfiguration. HTTPS-related settings: ``` ssl:
1
Enable/disable SSL support
enabled: "${SSL_ENABLED:true}"
1
Server SSL credentials
credentials:
1
Server credentials type (PEM - pem certificate file; KEYSTORE - java keystore)
type: "${SSL_CREDENTIALS_TYPE:KEYSTORE}"
1
Keystore server credentials
keystore:
1
Type of the key store (JKS or PKCS12)
type: "${SSL_KEY_STORE_TYPE:PKCS12}"
1
Path to the key store that holds the SSL certificate
store_file: "${SSL_KEY_STORE:keystore.p12}"
1
Password used to access the key store
store_password: "${SSL_KEY_STORE_PASSWORD:thingsboard_cert_password}"
1
Key alias
1
key_alias: "${SSL_KEY_ALIAS:tomcat}"
1
Password used to access the key
key_password: "${SSL_KEY_PASSWORD:thingsboard_cert_password}" ``` MQTT-related settings: ``` ssl:
1
Enable/disable SSL support
enabled: "${MQTT_SSL_ENABLED:true}"
1
Server SSL credentials
credentials:
1
Server credentials type (PEM - pem certificate file; KEYSTORE - java keystore)
type: "${MQTT_SSL_CREDENTIALS_TYPE:KEYSTORE}"
1
Keystore server credentials
keystore:
1
Type of the key store (JKS or PKCS12)
type: "${MQTT_SSL_KEY_STORE_TYPE:PKCS12}"
1
Path to the key store that holds the SSL certificate
store_file: "${MQTT_SSL_KEY_STORE:mqttserver.p12}"
1
Password used to access the key store
store_password: "${MQTT_SSL_KEY_STORE_PASSWORD:thingsboard_mqttcert_password}"
1
Optional alias of the private key; If not set, the platform will load the first private key from the keystore;
1
key_alias: "${MQTT_SSL_KEY_ALIAS:}"
1
Optional password to access the private key. If not set, the platform will attempt to load the private keys that are not protected with the password;
key_password: "${MQTT_SSL_KEY_PASSWORD:thingsboard_mqttcert_password}" ``` Apply the changes to the "thingsboard.yml" file (re-save it after editing).
1
Upload altered ThingsBoard configuration file
All that is left is to overwrite the current configuration file with an altered file and upload both certificates. Once again, make sure your terminal is pointing to the right folder (where 3 files are located → both certificates and an altered "thingsboard.yml" file), and, from there, SFTP into the container's configu...
1
Confirm HTTPS access
Now, you should be able to accesshttps://your_IP:9090(where the IP address is the address used in the DNAT rule):
1
Confirm SSL MQTT connection
In this example, we will test aone-way SSL communication access token scenario.
1
Testing with the device that is running the container
Add MQTT broker: ``` /iot/mqtt/brokers/add name=tbssl address=172.18.0.2 port=8883 username=YOUR_TOKEN ssl=yes ``` Publish a static test MQTT message in the JSON format: ``` /iot/mqtt/publish broker="tbssl" topic="v1/devices/me/telemetry" message="{\"test\":\"123\"}" ``` Confirm that it was received by the MQTT broker:
1
Testing with another device
When you have two RouterOS devices, one that is running the container (and, in our example, is the same device that generated the certificate) and the other one that you wish to test the MQTT connection from (let's say, anLTAPor any other RouterOS device with IoT package installed) → you will need to import the certifi...
1
NAME TYPE SIZE CREATION-TIME
0 mqttserver.p12 .p12 file 2438 jan/30/2023 13:28:11 1 flash disk jul/06/2021 14:51:53 2 flash/pub directory jul/06/2021 14:51:53 3 flash/skins directory jan/01/1970 02:00:07 [admin@LTAP] > ``` Import the certificate: ``` [admin@LTAP] > /certificate/import file-name=...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Controller Bridge and Port Extender
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/37224456/Controller+Bridge+and+Port+Extender
17
Summary
Controller Bridge (CB) and Port Extender (PE) is an IEEE 802.1BR standard implementation in RouterOS for CRS3xx series switches. It allows virtually extending the CB ports with a PE device and manage these extended interfaces from a single controlling device. Such configuration provides a simplified network topology, f...
1
Limitations
Although controller allows to configure port extender interfaces, some bridging and switching features cannot be used or will not work properly. Below are the most common controller and extender limitations. The list might changealong upcoming RouterOS releases. Feature | Support ----------------- Bonding for cascade a...
1
Quick setup
In this example, we will create a Controlling Bridge (e.g. a CRS317-1G-16S+ switch) that will connect to a single Port Extender (e.g. a CRS326-24G-2S+ switch) through an SFP+1 interface. First, configure a bridge with enabled VLAN filtering on a CB device: ``` /interface bridge add name=bridge1 vlan-filtering=yes ``` O...
1
Discovery and control protocols
Before frame forwarding on extended ports is possible, Controlling Bridge and Port Extender must discover each other and exchange with essential information. CB and PE enabled devices are using a neighbor discovery protocol LLDP with specific Port Extension TLV. This allows CB and PE devices to advertise their support ...
1
Packet flow
To better understand the underlying principles of Controlling Bridge and Port Extender, a packet walkthrough is provided below:
1
Controller Bridge settings and monitoring
This section describes the Controller Bridge settings and monitoring options. Sub-menu:/interface bridge port-controller ``` /interface bridge port-controller ``` Property | Description ---------------------- bridge(name;Default:none) | The bridge interface where ports will be extended. The CB will only enable whenbrid...
1
NAME DEVICE
0 I pe1-ether1 pe1 1 R pe1-ether2 pe1 2 R pe1-ether3 pe1 3 R pe1-ether4 pe1 4 U pe1-sfpplus1 pe1 5 RC pe1-sfpplus2 pe1 6 I pe2-ether1 ...
1
NAME DEVICE
0 pe1-ether1 pe1 1 pe1-ether2 pe1 2 pe1-ether3 pe1 3 pe1-ether4 pe1 4 pe1-ether5 pe1 5 pe1-ether6 pe1 6 pe1-ether7 pe...
1
Port Extender settings
This section describes the Port Extender settings. Sub-menu:/interface bridge port-extender ``` /interface bridge port-extender ``` Property | Description ---------------------- control-ports(interfaces;Default:none) | Interfaces that will either connect to the CB (upstream port) or connect other PE devices in series (...
1
Configuration examples
Below are described the most common configuration examples. For CB and PE configuration to work properly, a bridge VLAN filtering needs to be enabled, so make sure to understand the filtering principles first -bridge VLAN filtering,bridge VLAN table.
1
Basic CB and PE configuration
In this example, a CRS317-1G-16S+ device is used as a Controller Bridge and CRS328-24P-4S+ as a Port Extender, see the connection scheme below. First, configure the CB device. This can be done by adding a bridge interface with enabled VLAN filtering. Additionally, add any local interfaces to the same bridge, it allows ...
1
NAME                                TYPE       ACTUAL-MTU L2MTU  MAX-L2MTU
0  RS pe1-ether1                          extport          1500  1584 1  RS pe1-ether2                          extport          1500  1584 2  RS pe1-ether3                          extport          1500  1584 3   S pe1-ether4                          extport          1500  1584 4   S pe1-ether5                        ...
1
INTERFACE              BRIDGE             HW  PVID PRIORITY  PATH-COST INTERNAL-PATH-COST    HORIZON
0   H sfp-sfpplus2           bridge1            yes    1     0x80         10                 10       none 1   H pe1-ether1             bridge1            yes    1     0x80         10                 10       none 2   H pe1-ether2             bridge1            yes    1     0x80         10                 10       none...
1
Trunk and Access ports
In this example, untagged (access) and tagged (trunk) port configuration will be created on the Controller Bridge device, see the network diagram below. First, configure the CB and PE devices, the configuration is identical to the previous example. Use this configuration for CB device. ``` /interface bridge add name=br...
1
Cascading multiple Port Extenders and using bonding interface
In this example, two PE devices (CRS328-24P-4S+ and CRS326-24G-2S+) will be added to the CB (CRS317-1G-16S+). To increase throughput for upstream and cascade ports,bonding interfaceswill be created. See the network diagram below. The CB and PE configuration is similar to the first example, the main difference is the bo...
1
NAME                                                  DEVICE
0 R  pe1-ether2                                            pe1 1 R  pe1-ether3                                            pe1 2 R  pe1-ether4                                            pe1 3  U pe1-sfpplus1                                          pe1 4  U pe1-sfpplus2                                          pe1 5 RC ...
1
Configuration modification and removal
In certain situations, CB and PE device configuration needs to be adjusted (e.g. PE device needs new control ports) or removed completely. To modify the PE device configuration, all related PE device configuration should be removed from the CB device first. Only then the new configuration can be applied. First, to remo...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CRS1xx/2xx series switches examples
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/103841836/CRS1xx+2xx+series+switches+examples
32
Summary
Basic use cases and configuration examples for Cloud Router Switch features.
1
Port switching
To set up port switching on CRS1xx/2xx series switches, check theBridge Hardware Offloadingpage.
1
Management access configuration
In general, switches are only supposed to forward packets by using the built-in switch chip, but not allow access to the device itself for security reasons. It is possible to use the device's serial port for management access, but in most cases, such an access method is not desired and access using an IP address is mor...
1
Untagged
If invalid VLAN filtering is not enabled, management access to the device using tagged or untagged (VLAN 0) traffic is already allowed from any port, though this is not a good practice, this can cause security issues and can cause the device's CPU to be overloaded in certain situations (most commonly with a broadcast t...
1
Tagged
Allowing only tagged traffic to have management access to the device through a specific port is a much better practice. For example, to allow onlyVLAN99to access the device throughether2you should first add an entry to the VLAN table, which will allow the selected port and the CPU port (switch1-cpu) to forward the sele...
1
VLAN
1
Port Based VLAN
1
Example 1 (Trunk and Access ports)
Switch together the required ports: ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether6 hw=yes add bridge=bridge1 interface=ether7 hw=yes add bridge=bridge1 interface=ether8 hw=yes ``` Specify the VLAN ID that the switch must set o...
1
Example 2 (Trunk and Hybrid Ports)
Switch together the required ports: ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether6 hw=yes add bridge=bridge1 interface=ether7 hw=yes add bridge=bridge1 interface=ether8 hw=yes ``` Specify the VLAN ID that the switch must set o...
1
Protocol Based VLAN
Switch together the required ports: ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether6 hw=yes add bridge=bridge1 interface=ether7 hw=yes add bridge=bridge1 interface=ether8 hw=yes ``` Set VLAN for IP and ARP protocols: ``` /interf...
1
MAC Based VLAN
Switch together the required ports: ``` /interface bridge add name=bridge1 /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether7 hw=yes ``` Enable MAC-based VLAN translation on access port: ``` /interface ethernet switch port set ether7 allow-fdb-based-vlan-translate=yes ...
1
InterVLAN Routing
InterVLAN routing configuration consists of two main parts – VLAN tagging in switch-chip and routing in RouterOS. This configuration can be used in many applications by combining it with a DHCP server, Hotspot, PPP, and other features for each VLAN. Switch together the required ports: ``` /interface bridge add name=bri...
1
Unknown/Invalid VLAN filtering
VLAN membership is defined in the VLAN table. Adding entries with VLAN ID and ports makes that VLAN traffic valid on those ports. After a valid VLAN configuration has been set up, unknown/invalid VLAN filtering can be enabled. This VLAN filtering configuration example applies totheInterVLAN Routingsetup. ``` /interface...
1
VLAN Tunneling (Q-in-Q)
This example covers a typical VLAN tunneling use case where service provider devices add another VLAN tag for independent forwarding in the meantime allowing customers to use their own VLANs. CRS-1: The first switch on the edge of the service provider network has to properly identify traffic from the customer VLAN ID o...
1
CVID Stacking
It is possible to use CRS1xx/CRS2xx series switches for CVID Stacking setups. CRS1xx/CRS2xx series switches are capable of VLAN filtering based on the outer tag of tagged packets that have two CVID tags (double CVID tag), these switches are also capable of adding another CVID tag on top of an existing CVID tag (CVID St...
1
Mirroring
The Cloud Router Switches support three types of mirroring. Port-based mirroring can be applied to any switch-chip ports, VLAN-based mirroring works for all specified VLANs regardless of switch-chip ports, and MAC-based mirroring copies traffic sent or received from specific device reachable from the port configured in...
1
Port-Based Mirroring
The first configuration sets the ether5 port as a mirror0 analyzer port for both ingress and egress mirroring, mirrored traffic will be sent to this port. Port-based ingress and egress mirroring are enabled from the ether6 port. ``` /interface ethernet switch set ingress-mirror0=ether5 egress-mirror0=ether5 /interface ...
1
VLAN Based Mirroring
The second example requires ports to be switched in a group. Mirroring configuration sets the ether5 port as a mirror0 analyzer port and sets the mirror0 port to be used when mirroring from VLAN occurs. VLAN table entry enables mirroring only for VLAN 300 traffic between ether2 and ether7 ports. ``` /interface bridge a...
1
MAC Based Mirroring
The third configuration also requires ports to be switched in a group. Mirroring configuration sets the ether5 port as a mirror0 analyzer port and sets the mirror0 port to be used when mirroring from the Unicast Forwarding database occurs. The entry from the Unicast Forwarding database enables mirroring for packets wit...
1
Trunking
The Trunking in the Cloud Router Switches provides static link aggregation groups with hardware automatic failover and load balancing. IEEE802.3ad and IEEE802.1ax compatible Link Aggregation Control Protocol is not supported yet. Up to 8 Trunk groups are supported with up to 8 Trunk member ports per Trunk group. Config...
1
Limited MAC Access per Port
Disabling MAC learning and configuring static MAC addresses gives the ability to control what exact devices can communicate to CRS1xx/2xx switches and through them. Configuration requires a group of switched ports, disabled MAC learning on those ports, and static UFDB entries: ``` /interface bridge add name=bridge1 /in...
1
Isolation
1
Port Level Isolation
Port-level isolation is often used for Private VLAN, where: The Cloud Router Switches use port-level isolation profiles for Private VLAN implementation: This example requires a group of switched ports. Assume that all ports used in this example are in one switch group. ``` /interface bridge add name=bridge1 /interface ...
1
Protocol Level Isolation
Protocol level isolation on CRS switches can be used to enhance network security. For example, restricting DHCP traffic between the users and allowing it only to trusted DHCP server ports can prevent security risks like DHCP spoofing attacks. The following example shows how to configure it on CRS. Switch together the r...
1
Quality of Service (QoS)
QoS configuration schemes MAC based traffic scheduling and shaping: [MAC address in UFDB] -> [QoS Group] -> [Priority] -> [Queue] -> [Shaper] VLAN based traffic scheduling and shaping: [VLAN id in VLAN table] -> [QoS Group] -> [Priority] -> [Queue] -> [Shaper] Protocol based traffic scheduling and shaping: [Protocol in...
1
MAC-based traffic scheduling using internal Priority
In Strict Priority scheduling mode, the highest priority queue is served first. The queue number represents the priority and the queue with the highest queue number has the highest priority. Traffic is transmitted from the highest priority queue until the queue is empty, and then moves to the next highest priority queu...
1
MAC-based traffic shaping using internal Priority
The scheme where MAC-based traffic shaping is done according to internal Priority would be following: [MAC address] -> [QoS Group] -> [Priority] -> [Queue] -> [Shaper];In this example, unlimited traffic will have priority 0 and limited traffic will have priority 1 with a bandwidth limit of 10Mbit. Note that CRS has a m...
1
VLAN-based traffic scheduling + shaping using internal Priorities
The best practice is to assign lower internal QoS Priority for traffic limited by shaper to make it also less important in the Strict Priority scheduler. (higher priority should be more important and unlimited) In this example:Switch port ether6 is using a shaper to limit the traffic that comes from ether7 and ether8.W...
1
PCP-based traffic scheduling
By default, CRS1xx/CRS2xx series devices will ignore the PCP/CoS/802.1p value and forward packets based on FIFO (First-In-First-Out) manner. When the device's internal queue is not full, then packets are sent in a FIFO manner, but as soon as a queue is filled, then higher-priority traffic can be sent out first. Let us ...
1
Bandwidth Limiting
Both Ingress Port policer and Shaper provide bandwidth-limiting features for CRS switches. ``` /interface ethernet switch ingress-port-policer add port=ether5 meter-unit=bit rate=10M ``` ``` /interface ethernet switch shaper add port=ether5 meter-unit=bit rate=10M ```
1
Traffic Storm Control
The same Ingress Port policer also can be used for traffic storm control to prevent disruptions on Layer 2 ports caused by broadcast, multicast, or unicast traffic storms. ``` /interface ethernet switch ingress-port-policer add port=ether5 rate=500 meter-unit=packet packet-types=broadcast ``` ``` /interface ethernet sw...
1
See also
* Layer2 misconfiguration
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CRS1xx and 2xx series switches
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/103841835/CRS1xx+and+2xx+series+switches
30
Summary
The Cloud Router Switch series are highly integrated switches with high-performance MIPS CPU and feature-rich packet processors. The CRS switches can be designed into various Ethernet applications including unmanaged switch, Layer 2 managed switch, carrier switch, and wireless/wired unified packet processing. SeeCloud ...
1
Cloud Router Switch models
This table clarifies the main differences between Cloud Router Switch models. Model | Switch Chip | CPU | Wireless | SFP+ port | Access Control List | Jumbo Frame (Bytes) CRS105-5S-FB | QCA-8511 | 400MHz | - | - | + | 9204 CRS106-1C-5S | QCA-8511 | 400MHz | - | - | + | 9204 CRS112-8G-4S | QCA-8511 | 400MHz | - | - | + ...
1
Abbreviations and Explanations
CVID - Customer VLAN id: inner VLAN tag id of the IEEE 802.1ad frame SVID - Service VLAN id: outer VLAN tag id of the IEEE 802.1ad frame IVL - Independent VLAN learning - learning/lookup is based on both MAC addresses and VLAN IDs. SVL - Shared VLAN learning - learning/lookup is based on MAC addresses - not on VLAN IDs...
1
Port Switching
To set up port switching on CRS1xx/2xx series switches, check theBridge Hardware Offloadingpage.
1
Multiple switch groups
The CRS1xx/2xx series switches allow you to use multiple bridges with hardware offloading, this allows you to easily isolate multiple switch groups. This can be done by simply creating multiple bridges and enabling hardware offloading.
1
Global Settings
The CRS switch chip is configurable from the/interface ethernet switchconsole menu. ``` /interface ethernet switch ``` Sub-menu:/interface ethernet switch ``` /interface ethernet switch ``` Property | Description ---------------------- name(string value; Default:switch1) | Name of the switch. bridge-type(customer-vid-u...
1
Port Settings
Sub-menu:/interface ethernet switch port ``` /interface ethernet switch port ``` Property | Description ---------------------- vlan-type(edge-port | network-port; Default:network-port) | Port VLAN type specifies whether VLAN ID is used in UFDB learning. The network port learns VLAN ID in UFDB, edge port does not - VLAN...
1
Forwarding Databases
1
Unicast FDB
The unicast forwarding database supports up to 16318 MAC entries. Sub-menu:/interface ethernet switch unicast-fdb ``` /interface ethernet switch unicast-fdb ``` Property | Description ---------------------- action(action; Default:forward) | Action for UFDB entry:dst-drop- Packets are dropped when their destination MAC ...
1
Multicast FDB
CRS125 switch-chip supports up to 1024 entries in MFDB for multicast forwarding. For each multicast packet, destination MAC or destination IP lookup is performed in MFDB. MFDB entries are not automatically learned and can only be configured. Sub-menu:/interface ethernet switch multicast-fdb ``` /interface ethernet swit...
1
Reserved FDB
Cloud Router Switch supports 256 RFDB entries. Each RFDB entry can store either Layer2 unicast or multicast MAC address with specific commands. Sub-menu:/interface ethernet switch reserved-fdb ``` /interface ethernet switch reserved-fdb ``` Property | Description ---------------------- action(copy-to-cpu | drop | forwa...
1
VLAN
1
VLAN Table
The VLAN table supports 4096 VLAN entries for storing VLAN member information as well as other VLAN information such as QoS, isolation, forced VLAN, learning, and mirroring. Sub-menu:/interface ethernet switch vlan ``` /interface ethernet switch vlan ``` Property | Description ---------------------- disabled(yes | no; ...
1
Egress VLAN Tag
Egress packets can be assigned different VLAN tag formats. The VLAN tags can be removed, added, or remained as is when the packet is sent to the egress port (destination port). Each port has dedicated control of the egress VLAN tag format. The tag formats include: The Egress VLAN Tag table includes 4096 entries for VLA...
1
Ingress/Egress VLAN Translation
The Ingress VLAN Translation table allows for up to 15 entries for each port. One or multiple fields can be selected from the packet header for lookup in the Ingress VLAN Translation table. The S-VLAN or C-VLAN or both configured in the first matched entry are assigned to the packet. Sub-menu:/interface ethernet switch...
1
Protocol Based VLAN
Protocol Based VLAN table is used to assign VID and QoS attributes to related protocol packets per port. Sub-menu:/interface ethernet switch protocol-based-vlan ``` /interface ethernet switch protocol-based-vlan ``` Property | Description ---------------------- disabled(yes | no; Default:no) | Enables or disables Proto...
1
MAC Based VLAN
MAC Based VLAN table is used to assign VLAN based on the source MAC. Sub-menu:/interface ethernet switch mac-based-vlan ``` /interface ethernet switch mac-based-vlan ``` Property | Description ---------------------- disabled(yes | no; Default:no) | Enables or disables MAC Based VLAN entry. new-customer-vid(0..4095; Def...
1
1:1 VLAN Switching
1:1 VLAN switching can be used to replace the regular L2 bridging for matched packets. When a packet hits a 1:1 VLAN switching table entry, the destination port information in the entry is assigned to the packet. The matched destination information in the UFDB and MFDB entry no longer applies to the packet. Sub-menu:/i...
1
Port Isolation/Leakage
The CRS switches support flexible multi-level isolation features, which can be used for user access control, traffic engineering and advanced security and network management. The isolation features provide an organized fabric structure allowing user to easily program and control the access by port, MAC address, VLAN, p...
1
Trunking
The Trunking in the Cloud Router Switches provides static link aggregation groups with hardware automatic failover and load balancing. IEEE802.3ad and IEEE802.1ax compatible Link Aggregation Control Protocol is not supported. Up to 8 Trunk groups are supported with up to 8 Trunk member ports per Trunk group. CRS Port T...
1
Quality of Service
1
Shaper
Traffic shaping restricts the rate and burst size of the flow which is transmitted out from the interface. The shaper is implemented by a token bucket. If the packet exceeds the maximum rate or the burst size, which means not enough token for the packet, the packet is stored to buffer until there is enough token to tra...
1
Ingress Port Policer
Sub-menu:/interface ethernet switch ingress-port-policer ``` /interface ethernet switch ingress-port-policer ``` Property | Description ---------------------- burst(integer; Default:100k) | Maximum data rate which can be transmitted while the burst is allowed. disabled(yes | no; Default:no) | Enables or disables ingres...
1
QoS Group
The global QoS group table is used for VLAN-based, Protocol-based, and MAC-based QoS group assignment configuration. Sub-menu:/interface ethernet switch qos-group ``` /interface ethernet switch qos-group ``` Property | Description ---------------------- dei(0..1; Default:none) | The new value of DEI for the QoS group. ...
1
DSCP QoS Map
The global DSCP to QOS mapping table is used for mapping from the DSCP of the packet to new QoS attributes configured in the table. Sub-menu:/interface ethernet switch dscp-qos-map ``` /interface ethernet switch dscp-qos-map ``` Property | Description ---------------------- dei(0..1) | The new value of DEI for the DSCP...
1
DSCP To DSCP Map
The global DSCP to DSCP mapping table is used for mapping from the packet's original DSCP to the new DSCP value configured in the table. Sub-menu:/interface ethernet switch dscp-to-dscp ``` /interface ethernet switch dscp-to-dscp ``` Property | Description ---------------------- new-dscp(0..63) | The new value of DSCP ...
1
Policer QoS Map
Sub-menu:/interface ethernet switch policer-qos-map ``` /interface ethernet switch policer-qos-map ``` Property | Description ---------------------- dei-for-red(0..1; Default:0) | Policer DEI remapping value for red packets. dei-for-yellow(0..1; Default:0) | Policer DEI remapping value for yellow packets. dscp-for-red(...
1
Access Control List
Access Control List contains of ingress policy and egress policy engines and allows configuration of up to 128 policy rules (limited by RouterOS). It is an advanced tool for wire-speed packet filtering, forwarding, shaping, and modifying based on Layer2, Layer3, and Layer4 protocol header field conditions. Sub-menu:/in...
1
ACL Policer
Sub-menu:/interface ethernet switch acl policer ``` /interface ethernet switch acl policer ``` Property | Description ---------------------- name(string; Default:policerX) | Name of the Policer used in ACL. yellow-rate(integer) | Maximum data rate limit for packets with yellow drop precedence. yellow-burst(integer; Def...
1
See also
* Layer2 misconfiguration
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CRS3xx, CRS5xx, CCR2116, CCR2216 switch chip features
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/30474317/CRS3xx+CRS5xx+CCR2116+CCR2216+switch+chip+features
39
Summary
The CCR3xx, CRS5xx series switches and CCR2116, CCR2216 routers have highly integrated switches with high-performance CPU and feature-rich packet processors. These devices can be designed into various Ethernet applications including unmanaged switch, Layer 2 managed switch, carrier switch, inter-VLAN router, and wired ...
1
Features
Features | Description ---------------------- Forwarding | Configurable ports for switching or routingFull non-blocking wire-speed switchingLarge Unicast FDB for Layer 2 unicast forwardingForwarding Databases works based on IVLJumbo frame supportIGMP Snooping supportDHCP Snooping with Option 82 Routing | Layer 3 Hardwa...
1
Models
This table clarifies the main differences between Cloud Router Switch models and CCR routers. Model | Switch Chip | CPU | Cores | 10G SFP+ | 10G Ethernet | 25G SFP28 | 40G QSFP+ | 100G QSFP28 | ACL rules | Unicast FDB entries | Jumbo Frame (Bytes) netPower 15FR (CRS318-1Fi-15Fr-2S) | Marvell-98DX224S | 800MHz | 1 | - |...
1
Abbreviations
1
Port switching
In order to set up a port switching, check theBridge Hardware Offloadingpage.
1
VLAN
Since RouterOS version 6.41, a bridge provides VLAN aware Layer2 forwarding and VLAN tag modifications within the bridge. This set of features makes bridge operation more like a traditional Ethernet switch and allows to overcome Spanning Tree compatibility issues compared to the configuration when tunnel-like VLAN inte...
1
VLAN Filtering
VLAN filtering is described on theBridge VLAN Filteringsection. VLAN setup examples Below are describes some of the most common ways how to utilize VLAN forwarding.
1
Port-Based VLAN
The configuration is described on theBridge VLAN FIlteringsection.
1
MAC Based VLAN
Enable switching on ports by creating a bridge with enabled hw-offloading: ``` /interface bridge add name=bridge1 vlan-filtering=yes /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether7 hw=yes ``` Add VLANs in the Bridge VLAN table and specify ports: ``` /interface bridg...
1
Protocol Based VLAN
Enable switching on ports by creating a bridge with enabled hw-offloading: ``` /interface bridge add name=bridge1 vlan-filtering=yes /interface bridge port add bridge=bridge1 interface=ether2 hw=yes add bridge=bridge1 interface=ether6 hw=yes add bridge=bridge1 interface=ether7 hw=yes add bridge=bridge1 interface=ether8...
1
VLAN Tunneling (Q-in-Q)
Since RouterOS v6.43 it is possible to use a provider bridge (IEEE 802.1ad) and Tag Stacking VLAN filtering, and hardware offloading at the same time. The configuration is described in theBridge VLAN Tunneling (Q-in-Q)section.
1
Ingress VLAN translation
It is possible to translate a certain VLAN ID to a different VLAN ID using ACL rules on an ingress port. In this example we create two ACL rules, allowing bidirectional communication. This can be done by doing the following. Create a new bridge and add ports to it with hardware offloading: ``` /interface bridge add nam...
1
(R/M)STP
CRS3xx, CRS5xx series switches, and CCR2116, CCR2216 routers are capable of running STP, RSTP, and MSTP on a hardware level. For more detailed information you should check out theSpanning Tree Protocolmanual page.
1
Bonding
CRS3xx, CRS5xx series switches and CCR2116, CCR2216 routers support hardware offloading with bonding interfaces. Only802.3adandbalance-xorbonding modes are hardware offloaded, other bonding modes will use the CPU's resources. You can find more information about the bonding interfaces in theBonding Interfacesection. If8...
1
INTERFACE BRIDGE HW
0 H bond1 bridge yes 1 H ether3 bridge yes 2 H ether4 bridge yes ```
1
Multi-chassis Link Aggregation Group
MLAG (Multi-chassis Link Aggregation Group) implementation in RouterOS allows configuring LACP bonds on two separate devices, while the client device believes to be connected on the same machine. This provides a physical redundancy in case of switch failure. All CRS3xx, CRS5xx series and CCR2116, CCR2216 devices can be...
1
L3 Hardware Offloading
Layer3 hardware offloading (otherwise known as IP switching or HW routing) will allow to offload some of the router features onto the switch chip. This allows reaching wire speeds when routing packets, which simply would not be possible with the CPU. Offloaded feature set depends on the used chipset. Readherefor more i...
1
Port isolation
Since RouterOS v6.43 is it possible to create a Private VLAN setup, an example can be found in theSwitch chip port isolationmanual page. Hardware offloaded bonding interfaces are not included in the switch port-isolation menu, but it is still possible to configure port-isolation individually oneach secondary interface ...
1
IGMP/MLD Snooping
CRS3xx, CRS5xx series switches and CCR2116, CCR2216 routers are capable of using IGMP/MLD Snooping on a hardware level. To see more detailed information, you should check out theIGMP/MLD snoopingmanual page.
1
DHCP Snooping and DHCP Option 82
CRS3xx, CRS5xx series switches and CCR2116, CCR2216 routers are capable of using DHCP Snooping with Option 82 on a hardware level. The switch will create a dynamic ACL rule to capture the DHCP packets and redirect them to the main CPU for further processing. To see more detailed information, please visit theDHCP Snoopi...
1
Controller Bridge and Port Extender
Controller Bridge (CB) and Port Extender (PE) is an IEEE 802.1BR standard implementation in RouterOS. It allows virtually extending the CB ports with a PE device and managing these extended interfaces from a single controlling device. Such configuration provides a simplified network topology, flexibility, increased por...
1
Mirroring
Mirroring is a function that allows a network switch to duplicate all the data passing through it and send a copy to another specified port, known as themirror-target. This feature is useful for setting up a tap device, which allows for analyzing network traffic using a separate device. You can set up mirroring in a si...
1
Configuration examples
1
Port Based Mirroring
Starting from RouterOS version 7.15, it is possible to configure multiple source ports and selectively choose whether to mirror incoming traffic, outgoing traffic, or both. In this example, both incoming and outgoing traffic from theether2interface will be copied and sent to theether3interface for monitoring or analysi...
1
Since RouterOS v7.15
/interface ethernet switch port set ether2 mirror-egress=yes mirror-ingress=yes /interface ethernet switch set switch1 mirror-target=ether3
1
Older RouterOS:
/interface ethernet switch set switch1 mirror-source=ether2 mirror-target=ether3 ```
1
VLAN Based Mirroring
Using ACL rules, it is possible to mirror packets from multiple interfaces using theportssetting. Additionally, you can specify more detailed criteria such as VLAN ID, MAC/IP address or TCP/UDP port. Onlyingresspackets are mirrored tomirror-targetinterface. This example will mirror incoming VLAN 11 traffic from theethe...
1
MAC Based Mirroring
This example will mirror incoming traffic with 64:D1:54:D9:27:E6 MAC destination or source address from theether1interface, and send copies to theether3interface. ``` /interface ethernet switch set switch1 mirror-target=ether3 /interface ethernet switch rule add mirror=yes ports=ether1 switch=switch1 dst-mac-address=64...
1
IP Based Mirroring
This example will mirror incoming traffic with 192.168.88.0/24 IP destination or source address from theether1interface, and send copies to theether3interface. ``` /interface ethernet switch set switch1 mirror-target=ether3 mirror-source=none /interface ethernet switch rule add mirror=yes ports=ether1 switch=switch1 sr...
1
Remote Switch Port Analyzer
This example will mirror incomming and outgoing traffic from theether2interface, copies will be encapsulated in 802.1Q VLAN using the 999 as VLAN ID, and packets will be sent to theether3interface. If the original traffic is already VLAN tagged, RSPAN will add another layer of VLAN tagging as an outer tag. This results...
1
Property Reference
Sub-menu:/interface/ethernet/switch ``` /interface/ethernet/switch ``` Property | Description ---------------------- mirror-target(cpu | name | none; Default:none) | Selects a single mirroring target port. Packets frommirror-egressandmirror-ingress(/interface/ethernet/switch/port) andmirror(/interface/ethernet/switch/r...
1
Traffic Shaping
It is possible to limit ingress traffic that matches certain parameters with ACL rules and it is possible to limit ingress/egress traffic per port basis. The policer is used for ingress traffic, the shaper is used for egress traffic. The ingress policer controls the received traffic with packet drops. Everything that e...
1
Traffic Storm Control
Since RouterOS v6.42 it is possible to enable traffic storm control. A traffic storm can emerge when certain frames are continuously flooded on the network.Storm control settings is generally configured on non-uplink ports to restrict incoming storm traffic on those specific ports. This helps safeguard the entire switc...
1
MPLS hardware offloading
Since RouterOS v6.41 it is possible to offload certain MPLS functions to the switch chip, the switch must be a (P)rovider router in a PE-P-PE setup in order to achieve hardware offloading. A setup example can be found in theBasic MPLS setup examplemanual page. The hardware offloading will only take place when LDP inter...
1
Switch Rules (ACL)
Access Control List contains ingress policy and egress policy engines. Seethis tableon how many rules each device supports. It is an advanced tool for wire-speed packet filtering, forwarding and modifying based on Layer2, Layer3 and Layer4 protocol header field conditions. Sub-menu:/interface ethernet switch rule ``` /...
1
Port Security
It is possible to limit allowed MAC addresses on a single switch port. For example, to allow64:D1:54:81:EF:8E MAC address on a switch port,start by switching multiple ports together, in this example64:D1:54:81:EF:8E is going to be located behindether1. Create an ACL rule to allow the given MAC address and drop all othe...
1
Dual Boot
The “dual boot” feature allows you to choose which operating system you prefer to use on CRS3xx series switches, RouterOS or SwOS. Device operating system could be changed using: ``` /system routerboard settings set boot-os=swos ``` More details about SwOS are described here:SwOS manual
1
Configuring SwOS using RouterOS
Since RouterOS 6.43 it is possible to load, save and reset SwOS configuration, as well as upgrade SwOS and set an IP address for the CRS3xx series switches by using RouterOS. ``` /system swos save-config ``` ``` /system swos load-config ``` ``` /system swos password ``` ``` /system swos reset-config ``` ``` /system swo...
1
See also
CRS Router CRS3xx VLANs with Bonds Basic VLAN switching Bridge Hardware Offloading Route Hardware Offloading Spanning Tree Protocol MTU on RouterBOARD Layer2 misconfiguration Bridge VLAN Table Bridge IGMP/MLD snooping Multi-chassis Link Aggregation Group
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
CRS3xx, CRS5xx, CCR2116, CCR2216 VLANs with Bonds
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/139526180/CRS3xx+CRS5xx+CCR2116+CCR2216+VLANs+with+Bonds
9
Summary
This page will show how to configure multiple switches to use bonding interfaces and port-based VLANs, it will also show a working example with a DHCP-Server, inter-VLAN routing, management IP, and invalid VLAN filtering configuration. For this network topology, we will be using two CRS326-24G-2S+, one CRS317-1G-16S+, ...
1
Bonding
Bonding interfaces are used when a larger amount of bandwidth is required, this is done by creating a link aggregation group, which also provides hardware automatic failover and load balancing for switches. By adding two 10Gbps interfaces to bonding, you can increase the theoretical bandwidth limit to 20Gbps. Make sure...
1
Port switching
All switches in this setup require that all used ports are switched together. For bonding, you should add the bonding interface as a bridge port, instead of individual bonding ports. Use these commands onSwitchAandSwitchC: ``` /interface bridge add name=bridge vlan-filtering=no /interface bridge port add bridge=bridge ...
1
Management IP
It is very useful to create a management interface and assign an IP address to it to preserve access to the switch. This is also very useful when updating your switches since such traffic to the switch will be blocked when enabling invalid VLAN filtering. Create a routable VLAN interface onSwitchA,SwitchB,andSwitchC: `...
1
Invalid VLAN filtering
Since most ports on SwitchA and SwitchC are going to be access ports, you can set all ports to accept only certain types of packets, in this case, we will want SwitchA and SwitchC to only accept untagged packets, use these commands onSwitchAandSwitchC: ``` /interface bridge port set [ find ] frame-types=admit-only-unta...
1
InterVLAN routing
To create InterVLAN routing, the VLAN interface for each customer VLAN ID must be created on the router and must have an IP address assigned to it. The VLAN interface must be created on the bonding interface created previously. Use these commands on theRouter: ``` /interface vlan add interface=bond_1-2-3-4 name=VLAN10 ...
1
DHCP-Server
To get the DHCP-Server working for each VLAN ID, the server must be set up on the previously created VLAN interfaces (one server for each VLAN ID). Preferably each VLAN ID should have its own subnet and its own IP pool. A DNS Server could be specified as the router's IP address for a particular VLAN ID or a global DNS ...
1
Jumbo frames
One can increase the total throughput in such a setup by enabling jumbo frames. This reduces the packet overhead by increasing the Maximum Transmission Unit (MTU). If a device in your network does not support jumbo frames, then it will not benefit from a larger MTU. Usually, the whole network does not support jumbo fra...
1
NAME TYPE ACTUAL-MTU L2MTU MAX-L2MTU MAC-ADDRESS
1 R sfp-sfpplus1 ether 1500 1584 10218 64:D1:54:FF:E3:7F ``` When MAX-L2MTU is determined, choose the MTU size depending on the traffic on your network, use this command onSwitchA,SwitchB,andSwitchC: ``` /interface ethernet set [ find ] l2mtu=10218 mtu=10218 ```
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
DDoS Protection
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/28606504/DDoS+Protection
7
Introduction
A denial-of-service (DoS) or distributed denial-of-service (DDoS) attack is a malicious attempt to disrupt normal traffic of a targeted server, service, or network by overwhelming the target or its surrounding infrastructure with a flood of Internet traffic. There are several types of DDoS attacks, for example, HTTP fl...
1
Protection against DDoS
1
Configuration lines
``` /ip firewall address-list add list=ddos-attackers add list=ddos-targets /ip firewall filter add action=return chain=detect-ddos dst-limit=32,32,src-and-dst-addresses/10s add action=add-dst-to-address-list address-list=ddos-targets address-list-timeout=10m chain=detect-ddos add action=add-src-to-address-list address...
1
Configuration Explained
First, we will send every new connection to the specific firewall chain where we will detect DDoS: ``` /ip/firewall/filter/add chain=forward connection-state=new action=jump jump-target=detect-ddos ``` In the newly created chain, we will add the following rule with the "dst-limit" parameter. This parameter is written i...
1
SYN Attack
1
SYN Flood
An SYN flood is a form of DoS attack in which an attacker sends a succession of SYN requests to a target's system in an attempt to consume enough server resources to make the system unresponsive to legitimate traffic. Fortunately, in RouterOS we have a specific feature for such an attack: ``` /ip/settings/set tcp-synco...
1
SYN-ACK Flood
An SYN-ACK flood is an attack method that involves sending a target server spoofed SYN-ACK packet at a high rate. The server requires significant resources to process such packets out-of-order (not in accordance with the normal SYN, SYN-ACK, ACK TCP three-way handshake mechanism), it can become so busy handling the att...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Default configurations
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/167706788/Default+configurations
8
CPE Router
In this type of configuration, the router is configured as a wireless client device. WAN interface is aWirelessinterface. WAN port has configured DHCP client, is protected by IP firewall and MAC discovery/connection is disabled. List of routers using this type of configuration:
1
LTE CPE AP router
This configuration type is applied to routers that have both LTE and wireless interfaces. LTE interface is considered a WAN port protected by a firewall and MAC discovery/connection disabled. The IP address on the WAN port is acquired automatically. Wireless is configured as an access point and bridged with all availab...
1
AP Router
This type of configuration is applied to home access point routers to be used straight out of the box without additional configuration (except router passwords and wireless keys) First Ethernet is always configured as a WAN port (protected by a firewall, enabled DHCP client, and disabled MAC connection/discovery). Othe...
1
PTP Bridge, W60G Bridge:
Bridged Ethernet with a wireless interface. The default IP address 192.168.88.1/24 is set on the bridge interface. There are two possible options - CPE and AP. For CPE wireless interface is set in "station-bridge" mode, and for AP "bridge" mode is used.W60G Bridge -This configuration type is applied to routers that hav...
1
WISP Bridge
The configuration is the same as PTP Bridge in AP mode, except that wireless mode is set to ap_bridge for PTMP setups. The router can be accessed directly using a MAC address. If the device is connected to the network with an enabled DHCP server, configured DHCP client configured on the bridge interface will get the IP...
1
Switch
This configuration utilizes switch chip features to configure a basic switch. All Ethernet ports are added to switch group and default IP address 192.168.88.1/24 is set on bridge interface. List of routers using this type of configuration:
1
IP Only
When no specific configuration is found, IP address 192.168.88.1/24 is set on ether1, or combo1, or sfp1. List of routers using this type of configuration:
1
CAP
This type of configuration is used when a device needs to be used as a wireless client device controlled byCAPsMAN. When CAP default configuration is loaded, ether1 is considered a management port with DHCP client configured. All other Ethernet interfaces are bridged and wlan1 is set to be managed by CAPsMAN. To load C...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Detect Internet
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/8323187/Detect+Internet
7
Introduction
Detect Internet is a tool that categorizes monitored interfaces into the following states -Internet,WAN,LAN,unknown, andno-link.
1
State
This submenu displays status of all monitored interfaces defined by thedetect-interface-listparameter: ``` interface/detect-internet/state/print ```
1
LAN
All layer 2 interfaces initially have this state.
1
WAN
Any L3 tunnel and LTE interfaces will initially have this state. Layer 2 interfaces can obtain this state if the following conditions are met:
1
Internet
WANinterfaces that can reach cloud.mikrotik.com using UDP protocol port 30000 can obtain this state. Reachability is checked every minute. If a cloud is not reached for 3 minutes, the state falls back toWAN.
1
Configuration
``` /interface detect-internet ``` Property | Description ---------------------- detect-interface-list(interface list; Default:none) | All interfaces in the list will be monitored by Detect Internet internet-interface-list(interface list; Default:none) | Interfaces with state Internet will be dynamically added to this ...
1
NAME STATE STATE-CHANGE-TIME CLO
0 ether1 internet dec/22/2020 13:46:18 5ms ```
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Device-mode
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/93749258/Device-mode
6
Available device-mode modes
There are three device modes available for configuration (mode=advanced is default one), each mode has a subset of features that are not allowed when it is used. Note thatthere is no mode, which has all features enabled. Certain features need to be enabled even if you have "advanced" mode enabled. See section "Feature ...
1
List of available properties
Property | Description ---------------------- scheduler, socks, fetch, pptp, l2tp, bandwidth-test, traffic-gen, sniffer, ipsec, romon, proxy, hotspot, smb, email, zerotier, container,install-any-version, partitions, routerboard(yes | no) | The list of available features, which can be controlled with thedevice-modeoptio...
1
NAME INTERFACE PROFILE IDLE-TIMEOUT
;;; inactivated, not allowed by device-mode 0 X hotspot1 ether1 default 5m ```
1
Feature clarification
Feature | Clarification of which menus become unavailable bandwidth-test | /tool bandwidth-test/tool bandwidth-server/tool speed-test routerboard | /system routerboard settings(except auto-upgrade option) container | all container functionality install-any-version | RouterOS will no longer allow for you to install Rout...
1
Allowed versions
Device mode lists in its parameters an argument called "allowed-versions". This is a list of versions which MikroTik considers as secure and which ones do not include any serious vulnerabilities which could be used by an attacker. This list can be updated to versions which includes some major changes in RouterOS below ...
1
Flagged status
Along with thedevice-mode feature, RouterOS now can analyze the whole configuration at system startup, to determine if there are any signs of unauthorized access to your router. If suspicious configuration is detected, the suspicious configuration will be disabled and theflaggedparameter will be set to "yes". The devic...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
DHCP
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/24805500/DHCP
77
DHCP Client
1
Summary
``` /ip dhcp-client ``` The DHCP (Dynamic Host Configuration Protocol) is used for the easy distribution of IP addresses in a network. The MikroTik RouterOS implementation includes both server and client parts and is compliant with RFC 2131. The MikroTik RouterOS DHCP client may be enabled on any Ethernet-like interfac...
1
DHCP Options
DHCP client has the possibility to set up options that are sent to the DHCP server. For example, hostname and MAC address. The syntax is the same as for DHCP server options. Currently, there are three variables that can be used in options: DHCP client default options include these default Options: Name | code | value -...
1
Properties
Property | Description ---------------------- add-default-route(yes | no | special-classless; Default:yes) | Whether to install default route in routing table received from DHCP server. By default, the RouterOS client complies with RFC and ignores option 3 if classless option 121 is received. To force the client not to...
1
Configuration Examples
1
Simple DHCP client
Add a DHCP client on the ether1 interface: ``` /ip dhcp-client add interface=ether1 disabled=no ``` After the interface is added, you can use the "print" or "print detail" command to see what parameters the DHCP client acquired: ``` [admin@MikroTik] ip dhcp-client> print detail Flags: X - disabled, I - invalid 0 inte...
1
Lease script example
It is possible to execute a script when a DHCP client obtains a new lease or loses an existing one. This is an example script that automatically adds a default route with routing-table=WAN1 and removes it when the lease expires or is removed. ``` /ip dhcp-client add add-default-route=no dhcp-options=hostname,clientid d...
1
Using received Option 43 to set the ACS URL
It is possible to setAutomatic Configuration Server (ACS)URL in the TR069 client settings, when a DHCP client lease is bound, if the option sent from the DHCP server is configured to send it. Here's an example: ``` :if ($bound=1) do={ /tr069-client/set acs-url=$"vendor-specific" } ```
1
Resolve defaultgateway when 'router' (option3) is from a different subnet
In some cases, administrators tend to set the 'router' option which cannot be resolved with offered IP's subnet. For example, the DHCP server offers 192.168.88.100/24 to the client, and option 3 is set to 172.16.1.1. This will result in an unresolved default route: ```
1
DST-ADDRESS PREF-SRC GATEWAY DISTANCE
0 DS 0.0.0.0/0 172.16.1.1 1 1 ADC 192.168.88.0/24 192.168.88.100 ether1 ``` To fix this we need to add /32 route to resolve the gateway over ether1, which can be done by the running script below each time the DHCP client gets an address ``` /system script add name="dhcpL" so...
1
DHCPv6 Client
1
Summary
Sub-menu:/ipv6 dhcp-client ``` /ipv6 dhcp-client ``` DHCP-client in RouterOS is capable of being a DHCPv6-client and DHCP-PD client. So it is able to get a prefix from the DHCP-PD server as well as the DHCPv6 stateful address from the DHCPv6 server.
1
Properties
Property | Description ---------------------- add-default-route(yes | no; Default:no) | Whether to add default IPv6 route after a client connects. comment(string; Default: ) | Short description of the client disabled(yes | no; Default:no) | interface(string; Default: ) | The interface on which the DHCPv6 client will be...
1
Script
It is possible to add a script that will be executed when a prefix or an address is acquired and applied or expires and is removed using the DHCP client. There are separated sets of variables that will have the value set by the client depending on prefix or address status change as the client can acquire both and each ...
1
IAID
To determine what IAID will be used, convert the internal ID of an interface on which the DHCP client is running from hex to decimal. For example, the DHCP client is running on interface PPPoE-out1. To get internal ID use the following command: ``` [admin@t36] /interface> :put [find name="pppoe-out1"] ``` Now convert h...
1
Configuration Examples
1
Simple DHCPv6 client
This simple example demonstrates how to enable dhcp client to receive IPv6 prefix and add it to the pool. ``` /ipv6 dhcp-client add request=prefix pool-name=test-ipv6 pool-prefix-length=64 interface=ether13 ``` Detailed print should show status of the client and we can verify if prefix is received ``` [admin@x86-test] ...
1
NAME PREFIX REQUEST PREFIX-LENGTH
0 D test-ipv6 2001:db8:7501:ff04::/62 prefix 64 ``` It works! Now you can use this pool, for example, for pppoe clients.
1
Use received prefix for local RA
Consider following setup: Configuration R1 ``` /ipv6 route add gateway=fe80::1:1%to-ISP /ipv6 pool add name=myPool prefix=2001:db8::/62 prefix-length=64 /ipv6 dhcp-server add prefix-pool=myPool disabled=no interface=to-CE-routers lease-time=3m name=server1 ``` CE1 ``` /ipv6 dhcp-client add interface=to-R1 request=prefi...
1
ADDRESS DUID IAID SERVER STATUS
1 D 2001:db8:1::/64 0019d1393536 566 server1 bound 2 D 2001:db8:2::/64 0019d1393535 565 server1 bound ``` On client: ``` [admin@CE1] /ipv6 dhcp-client> print Flags: D - dynamic, X - disabled, I - invalid
1
INTERFACE STATUS REQUEST PREFIX
0 to-R1 bound prefix 2001:db8:1::/64 [admin@CE1] /ipv6 dhcp-client> /ipv6 pool print Flags: D - dynamic
1
NAME PREFIX PREFIX-LENGTH
0 D my-ipv6 2001:db8:1::/64 64 ``` We can also see that IPv6 address was automatically added from the prefix pool: ``` [admin@CE1] /ipv6 address> print Flags: X - disabled, I - invalid, D - dynamic, G - global, L - link-local
1
ADDRESS FROM-POOL INTERFACE ADVERTISE 0 G 2001:db8:1::1/64 to-clients yes
.. ``` And pool usage shows that 'Address' is allocating the pool ``` [admin@CE1] /ipv6 pool used> print POOL PREFIX OWNER INFO my-ipv6 2001:db8:1::/64 Address to-clients ```
1
DHCP Server
1
Summary
The DHCP (Dynamic Host Configuration Protocol) is used for the easy distribution of IP addresses in a network. The MikroTik RouterOS implementation includes both server and client parts and is compliant with RFC 2131. The router supports an individual server for each Ethernet-like interface. The MikroTik RouterOS DHCP ...
1
DHCP Server Properties
Property | Description ---------------------- add-arp(yes | no; Default:no) | Whether to add dynamic ARP entry. If set tonoeitherARP modeshould be enabled on that interface or staticARPentries should be administratively defined in/ip arpsubmenu. address-pool(string | static-only; Default:static-only) | IP pool, from wh...
1
Leases
Sub-menu:/ip dhcp-server lease ``` /ip dhcp-server lease ``` DHCP server lease submenu is used to monitor and manage server leases. The issued leases are shown here as dynamic entries. You can also add static leases to issue a specific IP address to a particular client (identified by MAC address). Generally, the DHCP l...
1
Menu specific commands
check-status(id) | Check the status of a given busy (status is conflict or declined) dynamic lease, and free it in case of no response make-static(id) | Convert a dynamic lease to a static one
1
Store Configuration
Sub-menu:/ip dhcp-server config ``` /ip dhcp-server config ``` Store Leases On Disk:The configuration of how often the DHCP leases will be stored on disk. If they would be saved on a disk on every lease change, a lot of disk writes would happen which is very bad for Compact Flash (especially, if lease times are very sh...
1
Rate limiting
It is possible to set the bandwidth to a specific IPv4 address by using DHCPv4 leases. This can be done by setting a rate limit on the DHCPv4 lease itself, by doing this a dynamic simple queue rule will be added for the IPv4 address that corresponds to the DHCPv4 lease. By using therate-limitparameter you can convenien...
1
ADDRESS MAC-ADDRESS HOST-NAME SERVER RATE-LIMIT STATUS
0 D 192.168.88.254 6C:3B:6B:7C:41:3E MikroTik DHCPv4_Server bound [admin@MikroTik] > /ip dhcp-server lease make-static 0 [admin@MikroTik] > /ip dhcp-server lease print Flags: X - disabled, R - radius, D - dynamic, B - blocked
1
ADDRESS MAC-ADDRESS HOST-NAME SERVER RATE-LIMIT STATUS
0 192.168.88.254 6C:3B:6B:7C:41:3E MikroTik DHCPv4_Server bound ``` Then you can set a rate to a DHCPv4 lease that will create a new dynamic simple queue entry: ``` [admin@MikroTik] > /ip dhcp-server lease set 0 rate-limit=10M/10M [admin@MikroTik] > /queue simple ...
1
Network
Sub-menu:/ip dhcp-server network ``` /ip dhcp-server network ``` Properties Property | Description ---------------------- address(IP/netmask; Default: ) | the network DHCP server(s) will lease addresses from boot-file-name(string; Default: ) | Boot filename caps-manager(string; Default: ) | A comma-separated list of IP...
1
RADIUS Support
Since RouterOS v6.43 it is possible to use RADIUS to assign a rate limit per lease, to do so you need to pass theMikrotik-Rate-Limitattribute from your RADIUS Server for your lease. To achieve this you first need to set your DHCPv4 Server to use RADIUS for assigning leases. Below is an example of how to set it up: ``` ...
1
Alerts
To find any rogue DHCP servers as soon as they appear in your network, the DHCP Alert tool can be used. It will monitor the interface for all DHCP replies and check if this reply comes from a valid DHCP server. If a reply from an unknown DHCP server is detected, an alert gets triggered: ``` [admin@MikroTik] ip dhcp-ser...
1
DHCP Options
Sub-menu:/ip dhcp-server option ``` /ip dhcp-server option ``` With the help of the DHCP Option list, it is possible to define additional custom options for DHCP Server to advertise. Option precedence is as follows: This is the order in which the client option request will be filled in. According to the DHCP protocol, ...
1
DHCP Option Sets
Sub-menu:/ip dhcp-server option sets ``` /ip dhcp-server option sets ``` This menu allows combining multiple options in option sets, which later can be used to override the default DHCP server option set.
1
Example
Classless Route A classless route adds a specified route in the clients routing table. In our example, it will add According to RFC 3442: The first part is the netmask ("18" = netmask /24). Second part is significant part of destination network ("A00000" = 160.0.0). Third part is IP address of gateway ("0A016501" = 10....
1
DST-ADDRESS PREF-SRC GATEWAY DISTANCE
0 ADS 0.0.0.0/0 10.1.101.1 0 1 ADS 160.0.0.0/24 10.1.101.1 0 ``` A much more robust way would be to use built-in variables, the previous example can be rewritten as: ``` /ip dhcp-server option add name=classless code=121 value="0x18A00000\$(NETWORK_GATEWA...
1
Vendor Classes
RouterOS support vendor class, ID matcher. The vendor class is used by DHCP clients to optionally identify the vendor and configuration.
1
Example
In the following configuration example, we will give an IP address from a particular pool for an Android-based mobile phone. We will use the RouterBOARD with a default configuration ``` /ip pool add name=default-dhcp ranges=192.168.88.10-192.168.88.254 add name=pool-for-VID ranges=172.16.16.10-172.16.16.120 ``` Configu...
1
Generic matcher
Since RouterOS 7.4beta4 (2022-Jun-15 14:04) the vendor-id matcher is converted to a generic matcher. The generic matcher allows matching any of the DHCP options. And an example to match DHCP option 60 similar to vendor-id-class matcher: ``` /ip dhcp-server matcher add address-pool=pool1 code=60 name=test value=android-...
1
Configuration Examples
1
Setup
To simply configure DHCP server you can use asetupcommand. ``` setup ``` First, you configure an IP address on the interface: ``` [admin@MikroTik] > /ip address add address=192.168.88.1/24 interface=ether3 disabled=no ``` Then you usesetupacommand which will automatically ask necessary parameters: ``` setup ``` ``` [ad...
1
Manual configuration
To configure the DHCP server manually to respond to local requests you have to configure the following: ``` /ip pool add name=dhcp_pool0 ranges=192.168.88.2-192.168.88.254 ``` ``` /ip dhcp-server network add address=192.168.88.0/24 dns-server=192.168.88.1 gateway=192.168.88.1 ``` ``` /ip address add address=192.168.88....
1
DHCPv6 Server
1
Summary
Standards:RFC 3315, RFC 3633 ``` RFC 3315, RFC 3633 ``` Single DUID is used for client and server identification, only IAID will vary between clients corresponding to their assigned interface. Client binding creates a dynamic pool with a timeout set to binding's expiration time (note that now dynamic pools can have a t...
1
General
Sub-menu:/ipv6 dhcp-server ``` /ipv6 dhcp-server ``` This sub-menu lists and allows to configure DHCP-PD servers.
1
DHCPv6 Server Properties
Property | Description ---------------------- address-pool(enum | static-only; Default:static-only) | IPv6 pool, from which to take IPv6 address for the clients, pool prefix-length must be specified as /128. preffix-pool(enum | static-only; Default:static-only) | IPv6 pool, from which to take IPv6 prefxies for the clie...
1
Bindings
Sub-menu:/ipv6 dhcp-server binding ``` /ipv6 dhcp-server binding ``` DUID is used only for dynamic bindings, so if it changes then the client will receive a different prefix than previously. Property | Description ---------------------- address(IPv6 prefix; Default: ) | IPv6 prefix that will be assigned to the client a...
1
Rate limiting
It is possible to set the bandwidth to a specific IPv6 address by using DHCPv6 bindings. This can be done by setting a rate limit on the DHCPv6 binding itself, by doing this a dynamic simple queue rule will be added for the IPv6 address that corresponds to the DHCPv6 binding. By using therate-limittheparameter you can ...
1
ADDRESS DUID SERVER STATUS
0 D fdb4:4de7:a3f8:418c::/66 0x6c3b6b7c413e DHCPv6_Server bound [admin@MikroTik] > /ipv6 dhcp-server binding make-static 0 [admin@MikroTik] > /ipv6 dhcp-server binding print Flags: X - disabled, D - dynamic
1
ADDRESS DUID SERVER STATUS
0 fdb4:4de7:a3f8:418c::/66 0x6c3b6b7c413e DHCPv6_Server bound ``` Then you need can set a rate to a DHCPv6 binding that will create a new dynamic simple queue entry: ``` [admin@MikroTik] > /ipv6 dhcp-server binding set 0 rate-limit=10M/10 [admin@MikroTik] > /queue simple print Flags: X - disabled, I - invalid, D - dyna...
1
RADIUS Support
Since RouterOS v6.43 it is possible to use RADIUS to assign a rate-limit per DHCPv6 binding, to do so you need to pass theMikrotik-Rate-Limitattribute from your RADIUS Server for your DHCPv6 binding. To achieve this you first need to set your DHCPv6 Server to use RADIUS for assigning bindings. Below is an example of ho...
1
Configuration Example
1
Enabling IPv6 Prefix delegation
Let's consider that we already have a running DHCP server. To enable IPv6 prefix delegation, first, we need to create an address pool: ``` /ipv6 pool add name=myPool prefix=2001:db8:7501::/60 prefix-length=62 ``` Notice that prefix-length is 62 bits, which means that clients will receive /62 prefixes from the /60 pool....
1
ADDRESS DU IAID SER.. STATUS 0 D 2001:db8:7501:1::/62 16 0 loc.. bound
[admin@RB493G] /ipv6 dhcp-server binding> make-static 0 ``` ``` [admin@RB493G] /ipv6 route> print Flags: X - disabled, A - active, D - dynamic, C - connect, S - static, r - rip, o - ospf, b - bgp, U - unreachable
1
DST-ADDRESS GATEWAY DISTANCE
... 2 ADS 2001:db8:7501:1::/62 fe80::224:1dff:fe17:8... 1 ```
1
Enabling IPv6 Address delegation
Address delegation on DHCPv6 server side works almost in the exact same way as when you configure prefix server. Only difference is that you must specify in configuration address-pool instead of prefix-pool and the pool used for this server must be defined to use /128 prefix-length. Of course, you can create server whi...
1
Address pool to be used for 'bridge', must have prefix-length 128
/ipv6 pool add name=myLocalLan prefix=2001:db8::/100 prefix-length=128
1
DHCPv6 server with spcified 'address' pool
/ipv6 dhcp-server add address-pool=myLocalLan interface=bridge name=myLocalServer prefix-pool=""
1
We must 'advertise' that this is managed network so LAN devices use DHCPv6 clients
1
RFC 4861, RFC 4862, RFC 8415 'M - Managed address configuration'
/ipv6 nd add interface=bridge managed-address-configuration=yes
1
We must enable advertising on our 'bridge' interface
1
We can even add interface without specified prefix, because we here need only
1
to advertise 'option' that tells this is managed network
/ipv6 nd prefix add interface=bridge ```
1
DHCP Relay
1
Summary
Sub-menu:/ip dhcp-relay ``` /ip dhcp-relay ``` The purpose of the DHCP relay is to act as a proxy between DHCP clients and the DHCP server. It is useful in networks where the DHCP server is not on the same broadcast domain as the DHCP client. DHCP relay does not choose the particular DHCP server in the DHCP-server list...
1
Properties
Property | Description ---------------------- add-relay-info(yes | no; Default:no) | Adds DHCP relay agent information if enabled according to RFC 3046. Agent Circuit ID Sub-option contains mac address of an interface, Agent Remote ID Sub-option contains MAC address of the client from which request was received. delay-...
1
Configuration Example
Let us consider that you have several IP networks 'behind' other routers, but you want to keep all DHCP servers on a single router. To do this, you need a DHCP relay on your network which will relay DHCP requests from clients to the DHCP server. This example will show you how to configure a DHCP server and a DHCP relay...
1
ADDRESS NETWORK BROADCAST INTERFACE
0 192.168.0.1/24 192.168.0.0 192.168.0.255 To-DHCP-Relay 1 10.1.0.2/24 10.1.0.0 10.1.0.255 Public [admin@DHCP-Server] ip address> ``` IP addresses of DHCP-Relay: ``` [admin@DHCP-Relay] ip address> print Flags: X - disabled, I - invalid, D - dynamic
1
ADDRESS NETWORK BROADCAST INTERFACE
0 192.168.0.2/24 192.168.0.0 192.168.0.255 To-DHCP-Server 1 192.168.1.1/24 192.168.1.0 192.168.1.255 Local1 2 192.168.2.1/24 192.168.2.0 192.168.2.255 Local2 [admin@DHCP-Relay] ip address> ``` DHCP Server Setup To setup 2 DHCP Servers on the DHCP-Server router add 2 pools. For networ...
1
NAME RANGES
0 Local1-Pool 192.168.1.11-192.168.1.100 1 Local2-Pool 192.168.2.11-192.168.2.100 [admin@DHCP-Server] ip pool> ``` Create DHCP Servers: ``` /ip dhcp-server add interface=To-DHCP-Relay relay=192.168.1.1 \ address-pool=Local1-Pool name=DHCP-1 disabled=no /...
1
NAME INTERFACE RELAY ADDRESS-POOL LEASE-TIME ADD-ARP
0 DHCP-1 To-DHCP-Relay 192.168.1.1 Local1-Pool 3d00:00:00 1 DHCP-2 To-DHCP-Relay 192.168.2.1 Local2-Pool 3d00:00:00 [admin@DHCP-Server] ip dhcp-server> ``` Configure respective networks: ``` /ip dhcp-server network add address=192.168.1.0/24 gateway=192.168.1.1 \ dns-server=159.148.60.20 /ip d...
1
ADDRESS GATEWAY DNS-SERVER WINS-SERVER DOMAIN
0 192.168.1.0/24 192.168.1.1 159.148.60.20 1 192.168.2.0/24 192.168.2.1 159.148.60.20 [admin@DHCP-Server] ip dhcp-server network> ``` DHCP Relay Config Configuration of DHCP-Server is done. Now let's configure DHCP-Relay: ``` /ip dhcp-relay add name=Local1-Relay interface=Local1 \ dhcp-server=192.168.0....
1
NAME INTERFACE DHCP-SERVER LOCAL-ADDRESS
0 Local1-Relay Local1 192.168.0.1 192.168.1.1 1 Local2-Relay Local2 192.168.0.1 192.168.2.1 [admin@DHCP-Relay] ip dhcp-relay> ```
1
DHCP Relay with VRF (introduced in 7.15)
Let's take the previous setup but we'll consider that the interface to the DHCP server and interfaces to DHCP clients are added in VRF: ``` /ip vrf add interfaces=To-DHCP-Server name=vrf_server add interfaces=Local2 name=vrf2 add interfaces=Local1 name=vrf1 ``` In the DHCP-relay configuration dhcp-server-vrf should be ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Diagnostics, monitoring and troubleshooting
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/119144606/Diagnostics+monitoring+and+troubleshooting
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Disks
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/91193346/Disks
19
Summary
Sub-menu:/disk ``` /disk ``` This menu will list all attached storage devices, presuming that they are supported and in working condition. This is especially useful for RouterBOARD devices with SD/CF/USB/SATA/NVMe slots and x86 systems with additional dedicated storage drives - as the built-in storage is quite small, a...
1
Properties
Property | Description ---------------------- eject-drive() | Safely unmounts (ejects) drive of your selection by using "slot" that is assigned to it. After issuing this command it can be removed from host device. format-drive() | Command to initiate disk formatting process. Contains additional properties of its own. S...
1
Flags
Property | Description ---------------------- X - disabled | Disabled device E - empty | Empty slot B - BLOCK-DEVICE | The "B - BLOCK-DEVICE"- Flag means that this device works using blocks for input/output operations. In the context of RouterOS, its distinction is crucial, as it helps determine whether a device is fun...
1
Settings
Property | Description ---------------------- auto-smb-sharing(yes | no; Default: no) | Enables dynamic SMB shareswhen new disk/partition item is added in "/disk" auto-smb-user(list of strings; Default: ) | Default value for smb-sharing/smb-user setting, when new disk/partition item is added in "/disk" auto-media-share...
1
Examples
1
Formatting attached storage unit - Simple
1. Disk is attached, and already mounted automatically by the system. ``` [admin@MikroTik] > disk print Flags: B - BLOCK-DEVICE; M, F - FORMATTING Columns: SLOT, MODEL, SERIAL, INTERFACE, SIZE, FREE, FS
1
SLOT MODEL SERIAL INTERFACE SIZE FREE FS
0 BM usb1 USB Flash Disk FBA0911260071572 USB 2.00 480Mbps 2 004 877 312 1 921 835 008 ext4 ``` ``` [admin@MikroTik] > /file print
1
NAME TYPE SIZE CREATION-TIME
0 skins directory jan/01/1970 03:00:01 1 pub directory feb/04/1970 21:31:40 2 usb1 disk mar/07/2022 14:05:16 ``` 1. Formatting the disk, in either of two supported file-systems (ext4 or fat32). ``` [admin@MikroTik] > /d...
1
Formatting attached storage unit - Detailed
Let us presume that you have added a storage device to your device that is running RouterOS. System will try to automatically mount it and in such case if storage is formatted in a supported file-system and partition record, it will be found in "/files" menu moments after you plugged it in to the host device. If not, h...
1
SLOT MODEL SERIAL INTERFACE SIZE FREE FS
0 BM usb1 USB Flash Disk FBA0911260071572 USB 2.00 480Mbps 2 004 877 312 1 921 835 008 ext4 ``` We can here see that system sees one storage drive and also that it is formatted with a known file-system type. When running file menu print-out we also see that is mounted. ``` [admin@MikroTik] > file print
1
NAME TYPE SIZE CREATION-TIME
0 usb1 disk mar/07/2022 14:05:16 1 skins directory jan/01/1970 03:00:01 2 pub directory feb/04/1970 21:31:40 ``` 1. To formatting drive - we issue command with previously know id or name(slot) and with desired file-system (ext4 or fat32), we can also assign label to device as I did in this exa...
1
Web-Proxy cache configuration example
Enter proxy cache path under IP -> Proxy menu and web proxy store is automatically created in files menu. If a non-existent directory path is used, an additional sub-directory is also created automatically. ``` [admin@MikroTik] > /ip proxy set cache-path=usb1/cache-n-db/proxy/ ... [admin@MikroTik] > /file print
1
NAME TYPE SIZE CREATION-TIME
0 skins directory mar/02/2015 18:56:23 1 sys-note.txt .txt file 23 jul/03/2015 11:40:48 2 usb1 disk jul/03/20...
1
Log on disk configuration example
When configuring logging on disk make sure that you create directories in which you want to store the log files manually, as non-existent directories will NOT be automatically created in this case. ``` [admin@MikroTik] > /system logging action set disk disk-file-name=/disk1/log ... [admin@MikroTik] > /file print wher...
1
NAME TYPE SIZE CREATION-TIME
0 disk1/log directory jul/03/2015 12:44:09 1 disk1/log/syslog.0.txt .txt file 160 jul/03/2015 12:44:11 ```
1
Allocate RAM to folder
It is possible to add folders linked to RAM. Folders will be emptied on reboot or power loss.RAM will be filled up to tmpfs-max-size and if this variable in not provided - up to 1/2 from available RAM. ``` [admin@MikroTik] > /disk add type=tmpfs tmpfs-max-size=100M [admin@MikroTik] > file print Columns: NAME, TYPE, SI...
1
NAME TYPE SIZE CREATION-TIME
0 tmp1 disk 100 003 840 dec/12/2022 11:01:48 ```
1
Test disk performance
Starting from 7.16 to run disk performance tests. Disks has to be disabled or without mountable file system (unformatted).Check available disks, if disk is already mounted - disable it. ``` [admin@MikroTik] > disk print Flags: B - BLOCK-DEVICE; M - MOUNTED Columns: SLOT, MODEL, SERIAL, INTERFACE, SIZE, FREE, FS
1
SLOT MODEL SERIAL INTERFACE SIZE FREE FS
0 BM usb1 JMicron External DD56419883891 USB 3.10 5000Mbps 64 023 257 088 62 692 188 160 ext4 [admin@MikroTik] > disk disable usb1 [admin@MikroTik] > disk test disk=usb2 pattern=sequential type=device thread-count=4 block-size=4K direction=write Columns: SEQ, RATE, IOPS, DISK, TYPE, PATTERN, DIR, BSIZE, THREADS ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Distance guide
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/39059503/Distance+guide
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
DLNA Media server
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/237699479/DLNA+Media+server
2
Server settings
Property | Description ---------------------- allowed-hostname | To restrict access to specific hostnames. allowed-ip | To limit access to specified IP addresses friendly-name | The name that will be displayed for the DLNA server on the network. interface | Specifies the network interface that the DLNA server will use ...
1
Configuration examples
Creating a DLNA server ``` /ip media add friendly-name=Mikrotik interface=bridge1 path=usb1 ``` Creating multiple DLNA servers with limitations. Usage example - Limit children's TV access only to child-friendly media, located in folder "usb1/kids" ``` /ip media add friendly-name=adults interface=bridge1 path=usb1/adult...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
DNS
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/37748767/DNS
16
2Introduction2.1DNS configuration2.2DNS Cache2.3DNS Static3DNS over HTTPS (DoH)3.1Known compatible/incompatible DoH services4Adlist4.1Whitelist for Adlist4.2Configuration examples:4.2.1URL based adlist:4.2.2Locally hosted adlist:5Forwarders5.1Forwarder configuration5.2Configuration example
1
Introduction
Domain Name System (DNS) usually refers to the Phonebook of the Internet. In other words, DNS is a database that links strings (known as hostnames), such aswww.mikrotik.comto a specific IP address, such as 159.148.147.196. A MikroTik router with a DNS feature enabled can be set as a DNS cache for any DNS-compliant clie...
1
DNS configuration
DNS facility is used to provide domain name resolution for the router itself as well as for the clients connected to it. Property | Description ---------------------- allow-remote-requests(yes|no; Default:no) | Specifies whether to allow router usage as a DNS cache for remote clients. Otherwise, only the router itself ...
1
DNS Cache
This menu provides two lists with DNS records stored on the server:
1
DNS Static
The MikroTik RouterOS DNS cache has an additional embedded DNS server feature that allows you to configure multiple types of DNS entries that can be used by the DNS clients using the router as their DNS server. This feature can also be used to provide false DNS information to your network clients. For example, resolvin...
1
NAME REGEXP ADDRESS TTL
0 www.mikrotik.com 10.0.0.1 1d 1 [*mikrotik*] 10.0.0.2 1d ``` Property | Description ---------------------- address(IPv4/IPv6) | The address that will be used for "A" or "AAAA" type records. cname(string) | Alias name for a domain name. forward-to | The IP address of a domain name serv...
1
DNS over HTTPS (DoH)
Starting from RouterOS version v6.47 it is possible to use DNS over HTTPS (DoH). DoH uses HTTPS protocol to send and receive DNS requests for better data integrity. The main goal is to provide privacy by eliminating "man-in-the-middle" attacks (MITM). Video: DoH setup There are various ways to find out what root CA cer...
1
Known compatible/incompatible DoH services
Compatible DoH services: Cloudflare Google NextDNS OpenDNS Incompatible DoH services: Mullvad
1
Adlist
Adlist is an integral component of network-level ad blocking, comprising a curated collection of domain names known for serving advertisements. This feature operates by utilizing Domain Name System (DNS) resolution to intercept A and AAAA requests to these domains. When a client device queries a DNS server for a domain...
1
Whitelist for Adlist
To exempt certain domains from Adlist, you need to create a static DNS FWD entry, for example,/ip/dns/static/add name=bar.test type=FWD, if such entry is present, the query will be forwarded to the next DNS, either dynamic or one configured under "/ip/dns/set servers=" , FWD entries are supported by DoH as well. ``` /i...
1
Configuration examples:
1
URL based adlist:
``` /ip/dns/adlist add url=https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts ssl-verify=no ``` To see how many domain names are present and matched, you can run: ``` /ip/dns/adlist/print Flags: X - disabled 0 url="https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts" ssl-verify=no match-count...
1
Locally hosted adlist:
To create your adlist, you can create a Txt file with the domains. Example: ``` 0.0.0.0 example1.com 0.0.0.0 eu1.example.com 0.0.0.0 ex.com 0.0.0.0 com.example.com ``` To add file to adlist : ``` /ip/dns/adlist/add file=host.txt ``` ``` /ip/dns/adlist/print Flags: X - disabled 0 file=host.txt match-count=0 name-count...
1
Forwarders
DNS Forwarders allows a user to configure a named DNS forwarder that can be used for static FWD entries asforward-tovalue. For eachForwarderis possible to configure multiple regular upstream and DoH servers. Configuredforwarderservers will be used by round-robin algorithm - for each query, next server will be used to r...
1
Forwarder configuration
In/ip/dns/forwaderssection,forwarderscan added, modified or removed. Property | Description ---------------------- name(string;Default: ) | Forwarder name. dns-servers(string; Default: ) | An IP address or DNS name of a domain name server. Can contain multiple records, for example,dns-servers=1.1.1.1,8.8.8.8,local.dns ...
1
Configuration example
Configure/add aforwarder: ``` /ip dns forwarders add dns-servers=1.1.1.1,local.dns doh-servers=https://dns.google/dns-query name=forwarder1 ``` Configure/add a statis DNS FWD entry: ``` /ip dns static add forward-to=forwarder1 name=mikrotik.com type=FWD ``` Now each time when a router will receive request to resolvemik...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Dot1X
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328090/Dot1X
13
1Summary2Client3Server4Examples4.1RouterOS Authenticator configuration4.1.1Port based VLAN ID assignment4.1.2Dynamic switch rule configuration4.2RouterOS Supplicant configurationSummary
Dot1X is implementation of IEEE 802.1X standard in RouterOS. Main purpose is to provide port-based network access control using EAP over LAN also known as EAPOL. 802.1X consists of a supplicant (client), an authenticator (server) and an authentication server (RADIUS server). Both authenticator and supplicant sides are ...
1
Client
Supplicant configuration settings. Sub-menu:/interface dot1x client ``` /interface dot1x client ``` Property | Description ---------------------- anon-identity(string; Default: ) | Identity for outer layer EAP authentication. Used only witheap-ttlsandeap-peapmethods. If not set, value fromidentityparameter will be used...
1
Server
A RouterOS dot1x server acts as an authenticator. An interface where dot1x server is enabled will block all traffic except for EAPOL packets which is used for the authentication. After client is successfully authenticated, the interface will accept all received traffic on the port. If the interface is connected to a sh...
1
Examples
Below are described the most common configuration examples for dot1x server and client.
1
RouterOS Authenticator configuration
Start off by adding a new RADIUS client. The authentication server (RADIUS) does not necessary have to be in the same LAN as authenticator, but it must be reachable from the authenticator, so any firewall limitations must be considered. ``` /radius add address=10.1.2.3 secret=radiussecret service=dot1x ``` Add new dot1...
1
Port based VLAN ID assignment
It is possible to assign an authenticated interface to a specific VLAN ID using bridge VLAN filtering. This can be done using RADIUS Tunnel-Type, Tunnel-Medium-Type and Tunnel-Private-Group-ID attributes. Note that only devices with hardware offloaded VLAN filtering will be able to do this in switch chip. First of all,...
1
Dynamic switch rule configuration
In some network configurations, additional access rules are needed for a particular supplicant to restrict or allow certain network services. This can be done using a Mikrotik-Switching-Filter attribute, please see theRADIUS vendor dictionary. When a client is successfully authenticated by an authentication server, the...
1
Drop ARP frames (EtherType: 0x0806 or 2054)
Mikrotik-Switching-Filter = "mac-protocol 2054 action drop" /interface ethernet switch rule print Flags: X - disabled, I - invalid, D - dynamic 0 D ;;; dot1x dynamic switch=switch1 ports=ether1 src-mac-address=CC:2D:E0:11:22:33/FF:FF:FF:FF:FF:FF mac-protocol=arp copy-to-cpu=no redirect-to-cpu=no mirror=no new-dst-port...
1
Allow UDP (IP protocol: 0x11 or 17) destination port 100 and drop all other packets
Mikrotik-Switching-Filter = "protocol 17 dst-port 100 action allow, action drop" /interface ethernet switch rule print Flags: X - disabled, I - invalid, D - dynamic 0 D ;;; dot1x dynamic switch=switch1 ports=ether1 src-mac-address=CC:2D:E0:11:22:33/FF:FF:FF:FF:FF:FF protocol=udp dst-port=100 copy-to-cpu=no redirect-to...
1
Allow only authenticated source MAC address, drop all other packets
Mikrotik-Switching-Filter = "action allow, src-mac-address none action drop" /interface ethernet switch rule print Flags: X - disabled, I - invalid; D - dynamic 0 D ;;; dot1x dynamic switch=switch1 ports=ether1 src-mac-address=CC:2D:E0:01:6D:EB/FF:FF:FF:FF:FF:FF copy-to-cpu=no redirect-to-cpu=no mirror=no 1 D ;;; dot...
1
INTERFACE BRIDGE HW PVID PRIORITY PATH-COST INTERNAL-PATH-COST HORIZON
0 H ether1 bridge1 yes 1 0x80 10 10 none 1 H ether2 bridge1 yes 1 0x80 10 10 none 2 H ether12 bridge1 yes 1 0x80 ...
1
RouterOS Supplicant configuration
CA certificates are required foreap-tls,eap-ttlsandeap-peapauthentication methods. Additionally a client certificate is required foreap-tlsmethod. For this example we have already imported a P12 certificate bundle with self signed client and CA certificates. For more information how to import certificates in RouterOS, ...
1
NAME COMMON-NAME SUBJECT-ALT-NAME FINGERPRINT
0 K A T dot1x-client ez_dot1x-client IP:10.1.2.34 1 L A T dot1x CA ca ``` Simply add a new dot1x client instance that will initiate authentication process. ``` /interface dot1x client add anon-identity=anon...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Dual SIM Application
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/240156741/Dual+SIM+Application
32
2Summary3Initial settings4Roaming script example5Failover script example6Setting up scheduler
1
Summary
The first script example shows how to switch between SIM slots in case mobile roaming is detected for LtAP mini devices. This could be useful for mobile vehicle applications, where cars, buses or trains could drive abroad and should use two SIM cards (one for a home network, other for a roaming network). Since RouterOS...
1
Initial settings
First, make sure you have correctly set up LTE network parameters (provided by the mobile network operator) for each SIM card. You can use the default APN profile or create two separate ones, follow this link -LTE# Quicksetupexample. This example uses the default APN profile. After that, enable data roaming for connect...
1
Roaming script example
Now create a script that will run with a scheduler. This script will go through a few key points: ``` /interface lte ``` Let's call this script "roamingScript", and see below the source: ``` {
1
Setup and read current values, "up" SIM slot will be used for roaming, "down" for home network
:global simSlot [/system routerboard sim get sim-slot] :global timeoutLTE 60 :global timeoutConnect 60
1
Wait for LTE to initialize for maximum "timeoutLTE" seconds
:local i 0 :local isLTEinit false :while ($i<$timeoutLTE) do={ :foreach n in=[/interface lte find] do={:set $isLTEinit true} :if ($isLTEinit=true) do={ :set $i $timeoutLTE } :set $i ($i+1) :delay 1s }
1
Check if LTE is initialized, or try power-reset the modem
:if ($isLTEinit=true) do={
1
Wait for LTE interface to connect to mobile network for maximum "timeoutConnet" seconds
:local isConnected false :set $i 0 :while ($i<$timeoutConnect) do={ :if ([/interface lte get [find name="lte1"] running]=true) do={ :set $isConnected true :set $i $timeoutConnect } :set $i ($i+1) :delay 1s }
1
Check if LTE is connected
if ($isConnected=true) do={ :local Info [/interface lte monitor lte1 once as-value] :local isRoaming ($Info->"roaming")
1
Check which SIM slot is used
:if ($simSlot="down") do={
1
If "down" (home) slot, check roaming status
:if ($isRoaming=true) do={ :log info message="Roaming detected, switching to SIM UP (Roaming)" /system routerboard sim set sim-slot=up } } else={
1
Else "up" (roaming) slot, check roaming status
:if (!$isRoaming=true) do={ :log info message="Not roaming, switching to SIM DOWN (Home)" /interface lte settings set sim-slot=down } } } else={ :log info message="LTE interface did not connect to network, wait for next scheduler" } } else={ :log info message="LTE modem did not appear, trying power-reset" /system route...
1
Failover script example
Now create a script that will run with a scheduler. This script will go through a few key points: ``` /interface lte ``` Note:Keep in mind that the SIM slot will only be changed if the current one is not able to connect to the network if you need to switch back to the main SIM card you need to schedule another action t...
1
Setup and read current values
:global simSlot [/system routerboard modem get sim-slot] :global timeoutLTE 60 :global timeoutConnect 60
1
Wait for LTE to initialize for maximum "timeoutLTE" seconds
:local i 0 :local isLTEinit false :while ($i<$timeoutLTE) do={ :foreach n in=[/interface lte find] do={:set $isLTEinit true} :if ($isLTEinit=true) do={ :set $i $timeoutLTE } :set $i ($i+1) :delay 1s }
1
Check if LTE is initialized, or try power-reset the modem
:if ($isLTEinit=true) do={
1
Wait for LTE interface to connect to mobile network for maximum "timeoutConnet" seconds
:local isConnected false :set $i 0 :while ($i<$timeoutConnect) do={ :if ([/interface lte get [find name="lte1"] running]=true) do={ :set $isConnected true :set $i $timeoutConnect } :set $i ($i+1) :delay 1s }
1
Check if LTE is connected
if ($isConnected=false) do={
1
Check which SIM slot is used
:if ($simSlot="down") do={
1
If "down" slot, switch to up
:log info message="LTE down, switching slot to UP" /interface lte settings set sim-slot=up } :if ($simSlot="up") do={
1
If "up" slot, switch to down
:log info message="LTE down, switching slot to DOWN" /interface lte settings set sim-slot=down } } else={
1
Else "running"
:if ($isConnected=true) do={ :log info message="LTE UP" } else={ :log info message="LTE interface did not connect to network, wait for next scheduler" } } } else={ :log info message="LTE modem did not appear, trying power-reset" /system routerboard usb power-reset duration=5s } } ``` ``` {
1
Setup and read current values
:global simSlot [/system routerboard modem get sim-slot] :global timeoutLTE 60 :global timeoutConnect 60
1
Wait for LTE to initialize for maximum "timeoutLTE" seconds
:local i 0 :local isLTEinit false :while ($i<$timeoutLTE) do={ :foreach n in=[/interface lte find] do={:set $isLTEinit true} :if ($isLTEinit=true) do={ :set $i $timeoutLTE } :set $i ($i+1) :delay 1s }
1
Check if LTE is initialized, or try power-reset the modem
:if ($isLTEinit=true) do={
1
Wait for LTE interface to connect to mobile network for maximum "timeoutConnet" seconds
:local isConnected false :set $i 0 :while ($i<$timeoutConnect) do={ :if ([/interface lte get [find name="lte1"] running]=true) do={ :set $isConnected true :set $i $timeoutConnect } :set $i ($i+1) :delay 1s }
1
Check if LTE is connected
if ($isConnected=false) do={
1
Check which SIM slot is used
:if ($simSlot="down") do={
1
If "down" slot, switch to up
:log info message="LTE down, switching slot to UP" /interface lte settings set sim-slot=up } :if ($simSlot="up") do={
1
If "up" slot, switch to down
:log info message="LTE down, switching slot to DOWN" /interface lte settings set sim-slot=down } } else={
1
Else "running"
:if ($isConnected=true) do={ :log info message="LTE UP" } else={ :log info message="LTE interface did not connect to network, wait for next scheduler" } } } else={ :log info message="LTE modem did not appear, trying power-reset" /system routerboard usb power-reset duration=5s } } ```
1
Setting up scheduler
Last, create your scheduler that will run the previously created script. Choose a proper scheduler interval, so two or more events do not overlap with each other. For this example above, 3 minutes will be enough. ``` /system scheduler add interval=3m on-event=roamingScript name=Roaming ``` ``` /system scheduler add int...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Dynamic DNS
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/139067407/Dynamic+DNS
3
Introduction
``` /tool dns-update ``` Standards:RFC 2136, RFC 3007 ``` RFC 2136, RFC 3007 ``` Dynamic DNS Update Tool gives a way to keep the domain name pointing to a dynamic IP address. It works by sending a domain name system update requests to the name server, which has a zone to be updated. Secure DNS updates are also supporte...
1
Properties
Property | Description ---------------------- address(IP; Default:) | Defines the IP address associated with the domain name. dns-server(IP; Default:) | DNS server to send updates to. key(string; Default:) | Authorization key to access the server. key-name(string; Default:) | Authorization key name (like a username) to...
1
Example
To tell 23.34.45.56 DNS server to (re)associate mydomain name in the myzone.com zone with 68.42.14.4 IP address specifying that the name of the key is dns-update-key and the actual key updates: ``` [admin@MikroTik] tool> dns-update dns-server=23.34.45.56 name=mydomain \ \... zone=myzone.com address=68.42.14.4 key-name=...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
E-mail
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/24805377/E-mail
3
Properties
``` /tool e-mail ``` This submenu allows setting SMTP server that will be used. Property | Description ---------------------- address(IP/IPv6 address; Default:0.0.0.0) | SMTP server's IP address. from(string; Default:<>) | Name or email address that will be shown as a receiver. password(string; Default:"") | Password u...
1
Sending Email
``` /tool e-mail send ``` Send command takes the following parameters: Property | Description ---------------------- body(string; Default: ) | The actual body of the email message cc(string; Default: ) | Send a copy to listed recipients. Multiple addresses allowed, use "," to separate entries file(File[,File]; Default:...
1
Basic examples
This example will show how to send an email with configuration export every 24hours. 1. Configure SMTP server ``` [admin@MikroTik] /tool e-mail> set server=10.1.1.1 port=25 from="router@mydomain.com" ``` 1. Add a newscriptnamed "export-send": ``` /export file=export /tool e-mail send to="config@mydomain.com" subject="$...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Enterprise wireless security with User Manager v5
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/92635137/Enterprise+wireless+security+with+User+Manager+v5
24
Installing User Manager
User Manager v5 can be found in the 'Extra packages' archive for thelatest release of RouterOS v7. Download the archive for the appropriate CPU architecture, extract it, upload the User Manager package to  the router and reboot it.
1
Generating TLS certificates
When using secure EAP methods, the client device (supplicant) verifies the identity of the authenication server before sending its own credentials to it.For this to happen, the authentication server needs a TLS certificate. This certificate should: The EAP-TLS method requires the client device to have a TLS certificate...
1
Generating a Certificate Authority
/certificate add name=radius-ca common-name="RADIUS CA" key-size=secp384r1 digest-algorithm=sha384 days-valid=1825 key-usage=key-cert-sign,crl-sign sign radius-ca ca-crl-host=radius.mikrotik.test
1
Generating a server certificate for User Manager
add name=userman-cert common-name=radius.mikrotik.test subject-alt-name=DNS:radius.mikrotik.test key-size=secp384r1 digest-algorithm=sha384 days-valid=800 key-usage=tls-server sign userman-cert ca=radius-ca
1
Generating a client certificate
add name=maija-client-cert common-name=maija@mikrotik.test key-usage=tls-client days-valid=800 key-size=secp384r1 digest-algorithm=sha384 sign maija-client-cert ca=radius-ca
1
Exporting the public key of the CA as well as the generated client private key and certificate for distribution to client devices
export-certificate radius-ca file-name=radius-ca
1
A passphrase is needed for the export to include the private key
export-certificate maija-client-cert type=pkcs12 export-passphrase="true zebra capacitor ziptie" ```
1
Configuring User Manager
```
1
Enabling User Manager and specifying, which certificate to use
/user-manager set enabled=yes certificate=userman-cert
1
Enabling CRL checking to avoid accepting revoked user certificates
/certificate settings set crl-download=yes crl-use=yes
1
Adding access points
/user-manager router add name=ap1 address=10.0.0.11 shared-secret="Use a secure password generator for this" add name=ap2 address=10.0.0.12 shared-secret="Use a secure password generator for this too"
1
Limiting allowed authentication methods
/user-manager user group set [find where name=default] outer-auths=eap-tls,eap-peap add name=certificate-authenticated outer-auths=eap-tls
1
Adding users
/user-manager user add name=maija@mikrotik.test group=certificate-authenticated add name=paija@mikrotik.test group=default password="right mule accumulator nail" ```
1
Configuring access points
1
AP running regular wireless package
```
1
Configuring radius client
/radius add address=10.0.0.10 secret="Use a secure password generator for this" service=wireless timeout=1s /radius incoming set accept=yes
1
Adding a security profile and applying it to wireless interfaces
/interface/wireless/security-profile add name=radius mode=dynamic-keys authentication-types=wpa2-eap /interface/wireless set [find] security-profile=radius ```
1
AP running wifiwave2 package
```
1
Configuring radius client
/radius add address=10.0.0.10 secret="Use a secure password generator for this too" service=wireless timeout=1s /radius incoming set accept=yes
1
Configuring enabled authentication types. Can also be done via a security profile, but note that interface properties, if specified, override profile properties
/interface/wifiwave2 set [find] security.authentication-types=wpa2-eap,wpa3-eap ``` A wifiwave2 AP can  also be configured to use the extra secure wpa3-eap-192 mode, but note that it requires that all client devices support the GCMP-256 cipher and use EAP-TLS authentication.
1
Notes on client device configuration
1
Windows
When manually installing a CA in Windows, make sure to explicitly place it in the 'Trusted Root Certification Authorities' certificate store. It will not be placed there automatically.
1
Android
When connecting to a network with EAP authentication, Android devices ask the user to specify a 'domain'. This refers to the expected domain of the host name included in the RADIUS server's TLS certificate ( 'mikrotik.test' in our example). By default, Android devices use the device's built-in root CA list for validati...
1
iOS
Apple iOS does not appear to actually trust a manually imported CA to authenticate RADIUS servers. The server certificate is marked as 'Not Trusted' unless the CA was imported using Apple's proprietary 'Configurator' utility or an approved third party MDM tool.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
EoIP
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/24805521/EoIP
6
Introduction
Sub-menu:/interface eoip ``` /interface eoip ``` Ethernet over IP (EoIP) Tunneling is a MikroTik RouterOS protocol based onGRE RFC 1701that creates an Ethernet tunnel between two routers on top of an IP connection. The EoIP tunnel may run overIPIPtunnel,PPTPtunnel, or any other connection capable of transporting IP.Whe...
1
Property Description
Property | Description ---------------------- allow-fast-path(yes | no; Default:yes) | Whether to allow FastPath processing. Must be disabled if IPsec tunneling is used. arp (disabled | enabled | proxy-arp | reply-only; Default:enabled) | Address Resolution Protocol mode.disabled - the interface will not use ARPenabled...
1
Configuration Examples
Parameter tunnel-idis a method of identifying a tunnel. It must be unique for each EoIP tunnel. When bridging EoIP tunnels, it is highly recommended to set unique MAC addresses for each tunnel for the bridge algorithms to work correctly. For EoIP interfaces you can use MAC addresses that are in the range from00:00:5E:8...
1
Example
Let us assume we want to bridge two networks: 'Station' and 'AP'. By using EoIP setup can be made so that Station and AP LANs are in the same Layer2 broadcast domain. Consider the following setup: As you know wireless stations cannot be bridged, to overcome this limitation (not involving WDS) we will create an EoIP tun...
1
INTERFACE   BRIDGE HW PVID PRIORITY PATH-COST INTERNAL-PATH-COST HORIZON
0 H ether2     bridge1 yes 1 0x80 10 10 none 1 H ether3     bridge1 yes 1 0x80 10 10 none 2    eoip-remote     bridge1 yes 1 0x80 10 10 none ``` On Station router, if you do not have a local bridge in...
1
INTERFACE   BRIDGE HW PVID PRIORITY PATH-COST INTERNAL-PATH-COST HORIZON
0 H ether2     bridge1 yes 1 0x80 10 10 none 2    eoip-main     bridge1 yes 1 0x80 10 10 none ``` Now both sites are in the same Layer2 broadcast domain. You can set up IP addresses from the same network on both sites.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Ethernet
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/8323191/Ethernet
12
Summary
MikroTik RouterOS supports various types of Ethernet interfaces - ranging from 10Mbps to 10Gbps Ethernet over copper twisted pair, 1Gbps, 10Gbps, 25Gbps SFP/SFP+/SFP28 interfaces and 40Gbps, 100Gbps QSFP+/QSFP28 interfaces. Certain RouterBoard devices are equipped with a combo interface that simultaneously contains two...
1
Auto-negotiation and forced link mode
Auto-negotiation is a communication method and a set of steps employed by Ethernet devices connected via twisted pair cables. It enables these devices to agree on key transmission settings, including speed, duplex mode, and flow control. During this process, the connected devices initially exchange information about th...
1
Enabled auto-negotiation (default) with multiple advertise values
/interface ethernet set [ find default-name=ether2 ] advertise=100M-baseT-full,1G-baseT-full
1
Disabled auto-negotiation with single speed value
/interface ethernet set [ find default-name=ether3 ] auto-negotiation=no speed=100M-baseT-full ```
1
Advertise
Prior to RouterOS version 7.12, when auto-negotiation was enabledinterfacesattempted to guess the maximum available speed of the interface on the other end (making theadvertisesetting inapplicable for SFP/QSFP interfaces). After the RouterOS version 7.12, you can now manually set theadvertisebits to specify the desired...
1
Forced Mode
In the situation when a warning message appears in the log records after connecting the DAC cable or optical module, as example: ``` 10:20:47 interface,warning sfp-sfpplus1 module auto-initialization failed, try forced-mode ``` This may indicate that the connected cable or module has a corrupted or bad EEPROM checksum,...
1
FEC
FEC (Forward Error Correction) is a digital signal processing method that improves the bit error rate of SFP28, QSFP+, and QSFP28 links by adding information (parity bits) to the data at the transmitter side. The receiver side then uses this  information to detect and correct errors that may have been introduced during...
1
Properties
Sub-menu:/interface ethernet ``` /interface ethernet ``` This section describes the Ethernet interface configuration options. Property | Description ---------------------- advertise(since RouterOS v7.12:10M-baseT-half | 10M-baseT-full| 100M-baseT-half | 100M-baseT-full | 1G-baseT-half | 1G-baseT-full | 1G-baseX | 2.5G-...
1
Menu specific commands
Property | Description ---------------------- blink([id, name]) | Blink Ethernet leds monitor([id, name]) | Monitor ethernet status.Read more. reset-counters([id, name]) | Reset stats counters.Read more. reset-mac-address([id, name]) | Reset MAC address to manufacturers default. cable-test(string) | Shows detected prob...
1
Monitor
To print out a current link rate and other Ethernet related properties or to see detailed diagnostics information for transceivers, use"/interface ethernet monitor" command. The provided information can differ for different interface types (e.g. Ethernet over twisted pair or SFP interface) or for different transceivers...
1
Detect Cable Problems
A cable test can detect problems or measure the approximate cable length if the cable is unplugged on the other end and there is, therefore, "no-link". RouterOS will show: This also works if the other end is simply unplugged - in that case, the total cable length will be shown. Here is an example output: ``` [admin@CCR...
1
Stats
Using "/interface ethernet print stats"command, it is possible to see a wide range of Ethernet-related statistics. The list of statistics can differ between RouterBoard devices due to different Ethernet drivers. The list below contains all available counters across all RouterBoard devices. Most of the Ethernet statisti...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
EXP bit and MPLS Queuing
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/122388503/EXP+bit+and+MPLS+Queuing
5
Overview
When the MPLS label is attached to the packet, it increases packet length by 32 bits (4 bytes). These 32 bits are broken down as follows: The use of "experimental" bits is not specified by MPLS standards, but the most common use is to carry QoS information, similar to 802.1q priority in the VLAN tag. Note that the EXP ...
1
EXP field treatment in RouterOS
When RouterOS receives an MPLS packet, it sets the "ingress priority" value for the packet to that carried inside the top label. Note that "ingress priority"is nota field inside packet headers - it can be thought of as an additional mark assigned to a packet while being processed by the router. When RouterOS labels an ...
1
MPLS Mangle and Queuing
RouterOS firewall works only with IP traffic, which means that it is not possible to mark MPLS packets directly in mangle and limit by queues. Queuing had to be done on ingress edge router before MPLS header is added or on egress edge router after MPLS label is removed. Starting from ROS v7.17 MPLS Mangle is added. Thi...
1
Basic Example
Lets look at very basic example where on the label switching router (P) along the LSP we want to mark packets with exp bit 0, limit the bandwidth and change exp bit to 3: ``` /mpls mangle add chain=forward exp=0 set-exp=3 set-mark=m0 /queue tree add limit-at=10M max-limit=10M name=mpls_queue packet-mark=m0 parent=sfp-s...
1
CHAIN EXP SET-EXP SET-MARK PACKETS
0 forward 0 3 m0 221 654 ``` Another important thing is that MPLS mangle rules are not executed line by line like regular firewall mangle rules, MPLS Mangle is a set of actions that are applied in one go.For example, lets look at the set of rules ``` /mpls mangle add chain=forward exp=0 set-mark=m0 ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Extended features
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/120324125/Extended+features
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Fail-over PtMP CLI example
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/189497349/Fail-over+PtMP+CLI+example
9
Summary
This example shows how to configure automatic fail-over (bonding) 5Ghz link in combination with 60Ghz devices in CLI.When a connection between 60Ghz wireless is lost, it will automatically use the bonded interface.Example is done from empty configuration state with [WinBox] utility
1
Connect to the device step by step
After configuration reset - only mac-telnet is possible.Connect to device by connecting to it's MAC address or use WinBox New terminal to find device MAC address of the W60G device by issuing command: /ip neighbor print ------------------ ``` /ip neighbor print ``` To connect to the W60G device issue a command: /tool m...
1
Configure bridge
Add new bridge and assign bridge members to it by issuing the following command: /interface bridge add name=bridge --------------------------------- ``` /interface bridge add name=bridge ``` To check if the bridge has been created issue a command: [admin@MikroTik] > /interface bridge printFlags: X - disabled, R - runni...
1
Set up 60Ghz wireless connection
All previously explained steps are identical to Bridge and Station devices. When configuring wireless interface different modes needs to be used.For ap-bridge device - Enable W60G interface after required parameters have been set. [admin@MikroTik] > /interface w60g set wlan60-1 mode=ap-bridge frequency=auto ssid=MySSID...
1
Set up 5Ghz wireless connection
For ap-bridge device - Enable 5Ghz interface after required parameters have been set. [admin@MikroTik] > /interface wireless security-profiles set [ find default=yes ] supplicant-identity=MikroTik authentication-types=wpa2-psk mode=dynamic-keys wpa2-pre-shared-key=choosepassword[admin@MikroTik] > /interface wireless se...
1
Configure bridge for Access Point
Configure bridge for AP to ensure that 5ghz is working as fail-over. It is required to bridgewlan1,ether1, and all 60ghzstation interfaces.In the example it shows only 2 station devices but it is possible to add up to 8 devices.For ap-bridge device please setconfigurationas follows: [admin@MikroTik] >/interface bridge ...
1
Configure bridge and bonding for station devices
Configure bonding and assign slave interfaces in this setup it is selected as built in wlan1 interface, but it can be also ether interface in other kind of setups. For station-bridge devices please setbondingas: [admin@MikroTik] > /interface bonding add mode=active-backup name=bond1 primary=wlan60-1 slaves=wlan60-1,wla...
1
Additional configuration
Link should be established after all previously explained steps are done. It's recommended to set up administrator password on both devices.
1
Troubleshooting
Ensure connection is established to the correct device by checking the device settings like serial number and model name by issuing a command: [admin@MikroTik] > /system routerboard print -------------------------------------------- ``` [admin@MikroTik] > /system routerboard print ``` If bridge wlan60-1 interface in br...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Fail-over PtP CLI example
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/43057230/Fail-over+PtP+CLI+example
8
Summary
This example shows how to configure automatic fail-over (bonding) 5Ghz link in combination with 60Ghz devices in CLI.When a connection between 60Ghz wireless is lost, it will automatically use the bonded interface.Example is done from empty configuration state with [WinBox] utility
1
Connect to the device step by step
After configuration reset - only mac-telnet is possible.Connect to device by connecting to it's MAC address or use WinBox New terminal to find device MAC address of the W60G device by issuing command: /ip neighbor print ------------------ ``` /ip neighbor print ``` To connect to the W60G device issue a command: /tool m...
1
Configure bridge
Add new bridge and assign bridge members to it by issuing the following command: /interface bridge add name=bridge --------------------------------- ``` /interface bridge add name=bridge ``` To check if the bridge has been created issue a command: [admin@MikroTik] > /interface bridge printFlags: X - disabled, R - runni...
1
Set up 60Ghz wireless connection
All previously explained steps are identical to Bridge and Station devices. When configuring wireless interface different modes needs to be used.For bridge device - Enable W60G interface after required parameters have been set. [admin@MikroTik] > /interface w60g set wlan60-1 mode=bridge frequency=auto ssid=MySSID passw...
1
Set up 5Ghz wireless connection
For bridge device - Enable 5Ghz interface after required parameters have been set. [admin@MikroTik] > /interface wireless security-profiles set [ find default=yes ] supplicant-identity=MikroTik authentication-types=wpa2-psk mode=dynamic-keys wpa2-pre-shared-key=choosepassword[admin@MikroTik] > /interface wireless set w...
1
Configure bridge and bonding
Configure bonding and assign slave interfaces in this setup it is selected as built in wlan1 interface, but it can be also ether interface in other kind of setups. For bridge device please setbondingas: [admin@MikroTik] > /interface bonding add comment=bondingbackup mode=active-backup name=bond1 primary=wlan60-station-...
1
Additional configuration
Link should be established after all previously explained steps are done. It's recommended to set up administrator password on both devices.
1
Troubleshooting
Ensure connection is established to the correct device by checking the device settings like serial number and model name by issuing a command: [admin@MikroTik] > /system routerboard print -------------------------------------------- ``` [admin@MikroTik] > /system routerboard print ``` If bridge wlan60-1 interface in br...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Fail-over PtP GUI example
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/43843592/Fail-over+PtP+GUI+example
8
Summary
This example shows how to configure automatic fail-over (bonding) 5Ghz link in combination with 60Ghz devices in GUI.When a connection between 60Ghz wireless is lost, it will automatically use the bonded interface.Example is done from empty configuration state with [WinBox] utility
1
Connect to the device
After configuration reset - only mac-telnet is possible. In main WinBox screen press on Neighbours, choose your devices MAC address and press Connect:
1
Configure bridge
Add new bridge. Later in the instructions it requires to assign bridge members to it. This will allow to pass traffic from Ethernet to W60G interface without routing.
1
Set up 60Ghz wireless connection
All previously explained steps are identical tobridgeandstationdevices. Different modes needs to be used when configuring wireless interfaces. Configurebridgedevice as follows: Configurestationdevice as follows:
1
Set up 5Ghz wireless connection
Choose Security Profile for your devices - For bridge device - For station device - If everything is done correctly - running (R) flags should appear as shown in the screenshot -
1
Configure bonding
Configure bonding and assign slave interfaces in this setup it is selected as built in wlan1 interface, but it can be also ether interface in other kind of setups. For bridge device - For station device -
1
Configure bridge
Configuring bridge settings including the bonding interface is mandatory for the active-backup to work on used devices ( In this case bridge and station devices settings are the same ).
1
Additional configuration
Interfaces when enabled from greyed out will become active. Link should be established after all previously explained steps are done. It's recommended to set up administrator password on both devices.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Failover (WAN Backup)
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/26476608/Failover+WAN+Backup
5
Introduction
In this article, we will look at another advanced method of failover using recursive routing and scopes from the routing section. Recursive routing occurs when a route (either static or dynamically learned) has a next-hop that is not directly connected to the local router. It is necessary to restrict a set of routes th...
1
Setup Overview
Let's assume that our gateway has two public network uplinks ("ISP1", "ISP2"). First uplink should be preferred and second one should act as a backup. Then we mark traffic in two parts, one with the name "ISP1" and the second as "ISP2" which goes through the ether1 and ether2 accordingly. In this setup, we want to moni...
1
Configuration
1
Basic failover
First things first, since we have a local address space we need to masquerade LAN traffic on both uplinks: ``` /ip/firewall/nat add chain=srcnat action=masquerade out-interface=ether1 add chain=srcnat action=masquerade out-interface=ether2 ``` Next we want to pick tow hosts on the internet and make them reachable each ...
1
Improve detection reliability
At this point we are relying link reachability on a single host. Even though google services are very rarely down we can still improve reliability by adding a second host on each link. ``` /ip/route add dst-address=208.67.222.222 gateway=10.111.0.1 scope=10 add dst-address=208.67.220.220 gateway=10.112.0.1 scope=10 add...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Feature support based on architecture
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/146440194/Feature+support+based+on+architecture
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Fetch
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/8978514/Fetch
6
Summary
Fetch is one of the console tools in MikroTik RouterOS. It is used to copy files to/from a network device via HTTP, HTTPS, FTP or SFTP. It can also be used to send POST/GET requests and send any kind of data to a remote server. In HTTPS mode by default, no certificate checks are made, settingcheck-certificatetoyesenabl...
1
Properties
Property | Description ---------------------- address(string; Default: ) | IP address of the device to copy file from. Also at the end of the address you can specify "@vrf_name" in order to run fetch on particular VRF. You can skip specifying address and specify only VRF on this parameter, if you use URL parameter. as-...
1
Configuration Examples
The following example shows how to copy the file with filename "conf.rsc" from a device with ip address 192.168.88.2 by FTP protocol and save it as file with filename "123.rsc". User and password are needed to login into the device. ``` [admin@MikroTik] /tool> fetch address=192.168.88.2 src-path=conf.rsc \ user=admin m...
1
NAME TYPE SIZE CREATION-TIME
... 5 netaddresses2.pdf .pdf file 11547 jun/01/2010 11:59:51 ```
1
Sending information to a remote host
It is possible to use an HTTP POST request to send information to a remote server, that is prepared to accept it. In the following example, we send geographic coordinates to a PHP page: ``` /tool/fetch http-method=post http-header-field="Content-Type:application/json" http-data="{\"lat\":\"56.12\",\"lon\":\"25.12\"}" u...
1
Return value to a variable
It is possible to save the result of the fetch command to a variable. For example, it is possible to trigger a certain action based on the result that an HTTP page returns. You can find a very simple example below that disablesether2whenever a PHP page returns "0": ``` { :local result [/tool fetch url=https://10.0.0.1/...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Files
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/2555971/Files
7
2Overview3Create new file or directory3.1Properties4Properties5Get file contents5.1Properties
1
Overview
File menu shows all user space files on the router. It is possible to create a new file, directory, edit file content, delete file or directory.  If RouterOS ".npk" package is uploaded, the file menu will also show package-specific information, for example, architecture, build date and time, etc. ``` [admin@MikroTik] >...
1
Create new file or directory
To create a new file or directory: ``` [admin@MikroTik] > file add name=/flash/filename type=file [admin@MikroTik] > file add name=/flash/directory_name type=directory ```
1
Properties
Property | Description ---------------------- contents(string; Default: ) | File contents that must be added. Works only fortype=file name(string; Default: ) | File/directory name type(file | directory;Default:file) | Specifies type
1
Properties
Property | Description ---------------------- contents(string; Default: ) | The actual content of the file creation-time(time) | A time when the file was created last-modified(time) | The time when the file was created or last modified. Introduced instead ofcreation-timein RouterOS 7.16. name(string) | Name of the file...
1
Get file contents
Using thegetcommand, it is possible to retrieve file contents only from files up to 60KB in size. For accessing contents of larger files, use commandread. The result is returned as an array. For example: ``` [admin@MikroTik] > :put [/file/get text.txt contents] 123456 [admin@MikroTik] > /file/read file=text.txt offset=...
1
Properties
Property | Description ---------------------- chunk-size(integer [1..32768]; Default: ) | Chunk size that will be read from file file(string; Default: ) | File name from which to read offset(integer;Default:) | Specifies offset where to start read file
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
File share
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/295239888/File+share
5
Adding shares
First, attach your USB drive and determine the file path of the directory you want to share: ``` [user@RouterOS] > file/print
1
NAME TYPE SIZE LAST-MODIFIED
0 web directory 2025-01-23 09:29:42 1 usb1 disk 2025-01-22 09:45:57 2 pub ...
1
PATH URL DIRECT-URL EXPIRES DOWNLOADS
0 /usb1/Secret Files https://acf017skgys.routingthecloud.net/s/4MPgHbEZCZYGVtp https://acf017skgys.routingthecloud.net/s/4MPgHbEZCZYGVtp?dl never 5 1 /usb1/Secrets https://acf017skgys.routingthecloud.net/s/K8zkh1UjKuqtEQ0 https://acf017skgys.routingthecloud.net/s/K8zkh1UjKuqtEQ0?dl never ...
1
WinBox GUI
To share the file, access the "File Shares" menu located under the IP → Cloud "Configuration" section. To create a new share, set the "Path", "Expires" and "Auto uploads" options. ``` [admin@MikroTik] > ip/cloud/file-share/print detail Flags: X - disabled; I - invalid 0 path=/mypath/myfile allow-uploads=no expires=2...
1
Relay service
If device is not directly accessible from the internet, it will choose to use the MikroTik hosted Relay service. * Relay has no way of decrypting your data, because certificate with private key is on the router only
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Filter
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/48660574/Filter
13
Introduction
Firewall filters are used to allow or block specific packets forwarded to your local network, originating from your router, or destined to the router. There are two methods on how to set up filtering: Both methods have pros and cons, for example, from a security point of view first method is much more secure, but requi...
1
Firewall Example
Lets look at basic firewall example to protect router itself and clients behind the router, for both IPv4 and IPv6 protocols.
1
IPv4 firewall
1
Protect the router itself
Rules of thumb followed to set up the firewall: ``` new ``` ``` drop ``` ``` log=yes ``` We always start by accepting already known and accepted connections, so the first rule should be to accept "established" and "related" connections. ``` /ip firewall filter add action=accept chain=input comment="default configuratio...
1
Protect the LAN devices
Concept in protecting the users is very similar, except that in this case we are blocking unwanted traffic and accepting everythign else. At first we will createaddress-listwith the name "not_in_internet" which we will use for the firewall filter rules: ``` address-list ``` ``` /ip firewall address-list add address=0.0...
1
IPv6 firewall
1
Protect the router itself
Very similar to IPv4 setup, except that we have to deal with more protocols required for IPv6 to function properly. At first we create anaddress-listfrom which you allow access to the device: ``` address-list ``` ``` /ipv6 firewall address-list add address=fd12:672e:6f65:8899::/64 list=allowed ``` Brief IPv6 firewall f...
1
Protect the LAN devices
This step is more important than it is for IPv4. In IPv4 setups clients mostly have addresses from local address range and are NATed to public IP, that way they are not directly reachable from the public networks. IPv6 is a different story. In most common setups, enabled IPv6 makes your clients available from the publi...
1
Matchers
All matcher properties are common and listedhere.
1
Actions
Tables below shows list of filter specific actions and associated properties.  Other actions arelistedhere. Property | Description ---------------------- action(action name; Default:accept) | drop- silently drop the packetfasttrack-connection- process packets from a connection using FastPath by enablingFastTrackfor the...
1
RAW Filtering
The firewall RAW table allows to selectively bypass or drop packets before connection tracking, that way significantly reducing the load on the CPU. The tool is very useful for DoS/DDoS attack mitigation. RAW filter configuration is accessible fromip/firewall/rawmenu for IPv4 andipv6/firewall/rawmenu for IPv6. ``` ip/f...
1
Basic RAW Example
Let's assume that we have OSPF configuration, but due to connection tracking OSPF have adjacency problems. We can use RAW rules to fix this, by not sending OSPF packets to connection tracking. ``` /ip firewall raw add chain=prerouting protocol=ospf action=notrack add chain=output protocol=ospf action=notrack ```
1
Read More
* Syn/DoS protection
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Firewall
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/250708066/Firewall
1
Chains
Firewall filtering rules are grouped together in chains. It allows a packet to be matched against one common criterion in one chain, and then passed over for processing against some other common criteria to another chain. For example, a packet should be matched against the IP address:port pair. Of course, it could be a...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Firewall and QoS Case Studies
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/120324137/Firewall+and+QoS+Case+Studies
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Firewall and Quality of Service
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/119144601/Firewall+and+Quality+of+Service
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
First Time Configuration
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/328151/First+Time+Configuration
23
Connecting to the Router
There are two types of routers: For additional details regarding the current default configuration, please refer to the Quick Guide document provided with your device. This document outlines which ports to initially utilize for connection and instructions on device setup. This document describesthe step-by-step process...
1
Router without Default Configuration
If the router doesn't have a default configuration, there are multiple options to consider. However, in this case, we'll opt for a method that best fits our requirements. Connect the ISP cable tothe router's ether1 port and connect your PCto any port except ether1.Then, launch WinBox and search for your router using th...
1
Configuring IP Access
As MAC connection can sometimes be unreliable, our first step is to configure the router to enable IP connectivity: Setting up the bridge and assigning an IP address are straightforward processes: ``` /interface bridge add name=bridge1 /interface bridge port add interface=ether2 bridge=bridge1 /ip address add address=1...
1
Configuring Internet Connection
To enable internet access for the router, you'll need to configure one of the following common types of internet connections:
1
Dynamic Public IP
Dynamic address configuration is the easiest option. Simply set up a DHCP client on the public interface. The DHCP client will obtain information from your Internet Service Provider (ISP), such as an IP address, DNS servers, NTP servers, and default route, making the setup process straightforward for you. ``` /ip dhcp-...
1
INTERFACE USE-PEER-DNS ADD-DEFAULT-ROUTE STATUS ADDRESS
0 ether1 yes yes bound   1.2.3.100/24 ```
1
Static Public IP
When configuring a static address, your ISP provides specific parameters, such as: These are three basic parameters that you need to get the internet connection working. To configure this in RouterOS, we'll manuallyadd an IP address, add a default route with a provided gateway, and set up a DNS server ``` /ip address a...
1
PPPoE Connection
PPPoE connection also gives you a dynamic IP address and can configure dynamically DNS and default gateway. Typically service provider (ISP) gives you a username and password for the connection ``` /interface pppoe-client add disabled=no interface=ether1 user=me password=123 \ add-default-route=yes use-peer-dns=yes ```...
1
Verify Connectivity
Once the configuration is complete, you should be able to access the internet from the router.To verify IP connectivity, try pinging a known IP address, such as a Google DNS server. ``` [admin@MikroTik] > /ping 8.8.8.8 SEQ HOST SIZE TTL TIME STATUS 0 8.8.8.8 ...
1
Protecting the Router
As the router is now accessible worldwide, it's important to protect it from potential intruders and basic attacks.
1
User Password Access
For MikroTik routers, it's essential to set up passwords. We recommend using a password generator tool to create robust passwords that meet the following criteria: ``` /user set 0 password="!={Ba3N!40TуX+GvKBzjTLIUcx/," ``` Another method to set a password for the current user: ``` /password ``` We highly recommend usi...
1
MAC Connectivity Access
By default, the MAC server runs onallinterfaces. To restrict MAC connectivity from the WAN port, we'll disable the default all entry and add a LAN interface. First, create an interface list: ``` [admin@MikroTik] > /interface list add name=LAN ``` Then, add your previously created bridge named "bridge1" to the interface...
1
Neighbor Discovery
MikroTik Neighbor discovery protocol is used to show and recognize other MikroTik routers in the network. Disable neighbor discovery on public interfaces: ``` /ip neighbor discovery-settings set discover-interface-list=LAN ```
1
IP Connectivity Access
While the firewall protects your router from unauthorized access by external networks, it's also possible to restrict username access based on specific IP addresses ``` /user set 0 address=x.x.x.x/yy ``` x.x.x.x/yy - your IP or network subnet that is allowed to access your router. IP connectivity on the public interfac...
1
Administrative Services
Although the firewall protects the router from the public interface, you may still want to disable RouterOS services. Most of RouterOS administrative tools are configured at  the/ip servicemenu Keep only secure ones, ``` /ip service disable telnet,ftp,www,api ``` Change default service ports, this will immediately stop...
1
Other Services
A bandwidth server is used to test throughput between two MikroTik routers. Disable it in the production environment. ``` /tool bandwidth-server set enabled=no ``` A router might have DNS cache enabled, which decreases resolving time for DNS requests from clients to remote servers. In case DNS cache is not required on ...
1
NAT Configuration
At this point, PC is not yet able to access the Internet, because locally used addresses are not routable over the Internet. Remote hosts simply do not know how to correctly reply to your local address. The solution for this problem is to change the source address for outgoing packets to routers public IP. This can be ...
1
Port Forwarding
Some client devices may need direct access to the internet over specific ports. For example, a client with an IP address 192.168.88.254 must be accessible by Remote desktop protocol (RDP). After a quick search on Google, we find out that RDP runs on TCP port 3389. Now we can add a destination NAT rule to redirect RDP t...
1
Setting up Wireless
For ease of use bridged wireless setup will be made so that your wired hosts are in the same Ethernet broadcast domain as wireless clients. The important part is to make sure that our wireless is protected, so the first step is the security profile. Security profiles are configured from/interface wireless security-prof...
1
Protecting the Clients
Now it is time to add some protection for clients on our LAN. We will start with a basic set of rules. ``` /ip firewall filter add chain=forward action=fasttrack-connection connection-state=established,related \ comment="fast-track for established,related"; add chain=forward action=accept connection-state=established,r...
1
Blocking Unwanted Websites
Sometimes you may want to block certain websites, for example, deny access to entertainment sites for employees, deny access to porn, and so on. This can be achieved by redirecting HTTP traffic to a proxy server and use an access-list to allow or deny certain websites. First, we need to add a NAT rule to redirect HTTP ...
1
Troubleshooting
RouterOS has built-in various troubleshooting tools, like ping, traceroute, torch, packet sniffer, bandwidth test, etc. We already used the ping tool in this article toverify internet connectivity.
1
Troubleshoot if ping fails
The problem with the ping tool is that it says only that destination isunreachable, but no more detailed information is available. Let's overview the basic mistakes. You cannot reachwww.google.comfrom your computer which is connected to a MikroTik device:
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
FlashFig
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/139526145/FlashFig
13
Description
FlashFig is an application for mass router configuration. It can be used by MikroTik distributors, ISPs, or any other companies who need to apply RouterOS configuration to many routers in the shortest possible time. FlashFig applies MikroTik RouterOSconfigurationto any RouterBOARD within3 seconds. You can perform Flash...
1
FlashFig Example
This is a step-by-step example of how to use the FlashFig process to apply a chosen MikroTik RouterOS configuration to a 'factory fresh' RouterBOARD.
1
Requirements
The Windows computer must be equipped with the following ports and contain the following files:
1
Pre-Configuration
1
Windows Computer
1
RouterBOARD
``` system/routerboard/settings/set boot-device=flash-boot ``` Or use a more preferable option, for a single boot flash-boot: ``` system/routerboard/settings/set boot-device=flash-boot-once-then-nand ``` Your router is now ready for FlashFig.
1
Connect
Connect theBootport of RouterBOARD and FlashFig computer to the same Local Area Network.
1
Run FlashFig
Messages log shows "FlashFigged" and RouterBOARD should repeatedly make the morse code sound for the character "/" ("_.._." and flash the LED - it is now safe to unplug / power down the router.
1
Troubleshoot
1
FlashFig can not find a router
If between a PC and a router there is another device (a router/switch), ensure that for this device:
1
FlashFigfinds a router, flashing is not done (no TFTP request)
Ensure that the computer on which FlashFig is running has only one network interface active.
1
FlashFig is done, but a configuration is not applied
If all procedures went successfully, but RouterOS configuration from .rsc file is not applied, addstartup delayto *.rsc configuration file. The reason might be, that the configuration script is executed before all interfaces boots up.
1
Not enough flash space, ignoring
FlashFig configuration maximum file size is up to 4000 bytes, otherwise program will return an error as above.
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
General Properties
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/16351619/General+Properties
11
Properties
This menu is used to apply settings to the LoRa interface. Sub-menu:/iot lora ``` /iot lora ``` Property | Description ---------------------- antenna-gain(integer [-128..127]; Default:0) | Antenna gain in dBi. This value should be equal tosetup-antenna-gainminuscable-loss. Using 6.5 dBi antenna, 6.5 is the value to be ...
1
Channels
This section is used to alter channel/frequency related settings. Sub-menu:/iot lora channels ``` /iot lora channels ``` Property | Description ---------------------- bandwidth(7.8_kHz | 15.6_kHz | 31.2_kHz | 62.5_kHz | 125_kHz | 250_kHz | 500_kHz; Default:125_kHz) | Bandwidth of specific channel, predefined when any o...
1
NAME TYPE RADIO FREQ-OFF BANDWIDTH FREQ SPREAD-FACTOR DATARATE
0 gateway-0 MSF radio1 -400000 125_kHz 868.1 1 gateway-0 MSF radio1 -200000 125_kHz 868.3 2 gateway-0 MSF radio1 0 125_kHz 868.5 3 gateway-0 MSF radio0 -400000 125_kHz 867.1 4 gateway-0 MSF radio0 -200000 125_kHz 867.3 5 gateway-0 MSF radio0 0 125_kHz 86...
1
NAME TYPE RADIO FREQ-OFF BANDWIDTH FREQ SPREAD-FACTOR DATARATE
0 gateway-0 MSF radio1 -400000 125_kHz 868.1 ``` radio1is selected to be used for channel # 0 and it is configured withcenter-freq=868500000(868500000 Hz or 868.5 MHz). ``` radio1 ``` ``` center-freq=868500000 ``` By using frequency offset,freq-off=-400000(-400000 Hz or -0.4 MHz), we define channel # 0 to be86...
1
Join EUI
The gateway will forward to the server every single LoRaWAN payload it receives. That includes neighboring LoRaWAN node's payloads as well. It might not be ideal to forward everything, as, for example, it can increase the data amount used (and directly impact ISP plan cost). The Join EUI menu allows you to specify a ra...
1
Network ID
The gateway will forward to the server every single LoRaWAN payload it receives. That includes neighboring LoRaWAN node's payloads as well. It might not be ideal to forward everything, as, for example, it can increase the data amount used (and directly impact ISP plan cost). The NetID menu allows you to specify a list ...
1
Servers
This section is used to add new or alter current server settings. Sub-menu:/iot lora servers ``` /iot lora servers ``` There are a few predefined servers that can be used (it requires to make anThe Things Networkaccount to use them): ``` [admin@MikroTik] /iot/lora/servers/print Columns: NAME, UP-PORT, DOWN-PORT, ADDRES...
1
NAME UP-PORT DOWN-PORT ADDRESS
0 TTS Cloud (eu1) 1700 1700 eu1.cloud.thethings.industries 1 TTS Cloud (nam1) 1700 1700 nam1.cloud.thethings.industries 2 TTS Cloud (au1) 1700 1700 au1.cloud.thethings.industries 3 TTN V3 (eu1) 1700 1700 eu1.cloud.thethings.network 4 TTN V3 (nam1) 1700 ...
1
Traffic
This section displays LoRa payloads that were broadcasted by the surrounding nodes. Sub-menu:/iot lora traffic ``` /iot lora traffic ``` To view the list, use theprintcommand: ``` print ``` ``` [admin@MikroTik] /iot/lora/traffic/print Columns: TIME, GWID, MSGTYPE, DEVADDR, MVER, FCNT, CRC, TYPE, JOINEUI, DEVEUI
1
TIME GWID MSGTYPE DEVADDR MVER FCNT CRC TY JOINEUI DEVEUI
0 2024-11-08 13:33:28  xxxxxxxxxxxxxxxx  Unconfirmed Data Up 6C B9 XX XX LoRaWAN R1 59434 Error Rx 1 2024-11-08 13:33:50  xxxxxxxxxxxxxxxx  Rejoin-request LoRaWAN R1 Error Rx 50 62 9F FE XX XX XX XX 2 2024-11-08 13:34:09  xxxxxxxxxxxxxxxx  Unconfirmed Da...
1
Debugging
If you have issues with the connection, make sure to enable logs: ``` /system/logging/add topics=debug,lora ``` This will enable debug logging and help you pin point where the potential issue could be. Logs can be viewed using: ``` /log/print ``` A successful connection would look like this: ``` 13:50:33 lora,info gate...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
GPIO
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/68944101/GPIO
13
RouterOS configuration
note:GPIO settings are available only using CLI. Sub-menu:/iot gpio ``` /iot gpio ``` GPIO settings are divided into: note:in our examples, we are usingKNOTas a reference device. Other devices may have a different pinout but the same principles apply.
1
/iot gpio analog
``` [admin@device] /iot gpio analog> print
1
NAME VALUE OFFSET
0 pin2 0mV 0mV 1 pin3 32mV 0mV ``` "OFFSET" can be used to manually compensate voltage drop on the wires. "VALUE" is measured with:...
1
NAME VALUE OFFSET
0 pin2 2mV 2mV 1 pin3 0mV 0mV ```
1
/iot gpio digital
In the "digital" section you can send/receive a logical 0 or 1 signal using the digital output/input pins (output pins are "open drain"): ``` [admin@device] /iot gpio digital> print Flags: X - disabled
1
NAME DIRECTION OUTPUT INPUT SCRIPT
0 pin5 input 0 0 1 pin4 output 0 2 pin6 output 0 ``` "DIRECTION" for the pin can be either "input" (a pin that can receive the signal) or "output" (a pin that can send the signal). W...
1
NAME DIRECTION OUTPUT INPUT SCRIPT
0 pin5 input 0 0 1 pin4 output 1 2 pin6 output 0 ``` The "SCRIPT" field allows you to configure a script, that will be initiated whenever the "INPUT" or "OUTPUT" value changes (from ...
1
NAME DIRECTION OUTPUT INPUT SCRIPT
0 pin5 input 0 0 /system .. 1 pin4 output 1 script1 2 pin6 output 0 ```
1
Different scenarios
1
Controlling relays
One of the scenarios for the GPIO implementation is "controlling other relays" using digital output pins. Basically, sending "0" or "1" signal to the unit that is connected to the pin. To automate the process, you can use ascheduler, which will run the script at specific times. For example, you can add the firstscript(...
1
Monitoring input signal
Another scenario is to "monitor input signal" using the digital input pins. You need a script that will initiate e-mail notification or MQTT/HTTPS (fetch) publish whenever the "INPUT" value changes for the pin with the direction="input" (whenever the RouterOS device receives a signal "0 or 1" from another device connec...
1
NAME DIRECTION OUTPUT INPUT SCRIPT
0 pin5 input 0 0 script1 1 pin4 output 0 script1 2 pin6 output 0 ``` In the example above, the e-mail notification script is named "script1". As a result, whenever the input value changes (from 0 to 1 or from 1 to 0), the sc...
1
Monitoring voltage
Last but not least - is to "monitor voltage" using the analog pins.  You need a script that will read/monitor voltage on schedule and then send the data via e-mail, MQTT or HTTPS (fetch). Create a script, as shown below. In this example, we will be using MQTT publish (but you can create a similar script with "/tool e-m...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
GPS
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/84901890/GPS
7
Summary
Package requirement:gpsSub-menu:/system gpsStandards:GPS, NMEA 0183,Simple Text Output Protocol ``` gps ``` ``` /system gps ``` ``` GPS, NMEA 0183,Simple Text Output Protocol ``` Global Positioning System (GPS) is used for determining the precise location of a GPS receiver.
1
Configuration Properties
Property | Description ---------------------- channel(integer [0..4294967295]; Default:0) | Port channel used by the device coordinate-format(dd | dms | ddmm; Default:no) | Which coordinate format to use, "Decimal Degrees", "Degrees Minutes Seconds" or "NMEA format DDDMM.MM[MM]" enabled(yes | no; Default:no) | Whether ...
1
Monitoring Status
Command:/system gps monitor ``` /system gps monitor ``` This command is used for monitoring the data received from a GPS receiver. Parameters: Property | Description ---------------------- date-and-time(date) | Date and time received from GPS latitude(none | string) | Latitude in DM (Degrees Minute decimal) format long...
1
Basic examples
Check port usage, as only one instance can use the serial port simultaneously: ``` [admin@MikroTik] /port print Flags: I - inactive
1
DEVICE NAME CHANNELS USED-BY BAUD-RATE
0 serial0 1 Serial Console auto ``` In case there is one port and it is used by the console, release it from the console menu: ``` [admin@MikroTik] > /system console print Flags: X - disabled, U - used, F - free
1
PORT TERM
0 U serial0 vt102 [admin@MikroTik] > /system console disable 0 ``` Adjust port settings specifically for your device (leave "auto" for LtAP mini): ``` [admin@MikroTik] /port> set 0 baud-rate=4800 parity=odd [admin@MikroTik] /port> print detail Flags: I ...
1
Troubleshooting
Note that sometimes to make the GPS module recognized in RouterOS you need to change the baud-rate setting in the '/port' menu. ``` /port ``` LtAP minihas a low-gain GPS antenna built-in and for a better experience, we suggest using an additionalexternal antenna. Switch between internal and external antennas under the ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
GPS-tracking using HTTP POST
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/84901903/GPS-tracking+using+HTTP+POST
4
Method
This approach uses HTTP POST capability of RouterOS Fetch tool. It allows you to POST any kind of data to a webserver, right from the RouterOS command line. Of course, you can use scripting, to fill the POST data with variables. The posted data will be written to an SQLITE3 database (file is created, if it doesn't exis...
1
Requirements
1
RouterOS script
You can run this script in the Scheduler tool, with an interval of 1s, to have your coordinates sent every 1 second. ``` { :global lat :global lon /system gps monitor once do={ :set $lat $("latitude") :set $lon $("longitude") } tool fetch mode=http url="http://YOURSERVER.com/index.php" port=80 http-method=post http-dat...
1
index.php file
Create an empty directory calledsqlite_dbnext to the index.php file. Make sure that directory and files are writable by the group withchmod -R a+w sqlite_db/ ``` <?php $loc = dirname(__FILE__).'/sqlite_db/coord.db'; $db = new SQLite3($loc,SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE); $raw = file_get_contents('php://in...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
GPS-tracking using MQTT and ThingsBoard
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/166920428/GPS-tracking+using+MQTT+and+ThingsBoard
7
Introduction
Many RouterOS devices haveGPSsupport. It allows RouterOS to determine the precise location of its GPS receiver. GPS coordinates will indicate the latitude and the longitude values (among other parameters) of the current position. Let's say, you haveLTAP(or any other RouterOS device with GPS support) and you wish to tra...
1
Configuration
In this guide, we will demonstrate how to configure a GPS receiver (MQTT publisher) and how to set up ThingsBoard. In case you want to use the container feature to run the ThingsBoard instance (MQTT broker), check the guideover here. General guidelines on ThingsBoard and MQTT configuration can be found in the guideover...
1
ThingsBoard preparation
Navigate to the "Devices" menu and add a new device via the "Add new device" button → name it and create it (for example, LTAP): Click on the device you've just added, go to the "Details" section, and generate an access token under the "Manage credentials/Device Credentials" setting:
1
MQTT broker configuration
In case it is a local test or the broker is available through the VPN, you can use non-SSL MQTT: ``` /iot/mqtt/brokers/add name=tb address=x.x.x.x port=1883 username=access_token ``` Where: ``` name ``` ``` address ``` ``` port ``` ``` username ``` In case it is public access (when you want to access the broker via its...
1
MQTT publish
You can test MQTT publish with a static message by using the command: ``` /iot/mqtt/publish broker="tb" topic="v1/devices/me/telemetry" message="{\"test\":\"123\"}" ``` To post GPS coordinates, import the script shown below: ``` /system/script/add dont-require-permissions=no name=mqttgps owner=admin policy="ftp,re\ boo...
1
Result verification
Go the the "Latest telemetry" section under your created device and confirm that the data was posted:
1
Data visualization using maps
ThingsBoard allows you to useWidgetsto create visually appealing dashboards. In our case, we want to track our LTAP GPS coordinates, so we will need a map widget. Select the latitude and longitude values and click on the "Show on widget" button: Find the "Maps" bundle and click on the "Add to dashboard": Select an exis...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Graphing
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/22773810/Graphing
8
2Summary3Configuration3.1General3.2Interface graphing3.3Queue graphing3.4Resource graphing4Graphing in WinBox
1
Summary
Graphing is a tool to monitor various RouterOS parameters over time and put collected data in graphs.Watch ourvideo about this feature. The Graphing tool can display graphics for: Graphing consists of two parts - the first part collects information and the other part displays data on a Web page. To access the graphics,...
1
Configuration
1
General
The configuration is done under "/tool graphing" menu, by default, graphing is disabled. You can configure graphing for interfaces, resources, and simple queues in their respective submenus. Sub-menu:/tool graphing ``` /tool graphing ``` Property | Description ---------------------- store-every(24hours | 5min | hour; D...
1
Interface graphing
Sub-menu allows configuration for which interface graphing will collect bandwidth usage data. Sub-menu:/tool graphing interface ``` /tool graphing interface ``` Property | Description ---------------------- allow-address(IP/IPv6 prefix; Default:0.0.0.0/0) | IP address range from which is allowed to access graphing info...
1
Queue graphing
Sub-menu allows configuration for which simple queue graphing will collect bandwidth usage data. Sub-menu:/tool graphing queue ``` /tool graphing queue ``` Property | Description ---------------------- allow-address(IP/IPv6 prefix; Default:0.0.0.0/0) | IP address range from which is allowed to access graphing informati...
1
Resource graphing
Sub-menu allows to enable graphing of system resources. Graphing collects data of: Sub-menu:/tool graphing resource ``` /tool graphing resource ``` Property | Description ---------------------- allow-address(IP/IPv6 prefix; Default:0.0.0.0/0) | IP address range from which is allowed to access graphing information comme...
1
Graphing in WinBox
Winbox allows viewing the same collected information as on the web page. OpenTools->Graphingwindow. Double click on the entry of which you want to see graphs. The image below shows WinBox graphs of memory usage:
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
GRE
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/24805531/GRE
3
Introduction
Sub-menu:/interface greStandards:RFC1701 ``` /interface gre ``` GRE (Generic Routing Encapsulation) is a tunneling protocol that was originally developed by Cisco. It can encapsulate a wide variety of protocols creating a virtual point-to-point link. GRE is the same asIPIPandEoIPwhich were originally developed as state...
1
Properties
Property | Description ---------------------- allow-fast-path(yes | no; Default:yes) | Whether to allow FastPath processing. Must be disabled if IPsec tunneling is used. clamp-tcp-mss(yes | no; Default:yes) | Controls whether to change MSS size for received TCP SYN packets. When enabled, a router will change the MSS si...
1
Setup example
The goal of this example is to get Layer 3 connectivity between two remote sites over the internet We have two sites,Site1with local network range 10.1.101.0/24 andSite2with local network range 10.1.202.0/24. The first step is to create GRE tunnels. A router on site 1: ``` /interface gre add name=myGre remote-address=1...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Grounding
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/53444613/Grounding
3
Introduction
Shielded cable installation infrastructure (towers and masts), as well as antennas and the router itself, must be properly grounded. Lightning arresters must be installed on all external antenna cables (near the antennas or on the antennas themselves) to prevent equipment damage and human injury. Note that lightning ar...
1
Shielded RJ45 Port vs Unshielded RJ45 Port
Device with Shielded Ports: Device with Unshielded Ports:
1
PoE injectorwith shielded connectors:
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Group Management Protocol
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/131366949/Group+Management+Protocol
3
Introduction
The Group Management Protocol allows any of the interfaces to become a receiver for the multicast stream. It allows testing the multicast routing and switching setups without using dedicated IGMP or MLD clients. The option is available since RouterOS v7.4 and it supports IGMP v1, v2, v3 and MLD v1, v2 protocols. Interf...
1
Configuration options
This section describes the Group Management Protocol configuration options. Sub-menu:/routing gmp ``` /routing gmp ``` Property | Description ---------------------- groups(IPv4 | IPv6; Default: ) | The multicast group address to be used by the interface, multiple group addresses are supported. interfaces(name; Default:...
1
Examples
This example shows how to configure a simple multicast listener on the interface. First, add an IP address on the interface: ``` /ip address add address=192.168.10.10/24 interface=ether1 network=192.168.10.0 ``` Then configure Group Management Protocol on the same interface: ``` /routing gmp add groups=229.1.1.1 interf...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Hardware
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/13500445/Hardware
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
HA Case Studies
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/128221209/HA+Case+Studies
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Health
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/25690117/Health
9
1Summary2Voltage3Temperature4Fan control and behavior4.1PoE-out consumption4.2Limited manual fan-control option4.3Brief description of the fan-controlSummary
Hardware that supports monitoring will display different information about hardware status, like temperature, voltage, current, fan-speed, etc. Example on CCR1072-1G-8S+ device: ``` [admin@MikroTik] > system/health/print Columns: NAME, VALUE, TYPE
1
NAME VALUE TYPE
0 power-consumption 50.8 W 1 cpu-temperature 43 C 2 fan1-speed 5654 RPM 3 fan2-speed 5825 RPM 4 fan3-speed 5800 RPM 5 fan4-speed 5750 RPM 6 board-temperature1 29 C 7 board-temperature2 28 C 8 psu1-voltage 0 V 9 psu2-voltage 1...
1
Voltage
Routers that support voltage monitoring will display supplied voltage value. In CLI/Winbox it will display volts. In scripts/API/SNMP this will be dV or value showed in CLI/Winbox Note:Routers that have PEXT and PoE power input are calibrated using PEXT, as a result, value showed over PoE can be lower than input voltag...
1
NAME VALUE TYPE
0 voltage 23.8 V 1 temperature 39 C ```
1
Temperature
Routers that support temperature monitoring will display temperature reading. In CLI/Winbox it will display degrees Celsius. Using scripts/API/SNMP this value will be shown in CLI/Winbox multiplied by 10. There are various temperature sensors depending on the device. These sensors may refer to: cpu-temperature, pcb-tem...
1
Fan control and behavior
``` /system health set ``` Using this menu users will be able to control fan behaviour on TILE architecturedevices. Note:Improved FAN stability starting from version 6.45.5. There are three parameters that may affect fan behaviour: PoE-out consumption, SFP temperature and CPU temperature. As soon as one of the paramete...
1
PoE-out consumption
If a device has PoE-out, then the fan RPM will change as described below: PoE-out load | RPM % of max FAN speed ------------------------------------- 0%..24% | FAN speed 0% 25%..46% | FAN speed 25% 47%..70% | FAN speed 50% 71%..92% | FAN speed 75% 93%.. | FAN speed 100% RPM % of max FAN speed For devices withPWMfans, t...
1
Limited manual fan-control option
Note:Starting from RouterOS version 7.9 limited manual fan-control options have been added for CRS3xx, CRS5xx and CCR2xxx devices. Note:Starting from RouterOS version 7.14 limited manual fan-control is available for the CCR1036-8G-2S+-r2, CCR1036-12G-4S-r2 and CCR1016-12S-1S+-r2 devices. Fan behavior can be manipulated...
1
Brief description of the fan-control
If at least one of the internal measured (CPU, SFP, Switch, Board etc.) temperatures exceedfan-target-temp, the fans will start to spin. The higher the temperature, the faster the fans will spin. For devices with PWM fans, as the internal measured temperatures exceedfan-target-temp, the fans will linearly increase thei...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
High Availability Solutions
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/120324133/High+Availability+Solutions
0
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
HotSpot - Captive portal
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/56459266/HotSpot+-+Captive+portal
13
Introduction
The MikroTik HotSpot Gateway provides authentication for clients before access to public networks.
1
HotSpot Gateway features:
A hotspot can work reliably only when IPv4 is used. Hotspot relies on Firewall NAT rules which currently are not supported for IPv6.
1
Example
``` [admin@MikroTik] /ip hotspot> setup Select interface to run HotSpot on hotspot interface: ether3 Set HotSpot address for interface local address of network: 10.5.50.1/24 masquerade network: yes Set pool for HotSpot addresses address pool of network: 10.5.50.2-10.5.50.254 Select hotspot SSL certificate select certif...
1
NAME INTERFACE ADDRESS-POOL PROFILE IDLE-TIMEOUT
0 hotspot1 ether3 hs-pool-3 hsprof1 5m [admin@MikroTik] /ip hotspot> [admin@MikroTik] /ip pool> print
1
NAME RANGES
0 hs-pool-3 10.5.50.2-10.5.50.254 [admin@MikroTik] /ip pool> /ip dhcp-server [admin@MikroTik] /ip dhcp-server> print Flags: X - disabled, I - invalid
1
NAME INTERFACE RELAY ADDRESS-POOL LEASE-TIME ADD-ARP
0 dhcp1 ether3 hs-pool-3 1h [admin@MikroTik] /ip dhcp-server> /ip firewall nat [admin@MikroTik] /ip firewall nat> print Flags: X - disabled, I - invalid, D - dynamic 0 X ;;; place hotspot rules here chain=unused-hs-chain action=passthrough 1 ;;; masquerade hotspot network chain=srcnat action=masquerade src-address=10.5...
1
Parameters asked during the setup process
Parameter | Description ----------------------- hotspot interface(string; Default:allow) | Interface name on which to run HotSpot. To run HotSpot on a bridge interface, make sure public interfaces are not included in the bridge ports. local address of network(IP; Default:10.5.50.1/24) | HotSpot gateway address masquera...
1
IP HotSpot
``` /ip/hotspot ``` The menu is designed to manage the HotSpot servers of the router. It is possible to run HotSpot on Ethernet, wireless, VLAN, and bridge interfaces. One HotSpot server is allowed per interface. When HotSpot is configured on the bridge interface, set HotSpot interface as bridge interface, not as bridg...
1
IP HotSpot Active
``` /ip/hotspot/active ``` HotSpot active menu shows all clients authenticated in HotSpot, the menu is informational (read-only) it is not possible to change anything here. Parameters | Description ------------------------ server(read-only; name) | HotSpot server name client is logged in user(read-only; name) | name of...
1
IP HotSpot Host
``` /ip/hotspot/host ``` The host table lists all computers connected to the HotSpot server. The host table is informational and it is not possible to change any value there: Parameters | Description ------------------------ mac-address(read-only; MAC-address) | HotSpot user MAC-address address(read-only; IP address) |...
1
IP Binding
``` /ip/hotspot/ip-binding ``` IP-Binding HotSpot menu allows to the setup of static One-to-One NAT translations, allows to bypass specific HotSpot clients without any authentication, and also allows to block specific hosts and subnets from the HotSpot network Property | Description ---------------------- address(IP Ra...
1
Cookies
The menu contains all cookies sent to the HotSpot clients, which are authorized by cookie method, all the entries are read-only. ``` /ip/hotspot/cookie ``` Property | Description ---------------------- domain(string) | The domain name (if split from the username) expires-in(time) | How long the cookie is valid mac-addr...
1
Using DHCP option to advertise HotSpot URL
Most devices, such as modern smartphones, do some kind of background checking to see if they are behind a captive portal. They do this by requesting a known webpage and comparing the contents of that page, to what they should be. If contents are different, the device assumes there is a login page and creates a popup wi...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
Hotspot customisation
mikrotik_docs
https://help.mikrotik.com/docs/spaces/ROS/pages/87162881/Hotspot+customisation
19
Requirements
1
Introduction
You can create a completely different set of servlet pages for each HotSpot server you have, specifying the directory in the "html-override-directory" property of a HotSpot server profile /ip hotspot profile. The default servlet pages are copied in the directory "hotspot" directory right after you create the server pro...
1
Available Pages
Main HTML servlet pages, which are shown to the user: Some other pages are available as well, if more control is needed:
1
Serving Servlet Pages
The HotSpot servlet recognizes 5 different request types: Note:If it is not possible to meet a request using the pages stored on the router's FTP server, Error 404 is displayed There are many ways to customize what the HotSpot authentication pages look like: To insert a variable in some place in the HTML file, the $(va...
1
Variables
All of the Servlet HTML pages use variables to show user specific values. Variable names appear only in the HTML source of the servlet pages - they are automatically replaced with the respective values by the HotSpot Servlet. For most variables, there is an example of their possible value included in brackets. All the ...
1
List of available variables
Note:Some of the variables use hard-coded http URL, if you are using https, you can construct the link in some other way, for example for $link-status, you can usehttps://$(hostname)/$(target-dir)status Common server variables: Links: General client information: User status information: Traffic counters, which are avai...
1
Working with variables
$(if <var_name>) statements can be used in these pages. The following content will be included, if value of <var_name> will not be an empty string. It is an equivalent to $(if <var_name> != "") It is possible to compare on equivalence as well: $(if <var_name> == <value>) These statements have effect until $(elif <var_n...
1
Redirects and custom Headers
``` $(if http-status == 302)Hotspot login required$(endif) $(if http-header == "Location")$(link-redirect)$(endif) ``` Note:Although the above appears to use the conditional expression 'if' it is in fact setting the 'http-status' to '302' not testing for it. Also the same for the variable 'http-header'. Once again, eve...
1
Customizing Error Messages
All error messages are stored in the errors.txt file within the respective HotSpot servlet directory. You can change and translate all these messages to your native language. To do so, edit the errors.txt file. You can also use variables in the messages. All instructions are given in that file.
1
Multiple Versions of HotSpot Pages
Multiple HotSpot page sets for the same HotSpot server are supported. They can be chosen by the user (to select language) or automatically by JavaScript (to select PDA/regular version of HTML pages). To utilize this feature, create subdirectories in the HotSpot HTML directory, and place those HTML files, which are diff...
1
Misc
If you want to use the HTTP-CHAP authentication method, you need to include thedoLogin()function (which references to themd5.jswhich must be already loaded) before theSubmit actionof the login form. Otherwise, CHAP login will fail. The resulting password to be sent to the HotSpot gateway in case of HTTP-CHAP method, it...
1
Examples
With basic HTML language knowledge and the examples below it should be easy to implement the ideas described above. ``` <type="text" value="$(username)> ``` to this line: ``` <input type="hidden" name="username" value="hsuser"> ``` (where hsuser is the username you are providing) ``` <input type="password"> ``` to this...
1
External authentication
Another example is making HotSpot to authenticate on a remote server (which may, for example, perform credit card charging): Here is an example of such a login page to put on the HotSpot router (it is redirecting tohttps://auth.example.com/login.php, replace with the actual address of an external authentication server)...
1
HTTP header detection
The Hotspot login pages have access to HTTP headers by using$(http-header-name); For example, there exists an ability to check the user agent (or browser), and will return any other content instead of the regular login page, if so desired. This can be used to disable automatic popups in phones, for example. For example...
1
One-click login
It is possible to create a modified captive portal for quick one-click login for scenarios where no user or password is required. What you need to do is: Original: ``` <table width="100" style="background-color: # ffffff"> <tr><td align="right">login</td> <td><input style="width: 80px" name="username" type="text" value...
1
Firewall customizations
1
Summary
Apart from the obvious dynamic entries in the /ip hotspot submenu itself (like hosts and active users), some additional rules are added in the firewall tables when activating a HotSpot service.
1
NAT
From/ip firewall nat print dynamiccommand, you can get something like this (comments follow after each of the rules): ``` 0 D chain=dstnat action=jump jump-target=hotspot hotspot=from-client ``` Putting all HotSpot-related tasks for packets from all HotSpot clients into a separate chain. ``` 1 I chain=hotspot action=ju...
1
Packet Filtering
From/ip firewall filter print dynamiccommand, you can get something like this (comments follow after each of the rules): ``` 0 D chain=forward action=jump jump-target=hs-unauth hotspot=from-client,!auth ``` Any packet that traverse the router from an unauthorized client will be sent to thehs-unauthchain. The hs-unauth ...
1
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null
null