Manual:System/Packages: Difference between revisions

From MikroTik Wiki
Jump to navigation Jump to search
No edit summary
 
(34 intermediate revisions by 9 users not shown)
Line 1: Line 1:
==RoterOS Packages==
==Summary==


=== About packages ===
RouterOS supports a lot of different features and since every installation requires specific set of features supprted it is possible to add or remove certain groups of features using package system. As result user is able to control what features are available and size of installation. Packages are provided only by MikroTik and no 3rd parties are allowed to make them.


This article is about Mikrotik RouterOS packages, avaible for download [http://www.mikrotik.com/download.html here].
== Acquiring packages ==


Upgrade process is described [http://wiki.mikrotik.com/wiki/Upgrading_RouterOS here].
Packages can be downloaded from [http://www.mikrotik.com/download.html MikroTik download] page or mirrors listed on that page. Either of provided download methods can be used.


=== Packages specification ===
==RouterOS packages==


'''for each architecture'''
For a simple home router, only the '''system''' package is needed for basic operation. Other packages are optional. The DHCP package might be the next most important, if your ISP provides IP addresses using this method. PPP is needed if you require PPPoE or PPTP for connectivity. Other packages are not required for a home router, and are completely optional. Install them only if you are sure of their purpose.
* advanced-tools - email client, pinger, netwatch, eoip
* calea - data gathering tool for specific use due to "Communications Assistance for Law Enforcement Act" in USA
* dhcp - Dynamic Host Control Protocol client and server
* gps - Global Positioning System devices support
* hotspot- HotSpot service support
* ipv6 - IPv6 addresses support
* mpls - Multi Protocol Labels Switching support
* multicast - PIM
* ntp - Network protocol client and service
* ppp - PPP, PPTP, L2TP, PPPoE, ISDN PPP clients and servers
* routerboard - RouterBoard Utilities
* routing - routing protocols (RIP, OSPF, BGP)
* security - IPSEC, SSH, Secure WinBox
* system - Main package
* ups - APC ups
* user-manager - RouterOS User Manager
* wireless - PrismII and Atheros wireless


{| cellpadding="2"
!width="300px" style="background:#cccccc; border-bottom:1px solid gray;"| Package
!width="450px" style="background:#cccccc; border-bottom:1px solid gray;"| Features
|-
|style="border-bottom:1px solid gray;" valign="top"|'''advanced-tools''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"| Advanced ping tools (flood-ping, ping-speed), Netwatch, ip-scan, SMS tool, Wake-on-LAN
|-
|style="border-bottom:1px solid gray;" valign="top"|'''calea''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|Data gathering tool for specific use due to "Communications Assistance for Law Enforcement Act" in USA
|-
|style="border-bottom:1px solid gray;" valign="top"|'''dhcp''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|Dynamic Host Control Protocol client and server
|-
|style="border-bottom:1px solid gray;" valign="top"|'''gps''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|Global Positioning System devices support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''hotspot''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[Hotspot|HotSpot]] captive portal server for user management
|-
|style="border-bottom:1px solid gray;" valign="top"|'''ipv6''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|IPv6 addressing support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''lte''' (<em>mipsbe</em>)
|style="border-bottom:1px solid gray;" valign="top"|Required package only for SXT LTE (RBSXTLTE3-7), which contains drivers for the built-in LTE interface.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''mpls''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[MPLS|Multi Protocol Labels Switching support]]
|-
|style="border-bottom:1px solid gray;" valign="top"|'''multicast''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[Multicast|Protocol&nbsp;Independent&nbsp;Multicast&nbsp;-&nbsp;Sparse&nbsp;Mode]]; [[IGMP-Proxy|Internet&nbsp;Group&nbsp;Managing&nbsp;Protocol&nbsp;-&nbsp;Proxy]]
|-
|style="border-bottom:1px solid gray;" valign="top"|'''ntp''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|Network protocol server, also includes simplistic client. NTP client is also built into the system package and functions well without this package installed.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''openflow''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|Enables OpenFlow support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''ppp''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|MlPPP client, PPP, PPTP, L2TP, PPPoE, ISDN PPP clients and servers
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routerboard''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"| accessing and managing RouterBOOT. RouterBOARD specific imformation.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routing''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|dynamic routing protocols like [[M:Routing/RIP | RIP]], [[M:Routing/BGP | BGP]], [[M:Routing/OSPF|OSPF]] and routing utilities like [[M:Routing/BFD | BFD]], [[M:Routing/Routing_filters|filters for routes]].
|-
|style="border-bottom:1px solid gray;" valign="top"|'''security''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|IPSEC, SSH, Secure WinBox (<em>necessary for Winbox versions up to v3.14</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''system''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|basic router features like ''static routing, ip addresses, sNTP, telnet, [[M:API | API]], queues, [[M:IP/Firewall | firewall]], [[M:IP/Proxy | web proxy]], [[M:IP/DNS | DNS cache]], [[M:IP/TFTP|TFTP]], [[M:IP/Pools | IP pool]], SNMP, packet sniffer, e-mail send tool, graphing, bandwidth-test, torch, [[M:Interface/EoIP | EoIP]], [[M:Interface/IPIP | IPIP]], [[M:Interface/Bridge | bridging]], [[M:Interface/VLAN | VLAN]], [[M:Interface/VRRP | VRRP]] etc.). Also, for RouterBOARD platform - [[M:Metarouter|MetaROUTER | Virtualization]]
|-
|style="border-bottom:1px solid gray;" valign="top"|'''tr069''' (<em>mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[Manual:TR069-client | TR069 Client]] package
|-
|style="border-bottom:1px solid gray;" valign="top"|'''ups''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|APC ups management interface
|-
|style="border-bottom:1px solid gray;" valign="top"|'''user-manager''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[User_Manager|MikroTik User Manager]] server for controlling Hotspot and other service users.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''wireless''' (<em>mipsle, mipsbe, ppc, x86, mmips, arm, smips</em>)
|style="border-bottom:1px solid gray;" valign="top"| [[M:Interface/Wireless|wireless interface]] support. Sometimes sub-types are released, for example '''wireless-fp''' introduced FastPath support, '''wireless-cm2''' introduced CAPsMAN v2 and '''wireless-rep''' introduced Repeater mode. These packages are occasionally released separately, before the new features get merged into the main wireless package.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''arlan''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|legacy Aironet Arlan support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''isdn''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|ISDN modem support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''lcd''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|LCD panel support for serial/parallel port devices. Not needed for RouterBOARD LCD panels.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''radiolan''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|RadioLan cards support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''synchronous''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|FarSync support
|-
|style="border-bottom:1px solid gray;" valign="top"|'''xen''' (<em> discontinued x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[Xen|XEN Virtualization]]
|-
|style="border-bottom:1px solid gray;" valign="top"|'''kvm''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|[[Kvm|KVM Virtualization]]
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-mipsle''' (<em>mipsle</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for mipsle (RB100, RB500) (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-smips''' (<em>smips</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for smips (hAP mini, hAP lite) (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-mipsbe''' (<em>mipsbe</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for mipsbe (RB400)  (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-powerpc''' (<em>ppc</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for powerpc (RB300, RB600, RB1000)  (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-x86''' (<em>x86</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for x86 (Intel/AMD PC, RB230)  (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-mmips''' (<em>mmips</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for multicore mips (Mxx, RB750v3) (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|-
|style="border-bottom:1px solid gray;" valign="top"|'''routeros-arm''' (<em>arm</em>)
|style="border-bottom:1px solid gray;" valign="top"|combined package for arm (cAP ac, hAP ac², CRS3xx, RB3011, RB1100AHx4, etc)  (includes <em>system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing</em>)
|}


'''for all architectures, beta test packages'''
{{ note | Since v6.44beta39 security package depends on DHCP package. }}


* mpls-test - Multi Protocol Labels Switching support improvements
== Working with packages ==
* routing-test - routing protocols (RIP, OSPF, BGP) improvements


'''Menu:''' <em>/system package</em>


'''x86 specific packages'''
Commands executed in this menu will take place only on restart of the router. Until then, user can freely schedule or revert set actions.


* routeros-x86 - complete package for x86 (Intel/AMD PC, RB200)
{| cellpadding="2"
* arlan - Aironet Arlan support
!width="300px" style="background:#cccccc; border-bottom:1px solid gray;"| Command
* isdn - ISDN support
!width="450px" style="background:#cccccc; border-bottom:1px solid gray;"| Desciption
* lcd - LCD panels support
|-
* radiolan - RadioLan cards support
|style="border-bottom:1px solid gray;" valign="top"|'''disable'''
* synchronous -FrameRelay, MOXA, FarSync support
|style="border-bottom:1px solid gray;" valign="top"| schedule the package to be disabled after the next reboot. No features provided by the package will be accessible
* system
|-
* xen - XEN Virtualization support
|style="border-bottom:1px solid gray;" valign="top"|'''downgrade'''
|style="border-bottom:1px solid gray;" valign="top"|will prompt for the reboot. During the reboot process will try to downgrade the RouterOS to the oldest version possible by checking the packages that are uploaded to the router.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''print'''
|style="border-bottom:1px solid gray;" valign="top"|outputs information about the packages, like: version,  package state, planned state changes etc.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''enable'''
|style="border-bottom:1px solid gray;" valign="top"|schedule package to be enabled after the next reboot
|-
|style="border-bottom:1px solid gray;" valign="top"|'''uninstall'''
|style="border-bottom:1px solid gray;" valign="top"|schedule package to be removed from the router. That will take place during the reboot.
|-
|style="border-bottom:1px solid gray;" valign="top"|'''unschedule'''
|style="border-bottom:1px solid gray;" valign="top"|remove scheduled task for the package.
|}


==Examples==


'''powerpc specific packages'''
Upgrade process is described [[Upgrading_RouterOS|here]].
* routeros-powerpc - complete package for powerpc (RB300, RB600, RB1000)


 
====List available packages====
'''mipsbe specific packages'''
* routeros-mipsbe - complete package for mipsbe (RB400)
 
 
'''mipsle specific packages'''
* routeros-mipsle - complete package for mipsle (RB100, RB500)
 
=== Working with packages ===
 
* list of available packages


<pre>
<pre>
Line 80: Line 173:
</pre>
</pre>


* uninstall selected package (ppp for example)
====Uninstall package====
 
Schedules package for uninstallation and reboots router.


<pre>
<pre>
  /system package uninstall ppp; system reboot;  
  /system package uninstall ppp; /system reboot;  
system reboot
Reboot, yes? [y/N]:
Reboot, yes? [y/N]:
</pre>
</pre>


* disable selected package (hotspot for example)
====Disable package====


<pre>
<pre>
  /system package disable hotspot;  
  /system package disable hotspot; /system reboot;
/system reboot;
system reboot           
Reboot, yes? [y/N]:
Reboot, yes? [y/N]:
</pre>
</pre>


* downgrade (older package must be uploaded to router)
====Downgrade====


<pre>
<pre>
  /system package downgrade; system reboot;
  /system package downgrade; /system reboot;
system reboot           
Reboot, yes? [y/N]:  
Reboot, yes? [y/N]:  
</pre>
</pre>


* cancel uninstall or disable action (ipv6 for example)
====Cancel uninstall or disable action====


<pre>
<pre>
Line 111: Line 202:
</pre>
</pre>


[[Category: Manual]]
[[Category: Manual|P]]
[[Category: Unfinished]]
[[Category: System|P]]
[[Category:Basic|P]]
[[Category:Install|P]]

Revision as of 09:58, 27 May 2019

Summary

RouterOS supports a lot of different features and since every installation requires specific set of features supprted it is possible to add or remove certain groups of features using package system. As result user is able to control what features are available and size of installation. Packages are provided only by MikroTik and no 3rd parties are allowed to make them.

Acquiring packages

Packages can be downloaded from MikroTik download page or mirrors listed on that page. Either of provided download methods can be used.

RouterOS packages

For a simple home router, only the system package is needed for basic operation. Other packages are optional. The DHCP package might be the next most important, if your ISP provides IP addresses using this method. PPP is needed if you require PPPoE or PPTP for connectivity. Other packages are not required for a home router, and are completely optional. Install them only if you are sure of their purpose.

Package Features
advanced-tools (mipsle, mipsbe, ppc, x86, mmips, arm, smips) Advanced ping tools (flood-ping, ping-speed), Netwatch, ip-scan, SMS tool, Wake-on-LAN
calea (mipsle, mipsbe, ppc, x86, mmips, arm) Data gathering tool for specific use due to "Communications Assistance for Law Enforcement Act" in USA
dhcp (mipsle, mipsbe, ppc, x86, mmips, arm, smips) Dynamic Host Control Protocol client and server
gps (mipsle, mipsbe, ppc, x86, mmips, arm) Global Positioning System devices support
hotspot (mipsle, mipsbe, ppc, x86, mmips, arm, smips) HotSpot captive portal server for user management
ipv6 (mipsle, mipsbe, ppc, x86, mmips, arm, smips) IPv6 addressing support
lte (mipsbe) Required package only for SXT LTE (RBSXTLTE3-7), which contains drivers for the built-in LTE interface.
mpls (mipsle, mipsbe, ppc, x86, mmips, arm, smips) Multi Protocol Labels Switching support
multicast (mipsle, mipsbe, ppc, x86, mmips, arm, smips) Protocol Independent Multicast - Sparse Mode; Internet Group Managing Protocol - Proxy
ntp (mipsle, mipsbe, ppc, x86, mmips, arm) Network protocol server, also includes simplistic client. NTP client is also built into the system package and functions well without this package installed.
openflow (mipsle, mipsbe, ppc, x86, mmips, arm, smips) Enables OpenFlow support
ppp (mipsle, mipsbe, ppc, x86, mmips, arm, smips) MlPPP client, PPP, PPTP, L2TP, PPPoE, ISDN PPP clients and servers
routerboard (mipsle, mipsbe, ppc, x86, mmips, arm) accessing and managing RouterBOOT. RouterBOARD specific imformation.
routing (mipsle, mipsbe, ppc, x86, mmips, arm, smips) dynamic routing protocols like RIP, BGP, OSPF and routing utilities like BFD, filters for routes.
security (mipsle, mipsbe, ppc, x86, mmips, arm, smips) IPSEC, SSH, Secure WinBox (necessary for Winbox versions up to v3.14)
system (mipsle, mipsbe, ppc, x86, mmips, arm, smips) basic router features like static routing, ip addresses, sNTP, telnet, API, queues, firewall, web proxy, DNS cache, TFTP, IP pool, SNMP, packet sniffer, e-mail send tool, graphing, bandwidth-test, torch, EoIP, IPIP, bridging, VLAN, VRRP etc.). Also, for RouterBOARD platform - MetaROUTER | Virtualization
tr069 (mipsbe, ppc, x86, mmips, arm) TR069 Client package
ups (mipsle, mipsbe, ppc, x86, mmips, arm) APC ups management interface
user-manager (mipsle, mipsbe, ppc, x86, mmips, arm) MikroTik User Manager server for controlling Hotspot and other service users.
wireless (mipsle, mipsbe, ppc, x86, mmips, arm, smips) wireless interface support. Sometimes sub-types are released, for example wireless-fp introduced FastPath support, wireless-cm2 introduced CAPsMAN v2 and wireless-rep introduced Repeater mode. These packages are occasionally released separately, before the new features get merged into the main wireless package.
arlan (x86) legacy Aironet Arlan support
isdn (x86) ISDN modem support
lcd (x86) LCD panel support for serial/parallel port devices. Not needed for RouterBOARD LCD panels.
radiolan (x86) RadioLan cards support
synchronous (x86) FarSync support
xen ( discontinued x86) XEN Virtualization
kvm (x86) KVM Virtualization
routeros-mipsle (mipsle) combined package for mipsle (RB100, RB500) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
routeros-smips (smips) combined package for smips (hAP mini, hAP lite) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
routeros-mipsbe (mipsbe) combined package for mipsbe (RB400) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
routeros-powerpc (ppc) combined package for powerpc (RB300, RB600, RB1000) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
routeros-x86 (x86) combined package for x86 (Intel/AMD PC, RB230) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
routeros-mmips (mmips) combined package for multicore mips (Mxx, RB750v3) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
routeros-arm (arm) combined package for arm (cAP ac, hAP ac², CRS3xx, RB3011, RB1100AHx4, etc) (includes system, hotspot, wireless, ppp, security, mpls, advanced-tools, dhcp, routerboard, ipv6, routing)
Icon-note.png

Note: Since v6.44beta39 security package depends on DHCP package.


Working with packages

Menu: /system package

Commands executed in this menu will take place only on restart of the router. Until then, user can freely schedule or revert set actions.

Command Desciption
disable schedule the package to be disabled after the next reboot. No features provided by the package will be accessible
downgrade will prompt for the reboot. During the reboot process will try to downgrade the RouterOS to the oldest version possible by checking the packages that are uploaded to the router.
print outputs information about the packages, like: version, package state, planned state changes etc.
enable schedule package to be enabled after the next reboot
uninstall schedule package to be removed from the router. That will take place during the reboot.
unschedule remove scheduled task for the package.

Examples

Upgrade process is described here.

List available packages

 /system package print 
Flags: X - disabled 
 #   NAME                    VERSION                    SCHEDULED              
 0 X ipv6                    3.13                                              
 1   system                  3.13                                              
 2 X mpls                    3.13                                              
 3 X hotspot                 3.13                                              
 4   routing                 3.13                                              
 5   wireless                3.13                                              
 6 X dhcp                    3.13                                              
 7   routerboard             3.13                                              
 8   routeros-mipsle         3.13                                              
 9   security                3.13                                              
 10 X ppp                     3.13                                              
 11   advanced-tools          3.13

Uninstall package

Schedules package for uninstallation and reboots router.

 /system package uninstall ppp; /system reboot; 
Reboot, yes? [y/N]:

Disable package

 /system package disable hotspot; /system reboot;
Reboot, yes? [y/N]:

Downgrade

 /system package downgrade; /system reboot;
Reboot, yes? [y/N]: 

Cancel uninstall or disable action

 /system package unschedule ipv6