Software Package Management
Document revision 1.3 (06-Sep-2003)
This document applies to the MikroTik RouterOS V2.7
The MikroTik RouterOS is distributed in the form of software packages. The basic
functionality of the router and the operating system itself is provided by the
system software package.
Other packages contain additional software features as well as support to various network interface cards (NICs).
Packages required :
None
License required :
Any
Home menu level :
/system package
Standards and Technologies :
FTP (RFC 959)
Hardware usage :
not significant
Basic Setup Guide
Device Driver Management
License
management
The modular software package system of MikroTik RouterOS has the following features:
- Ability to add RouterOS functions by installing additional software packages
- Optimal usage of the storage space by the modular/compressed system
- Unused software packages can be uninstalled
- The RouterOS functions and software can be easily upgraded
- Multiple packages can be installed at once
- The package dependency is checked before installing a software package.
The package will not be installed, if the required software package is missing
- The version of the software package should be the same as that of the system package
- The packages can be uploaded on the router using ftp and installed only when the router is going for shutdown
during the reboot process.
- If the software package file can be uploaded to the router,
then the disk space is sufficient for the installation of the package
Installation of the MikroTik RouterOS software packages can be done by uploading the newer version
of the package to the router and rebooting it.
The software package files are compressed binary files, which can be downloaded from the MikroTik's web
page www.mikrotik.com download section.
The full name of the package file consists of a descriptive name, version number, and file extension '.npk'.
For example, system-2.7rc4.npk, ppp-2.7rc4.npk, etc.
You should check the available hard disk space prior to downloading the package file by issuing
/system resource print command. If there is not enough free disk space
for storing the upgrade packages, it can be freed up by uninstalling some software packages,
which provide functionality not required for your needs. If you have a sufficient amount of free
space for storing the upgrade packages, connect to the router using ftp. Use user name and password of a user
with full access privileges.
Select the BINARY mode file transfer.
Upload the software package files to the router and disconnect (Note that the packages
uploaded should retain the original name and also be in lowercase)
View the information about the uploaded software packages using the /file print command.
Reboot the router by issuing the /system reboot command
or by pressing Ctrl+Alt+Del keys at the router's console.
After successful installation the software packages installed can be viewed
using /system package print command.
The installation/upgrade process is shown on the console screen (monitor) attached to the router.
The Free Demo License do not allow software upgrades using ftp.
You should use complete reinstall from floppies, or purchase the license.
Before upgrading the router, please check the current version of the system
package and of the additional software packages. The versions of additional packages should match the version
number of the system software package. The version of the MikroTik RouterOS system software (and the build
number) are shown before the console login prompt.
Information about the version numbers and build time of the installed MikroTik RouterOS software packages
can be obtained using the /system package print command, for example:
[admin@MikroTik] system license> .. package print
Flags: I - invalid
# NAME VERSION BUILD-TIME UNINSTALL
0 web-proxy 2.7.11 sep/04/2003 17:22:32 no
1 ppp 2.7.11 sep/04/2003 17:18:26 no
2 dhcp 2.7.11 sep/04/2003 17:13:37 no
3 telephony 2.7.11 sep/04/2003 17:51:46 no
4 system 2.7.11 sep/05/2003 13:17:40 no
5 routing 2.7.11 sep/04/2003 17:20:20 no
6 security 2.7.11 sep/04/2003 17:12:36 no
7 advanced-tools 2.7.11 sep/04/2003 17:09:35 no
8 ntp 2.7.11 sep/04/2003 17:52:46 no
9 dns-cache 2.7.11 sep/04/2003 17:20:49 no
[admin@MikroTik] system license>
The list shows the number, name, version, and build time of the installed software packages.
If the functions provided by a software package are not required for the router implementation,
the package can be scheduled for uninstallation at the next shutdown/reboot of the router.
Use the
/system package set command to mark the packages for uninstallation.
If a package is marked for uninstallation, but it is required for another (dependent) package,
then the marked package cannot be uninstalled. You should uninstall the dependent package too.
For package dependencies see the section about contents of the software packages below.
The system package will not be uninstalled even if marked for uninstallation.
The
system software package provides the basic functionality of the MikroTik RouterOS, namely:
- IP address, ARP, static IP routing, policy routing,
firewall (packet filtering, content filtering, masquerading, and static NAT),
traffic shaping (queues), IP traffic accounting,
MikroTik Neighbour Discovery, IP Packet Packing,
DNS client settings, IP service (servers)
- Ethernet interfaces
- IP over IP tunnel interfaces (IPIP)
- Ethernet over IP tunnel interfaces (EoIP)
- driver management for Ethernet ISA cards
- serial port management
- local user management
- export and import of router configuration scripts
- backup and restore of the router's configuration
- undo and redo of configuration changes
- network diagnostics tools (ping, traceroute, bandwidth tester,
traffic monitor)
- bridge configuration
- system resource management
- package management
- telnet client and server
- local and remote logging facility
It also includes winbox server as well as winbox executable with some plugins
After installing the MikroTik RouterOS, a license should be obtained
from MikroTik to enable the basic system functionality.
The table below shows additional software feature packages, the provided functionality,
the required prerequisites and additional licenses, if any.
| Name |
Contents |
Prerequisites |
Additional License |
| advanced-tools |
Provides email client, pingers, netwatch and other utilities |
- |
- |
| arlan |
Provides support for DSSS 2.4GHz 2mbps Aironet ISA cards |
- |
2.4GHz/5GHz Wireless Client |
| dhcp |
Provides DHCP server and client support |
- |
- |
| dns-cache |
DNS cache |
- |
- |
| hotspot |
HotSpot gateway |
- |
any additional license |
| isdn |
Provides ISDN support |
ppp |
- |
| lcd |
Provides LCD monitor support |
- |
- |
| ntp |
Provides network time protocol support |
- |
- |
| ppp |
Provides support for PPP, PPTP, L2TP, PPPoE and ISDN PPP |
- |
- |
| radiolan |
Provides support for 5.8GHz RadioLAN cards |
- |
2.4GHz/5GHz Wireless Client |
| routing |
Provides support for RIP, OSPF and BGP4 |
- |
- |
| security |
Provides support for IPSEC, SSH and secure connectivity with WinBox |
- |
- |
| synchronous |
Provides support for framerelay and Moxa C101, Moxa C512, Farsync, Cyclades PC300 and XPeed synchronous cards |
- |
Sync and Hotspot |
telephony |
Provides IP telephony support (H.323) |
- |
- |
thinrouter-pcipc |
Forces PCItoCardBus Bridge to use IRQ 11 as in ThinRouters |
- |
- |
| ups |
Provides APC Smart Mode UPS support |
- |
- |
| web-proxy |
HTTP Web proxy package |
- |
- |
| wireless |
Provides support for Cisco Aironet cards and PrismII and Atheros wireless stations and APs |
- |
2.4GHz/5GHz Wireless Client / 2.4GHz/5GHz Wireless Server (optional) |
Usually, you do not need to uninstall software packages. However, if you have installed a wrong package, or you need
additional free space to install new one, you have to uninstall some unused packages.
Installed software packages can be viewed using /system package print command.
In order to uninstall software package, you have to set uninstall property for that package to yes and
reboot the router.
Suppose we need to uninstall
web-proxy package from a router.
[admin@MikroTik] > /system package print
Flags: I - invalid
# NAME VERSION BUILD-TIME UNINSTALL
0 web-proxy 2.7.11 sep/04/2003 17:22:32 no
1 ppp 2.7.11 sep/04/2003 17:18:26 no
2 dhcp 2.7.11 sep/04/2003 17:13:37 no
3 telephony 2.7.11 sep/04/2003 17:51:46 no
4 system 2.7.11 sep/05/2003 13:17:40 no
5 routing 2.7.11 sep/04/2003 17:20:20 no
6 security 2.7.11 sep/04/2003 17:12:36 no
7 advanced-tools 2.7.11 sep/04/2003 17:09:35 no
8 ntp 2.7.11 sep/04/2003 17:52:46 no
9 dns-cache 2.7.11 sep/04/2003 17:20:49 no
[admin@MikroTik] > /system package set 0 uninstall=yes
[admin@MikroTik] > /system reboot
- Is it possible to upgrade from 2.5 to 2.7 without configuration loss?
No, you will loose Point-to-Point interface, DHCP and bridge interface settings.
Also, you will have to copy all the PPP users in the new location manually.
Please Note that you should uninstall telephony package
before the upgrade. After the upgrade you can put it back and you will not
loose the configuration.
- I have Free Demo license for V2.3 of MikroTik RouterOS, and I want to upgrade to V2.7
You will need to obtain a new demo license after the upgrade, or purchase the license.
It can be done prior the upgrade.
- Not enough space to upgrade the system package.
Uninstall some packages not in use.
- The system package does not install because of incorrect version.
Use system package version that is greater than the currently installed one.
- Additional packages do not install because of incorrect version of the system package.
Upgrade the system package first, then install the additional packages.
The packages should be of the same version as your system package.
- The package file is corrupted after upload.
Use BINARY mode for file transfer.
- The package has been successfully installed and the driver loaded,
but there is no interface in the interface list
Obtain the required license to enable the functionality of provided by the software package.
- The package files have been uploaded to the router, but they have not been installed.
Reboot the router!
- The version 2.2 has been upgraded to the version 2.7,
but the connection to the router was lost after the reboot.
The configuration has been lost.
Using the console (monitor and keyboard attached to the router),
restore the configuration.
© Copyright 1999-2003, MikroTik