Package Management
| Document revision: | 1.2 (Thu Dec 02 12:56:28 GMT 2004) |
| Applies to: | V2.8 |
General Information
Summary
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.
Specifications
License required: Level1Submenu level: /system package
Standards and Technologies: FTP
Hardware usage: Not significant
Related Documents
Description
FeaturesThe modular software package system of MikroTik RouterOS has the following features:
- Ability to extend RouterOS functions by installing additional software packages
- Optimal usage of the storage space by employing modular/compressed system
- Unused software packages can be uninstalled
- The RouterOS functions and the system itself 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 feature 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 (Upgrade)
Description
Installation or upgrade of the MikroTik RouterOS software packages can be done by uploading the newer version of the software 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 download section. The full name of the software package consists of a descriptive name, version number and extension .npk, exempli gratia system-2.8rc3.npk, routerboard-2.8rc3.npk.
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.
Step-by-Step- Connect to the router using ftp client
- Select the BINARY mode file transfer
- Upload the software package files to the router and disconnect
- Check 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 reboot, verify that the packages were installed correctly by issuing /system package print command
Notes
The packages uploaded to the router should retain the original name and also be in lowercase.
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 do a complete reinstall from floppies, or purchase the license.
Before upgrading the router, please check the current version of the system package and 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.
Uninstalling
Description
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 a new one, you have to uninstall some unused packages.
In order to uninstall software package, you have to set uninstall property for that package to yes and reboot the router.
Property Description
uninstall (yes | no; default: no) - If set to yes, schedules the package for uninstallation on next reboot.Notes
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 the list of package dependencies see the 'Software Package List; section below. The system package will not be uninstalled even if marked for uninstallation.
Example
Suppose we need to uninstall security package from the router:
[admin@MikroTik] system package> print Flags: I - invalid # NAME VERSION BUILD-TIME UNINSTALL 0 system 2.8beta8 oct/21/2003 13:27:59 no 1 ppp 2.8beta8 oct/21/2003 12:31:52 no 2 advanced-tools 2.8beta8 oct/21/2003 12:31:42 no 3 dhcp 2.8beta8 oct/21/2003 12:31:49 no 4 routing 2.8beta8 oct/21/2003 12:31:55 no 5 security 2.8beta8 oct/21/2003 12:31:47 no 6 synchronous 2.8beta8 oct/21/2003 12:32:05 no 7 wireless 2.8beta8 oct/21/2003 12:32:09 no [admin@MikroTik] system package> set 5 uninstall=yes [admin@MikroTik] > .. reboot
Downgrading
Command name: /system package downgradeDescription
MikroTik RouterOS™ v2.8 features downgrade option. It allows you to downgrade the software via ftp without losing your license key or reinstalling the router.
You have to choose to what version of RouterOS your present version should be downgraded and upload relevant packages to your router via ftp. Then you need to issue /system package downgrade command.
Command Description
downgrade - this command asks your confirmation and reboots the router. After reboot the software is downgraded (if all needed packages were uploaded to the router)Example
To downgrade the RouterOS™ (we assume that all packages needed are already uploaded):
[admin@MikroTik] system package> downgrade Router will be rebooted. Continue? [y/N]: y system will reboot shortly [admin@MikroTik] system package>
Software Package List
Description
System Software PackageThe system software package provides the basic functionality of the MikroTik RouterOS, namely:
- IP address management, 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 interface support
- IP over IP tunnel interface support
- Ethernet over IP tunnel interface support
- 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 support
- system resource management
- package management
- telnet client and server
- local and remote logging facility
- winbox server as well as winbox executable with some plugins
After installing the MikroTik RouterOS, a free license should be obtained from MikroTik to enable the basic system functionality.
Additional Software Feature PackagesThe table below shows additional software feature packages, extended functionality provided by them, the required prerequisites and additional licenses, if any.
| Name | Contents | Prerequisites | Minimal license level |
| advanced-tools | email client, pingers, netwatch and other utilities | none | 1 |
| arlan | support for DSSS 2.4GHz 2mbps Aironet ISA cards | none | 4 |
| dhcp | DHCP server and client support | none | 1 |
| gps | support for GPS devices | none | 1 |
| hotspot | HotSpot gateway | none | 1 |
| isdn | support for ISDN devices | ppp | 1 |
| lcd | support for informational LCD display | none | 1 |
| ntp | network time protocol support | none | 1 |
| ppp | support for PPP, PPTP, L2TP, PPPoE and ISDN PPP | none | 1 |
| radiolan | Provides support for 5.8GHz RadioLAN cards | none | 4 |
| routerboard | support for RouterBoard-specific functions and utilities | none | 1 |
| routing | support for RIP, OSPF and BGP4 | none | 3 |
| security | support for IPSEC, SSH and secure WinBox connections | none | 1 |
| synchronous | support for Frame Relay and Moxa C101, Moxa C502, Farsync, Cyclades PC300, LMC SBE and XPeed synchronous cards | none | 4 |
| telephony | IP telephony support (H.323) | none | 1 |
| ups | APC Smart Mode UPS support | none | 1 |
| web-proxy | HTTP Web proxy support | none | 3 |
| wireless | Provides support for Cisco Aironet cards, PrismII and Atheros wireless stations and APs | none | 4 (Wireless Station) / 5 (Wireless Access Point) |