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 |
End of preview. Expand in Data Studio
MikroTik Technical Documentation Dataset
Overview
A structured dataset containing MikroTik's technical documentation, prepared for LLM fine-tuning. The dataset preserves the hierarchical structure of the original documentation while maintaining technical accuracy and formatting.
Dataset Statistics
- Total documents: 285
- Maximum sections per document: 91
- Average sections per document: 12.3
- Format: Parquet
Data Structure
Each row represents a complete documentation page with the following fields:
Metadata
doc_title: Document titledoc_section: Documentation category (e.g., RouterOS, Hardware)source_url: Original documentation URLsection_count: Number of sections in document
Content Fields (per section)
For each section (1 to n):
section_{n}_title: Section headingsection_{n}_content: Section content including code blockssection_{n}_level: Heading level (1 = main heading, 2 = subheading, etc.)
Content Characteristics
- Preserved code blocks with syntax
- Maintained command examples and outputs
- Intact technical formatting
- Complete command parameters and descriptions
- Original markdown structure
Typical Document Structure
- Summary/Overview
- Property/Parameter Descriptions
- Configuration Examples
- Troubleshooting/Notes
Training Considerations
- Clean, consistently formatted technical content
- Hierarchical structure preserved through level indicators
- Complete context within each document
- Code blocks and command examples ready for model training
- Technical accuracy maintained in parameter descriptions
Usage Example
import pandas as pd
# Load the dataset
docs = pd.read_parquet('documentation.parquet')
# Access a document with all its sections
doc = docs.iloc[0]
print(f"Title: {doc['doc_title']}")
# Access specific sections
for i in range(int(doc['section_count'])):
print(f"\nSection {i+1}: {doc[f'section_{i+1}_title']}")
print(f"Content: {doc[f'section_{i+1}_content'][:200]}...")
Data Quality
- Full preservation of technical content
- Consistent section numbering
- Maintained code formatting
- Preserved command syntax
- Complete parameter descriptions
- Original document hierarchy
Source
Derived from official MikroTik documentation. Original formatting and technical accuracy preserved for training purposes.
License
This dataset is derived from MikroTik's official documentation. Use should comply with MikroTik's terms of service and documentation licensing terms.
- Downloads last month
- 15