Software Package Installation and Upgrading

Document revision 29-Nov-2002
This document applies to the MikroTik RouterOS V2.6

Overview

The MikroTik RouterOS is residing on a formatted HDD specific to your installation and containing software packages. The main package is the system software package, which provides the basic functionality of the router. Additional software packages provide support for additional features (e.g., PPPoE, PPTP, PPP, wireless, etc).

Features

The modular software package system of MikroTik RouterOS has following features:

Ability to add RouterOS functions by installing additional software packages
Optimal usage of the storage space by the modular/compressed system
The 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 installation of the package

Contents of the Manual

The following sections are included in this Manual:

Software Upgrade Instructions
Software Package Installation Instructions
Contents of the Software Packages

System Software Package
Additional Software Feature Packages

Software Package Resource Usage
Troubleshooting

Software Upgrade Instructions

Upgrade of the MikroTik RouterOS can be done by uploading the newer version software packages to the router and rebooting it. Note! 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 version of the MikroTik RouterOS system software (and the build number) are shown before the console login prompt, for example:

MikroTik v2.6beta4
Login:

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 package print
Flags: I - invalid
  #   NAME                  VERSION              BUILD-TIME           UNINSTALL
  0   system                2.6beta4             aug/09/2002 20:22:14 no
  1   rip                   2.6beta4             aug/09/2002 20:33:41 no
  2   ppp                   2.6beta4             aug/09/2002 20:28:01 no
  3   plist                 2.6beta4             aug/09/2002 20:32:58 no
  4   pppoe                 2.6beta4             aug/09/2002 20:29:18 no
  5   pptp                  2.6beta4             aug/09/2002 20:28:43 no
  6   ssh                   2.6beta4             aug/09/2002 20:25:31 no
  7   advanced-tools        2.6beta4             aug/09/2002 20:53:37 no
  8   bgp                   2.6beta4             aug/09/2002 20:34:22 no
  9   ospf                  2.6beta4             aug/09/2002 20:34:08 no
[admin@MikroTik] >

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:

[admin@MikroTik] > system package set 6 uninstall=yes
[admin@MikroTik] > system package print
Flags: I - invalid
  #   NAME                  VERSION              BUILD-TIME           UNINSTALL
  0   system                2.6beta4             aug/09/2002 20:22:14 no
  1   rip                   2.6beta4             aug/09/2002 20:33:41 no
  2   ppp                   2.6beta4             aug/09/2002 20:28:01 no
  3   plist                 2.6beta4             aug/09/2002 20:32:58 no
  4   pppoe                 2.6beta4             aug/09/2002 20:29:18 no
  5   pptp                  2.6beta4             aug/09/2002 20:28:43 no
  6   ssh                   2.6beta4             aug/09/2002 20:25:31 yes
  7   advanced-tools        2.6beta4             aug/09/2002 20:53:37 no
  8   bgp                   2.6beta4             aug/09/2002 20:34:22 no
  9   ospf                  2.6beta4             aug/09/2002 20:34:08 no
[admin@MikroTik] >

If a package is marked for uninstallation, but it is required for another (dependent) package, then the marked package cannot be uninstalled. For example, the ppp package wont be uninstalled, if the pptp package is installed. You should uninstall the dependent package too. For package dependencies see the section about contents of the software packages below. The system package wont be uninstalled even if marked for uninstallation.

Software Package Installation Instructions

The software package files are compressed binary files, which can be downloaded from 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.6beta4.npk, ppp-2.6beta4.npk, pppoe-2.6beta4.npk, etc. To install (upgrade) newer version of the MikroTik RouterOS system software please follow the upgrade instructions below:

Check the availability of free HDD space on the router using the /system resource print command:
```
[admin@MikroTik] > system resource print
             uptime: 2d8h31m33s
        free-memory: 3328 kB
       total-memory: 29504 kB
                cpu: "WinChip"
           cpu-load: 0
     free-hdd-space: 5679 kB
    total-hdd-space: 46478 kB
[admin@MikroTik] >
```
Note! If there is not enough free disk space for storing the upgrade packages, disk space can be freed up by uninstalling some software packages, which provide functionality not required for your needs.
If the free disk space is sufficient 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.
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.

Example output of the /file print command:

[admin@MikroTik] > file print
  # NAME                                TYPE    SIZE       CREATION-TIME
  0 ssh_host_key.pub                    unknown 332        jan/23/2002 18:45:02
  1 ssh_host_dsa_key.pub                unknown 603        jan/23/2002 18:45:08
  2 cyclades-2.6beta4.npk               package 114321     jan/31/2002 17:45:27
  3 framerelay-2.6beta4.npk             package 94632      jan/31/2002 17:45:29
[admin@MikroTik] >

The installation/upgrade process is shown on the console screen (monitor) attached to the router. After successful installation the software packages installed can be viewed using /system package print command.

Note!The versions of packages should match the version number of the system software package.

Contents of the Software Packages

System Software Package

The system software package provides the basic functionality of the MikroTik RouterOS, namely:

IP address, ARP, static IP routing, policy routing, firewall (packet 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.

Additional Software Feature Packages

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 network monitor and support for other advanced tools	-	-
aironet	Provides support for CISCO Aironet IEEE 802.11b wireless PC/PCI/ISA cards	-	2.4GHz wireless
arlan	Provides support for DSSS 2.4GHz 2mbps Aironet ISA cards	-	2.4GHz wireless
atheros	Provides support for Atheros chipset based IEEE 802.11a wireless cards as clients or as access points	-	2.4GHz wireless (station mode);
			2.4GHz wireless and AP (AP mode)
bgp	Provides BGP support	-	-
cyclades	Provides support for PC300 synchronous interfaces	-	synchronous
ddns	Provides dynamic DNS support	-	-
dhcp	Provides DHCP server and client support	-	-
dns-cache	DNS cache	-	-
farsync	Provides support FarSync interfaces	-	synchronous
framerelay	Provides support for frame relay (used with Moxa C101, Cyclades PC300, or FarSync interfaces	-	-
hotspot	HotSpot gateway	-	any additional license
ipsec	Provides Ipsec support	-	-
isdn	Provides support for ISDN	ppp	-
lcd	Provides LCD monitor support	-	-
moxa-c101	Provides support for Moxa C101 synchronous card	-	synchronous
moxa-c502	Provides support for Moxa C502 synchronous card	-	synchronous
ntp	Provides network time protocol support	-	-
ospf	Provides OSPF support	-	-
plist	Provides Prefix List support for BGP and RIP	-	-
ppp	Provides asynchronous PPP support	-	-
pppoe	Provides PPPoE support	ppp	-
pptp	Provides PPTP support	ppp	-
prism	Provides support for Prism II chipset based IEEE 802.11b wireless cards as clients or as access points	-	2.4GHz wireless (station mode);
			2.4GHz wireless and AP (AP mode)
radiolan	Provides support for 5.8GHz RadioLAN ISA cards	-	radiolan
rip	Provides RIP support	-	-
snmp	Provides read only SNMP support	-	-
ssh	Provides remote access via SSH	-	-
telephony	Provides IP telephony support (H.323) for Quicknet cards	-	-
ups	Provides APC Smart Mode UPS support	-	-
vlan	Provides support fot IEEE 802.1Q Virtual LAN	-	-
wavelan	Provides support for Lucent WaveLAN IEEE 802.11 wireless cards	-	2.4GHz wireless
web-proxy	provides squid based web proxy support	-	-
xpeed	Provides support for Xpeed 300 SDSL cards	-	-

If additional license is required to enable the functionality of a software package, the license should be obtained for the Software ID of your system. The new key should be entered using the /system license set key command, and the router should be rebooted afterwards:

[admin@MikroTik] system license> print
      software-id: TPNG-SXN
              key: 2C6A-YUE-3H2
    upgradable-to: dec/01/2002
[admin@MikroTik] system license> feature print
Flags: X - disabled
  #   FEATURE
  0 X AP
  1 X synchronous
  2 X radiolan
  3 X wireless-2.4gHz
  4   licensed
[admin@MikroTik] system license> set key=D45G-IJ6-QM3
[admin@MikroTik] system license> /system reboot
Reboot, yes? [y/N]: y
system will reboot shortly

If there is no appropriate license, the appropriate interfaces wont show up under the interface list, even though the packages can be installed on the MikroTik RouterOS and corresponding drivers loaded.

Software Package Resource Usage

The following table shows the required resources of HDD storage and RAM for the various software packages. The total required storage space can be calculated by adding the together the required storage of all installed packages including the system software package.

Note that there are only minimal requirements needed to run the software. Additional resource usage is expected from many packages when they are configured and running (especially from web-proxy, system and dns-cache)

Name Memory (RAM) usage, MB Storage (HDD) usage, MB

advanced-tools 0.6 0.4

aironet 1.6 0.2

arlan 1.1 0.2

atheros 2.7 0.7

bgp 1.0 0.9

cyclades 1.5 0.2

ddns 0.4 0.2

dhcp 1.0 0.4

dns-cache 1.5 0.3

farsync 2.2 0.3

framerelay 0.8 0.2

hotspot 1.0 0.4

ipsec 3.0 0.8

isdn 2.7 0.9

lcd 1.9 0.3

moxa-c101 1.9 0.2

moxa-c502 2.0 0.1

ntp 1.3 0.4

ospf 2.1 0.8

plist 0.5 0.2

ppp 2.2 0.9

pppoe 0.2 0.3

pptp 1.0 0.3

prism 2.7 0.7

radiolan 2.0 0.3

rip 1.7 0.5

snmp 1.0 0.3

ssh 2.0 1.8

system 16.5 20.0

telephony 6.0 5.2

ups 0.9 0.3

vlan 1.9 0.2

wavelan 1.9 0.2

web-proxy 1.3 1.0

xpeed 1.8 0.2

Name	Memory (RAM) usage, MB	Storage (HDD) usage, MB
advanced-tools	0.6	0.4
aironet	1.6	0.2
arlan	1.1	0.2
atheros	2.7	0.7
bgp	1.0	0.9
cyclades	1.5	0.2
ddns	0.4	0.2
dhcp	1.0	0.4
dns-cache	1.5	0.3
farsync	2.2	0.3
framerelay	0.8	0.2
hotspot	1.0	0.4
ipsec	3.0	0.8
isdn	2.7	0.9
lcd	1.9	0.3
moxa-c101	1.9	0.2
moxa-c502	2.0	0.1
ntp	1.3	0.4
ospf	2.1	0.8
plist	0.5	0.2
ppp	2.2	0.9
pppoe	0.2	0.3
pptp	1.0	0.3
prism	2.7	0.7
radiolan	2.0	0.3
rip	1.7	0.5
snmp	1.0	0.3
ssh	2.0	1.8
system	16.5	20.0
telephony	6.0	5.2
ups	0.9	0.3
vlan	1.9	0.2
wavelan	1.9	0.2
web-proxy	1.3	1.0
xpeed	1.8	0.2

Troubleshooting

Is it possible to upgrade from 2.5 to 2.6 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.6
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.x has been upgraded to the version 2.6.y, 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.