Manual:Winbox

From MikroTik Wiki
Revision as of 15:55, 12 April 2010 by Marisb (talk | contribs)
Jump to: navigation, search

Summary

Winbox is a small utility that allows administration of Mikrotik RouterOS using a fast and simple GUI. It is a native Win32 binary, but can be run on Linux and Mac OSX using Wine.

All Winbox interface functions are as close as possible to Console functions, that is why there are no Winbox sections in the manual.

Some of advanced and system critical configurations are not possible from winbox, like MAC address change on an interface.

Starting the Winbox

Winbox loader can be downloaded directly from the router.

Open your browser and enter router's IP address, RouterOS welcome page will be displayed. Click on the link to download winbox.exe

Win-web-snap.png

When winbox.exe is downloaded, double click on it and winbox loader window will pop up:

Winbox-loader.png

To connect to the router enter IP or MAC address of the router, specify username and password (if any) and click on Connect button.

Icon-note.png

Note: It is recommended to use IP address whenever possible. MAC session uses network broadcasts and is not 100% reliable.


You can also use neighbor discovery, to list available routers by clicking on [...] button:

Winbox-loader2.png

From list of discovered routers you can click on IP or MAC address column to connect to that router. If you click on IP address then IP will be used to connect, but if you click on MAC Address then MAC address will be used to connect to the router.

Icon-note.png

Note: Neighbor discovery will show also devices which are not compatible with Winbox, like Cisco routers or any other device that uses CDP (Cisco Discovery Protocol)



Description of buttons and fields of loader screen

  • [...] - discovers and shows MNDP (MikroTik Neighbor Discovery Protocol) or CDP (Cisco Discovery Protocol) devices.
  • Connect - Connect to the router
  • Save - Save address, login, password and note. Saved entries are listed at the bottom of loader window.
  • Remove - Remove selected entry from saved list
  • Tools... - Allows to run various tools: removes all items from the list, clears cache on the local disk, imports addresses from wbx file or exports them to wbx file.


  • Connect To: - destination IP or MAC address of the router
  • Login - username used for authentication
  • Password - password used for authentication
  • Keep Password - if unchecked, password is not saved to the list
  • Secure Mode - if checked, winbox will use TLS encryption to secure session
  • Load Previous Session - if checked, winbox will try to restore all previously opened windows.
  • Note - description of the router that will be saved to the list.

Icon-warn.png

Warning: Passwords are saved in plain text. Anyone with access to your file system will be able to retrieve passwords.


Interface Overview

Winbox interface has been designed to be intuitive for most of the users. Interface consists of:

  • Main toolbar at the top where users ca add various info fields, like CPU and memory usage.
  • Menu bar on the left - list of all available menus and sub-menus. This list changes depending on what packages are installed. For example if IPv6 package is disabled, then IPv6 menu and all it's sub-menus will not be displayed.
  • Work area - area where all menu windows are opened.

Winbox-workarea.png

Title bar shows information to identify with which router Winbox session is opened. Information is displayed in following format:

[username]@[Router's IP or MAC] ( [RouterID] ) - Winbox [ROS version] on [RB model] ([platform])

From screenshot above we can see that user admin is logged into router with IP address 10.1.101.18. Router's ID is MikroTik, currently installed RouterOS version is v5.0beta1, RouterBoard is RB800 and platform is PowerPC.

On the Main toolbar's left side is located undo and redo buttons to quickly undo any changes made to configuration. On the right side is located:

  • winbox traffic indicator displayed as a green bar,
  • indicator that shows whether winbox session uses TLS encryption
  • checkbox Hide password. This checkbox replaces all sensitive information (for example, ppp secret passwords) with '*' asterisk symbols.

Work Area and child windows

Winbox has MDI interface meaning that all menu configuration (child) widows are attached to main (parent) Winbox window and are showed in work area.

Winbox-win-child.png

Child windows can not be dragged out of working area. Notice in screenshot above that Interface window is dragged out of visible working area and horizontal scroll bar appeared at the bottom. If any window is outside visible work area boundaries the vertical or/and horizontal scrollbars will appear.

Child window menu bar

Each child window has its own toolbar. Most of the windows have the same set of toolbar buttons:

  • add -
  • remove -
  • enable -
  • disable -
  • comment -
  • sort -

Almost all windows have quick search input field at the right side of the toolbar. Any text entered in this field is searched through all the items and highlighted as illustrated in screenshot below

Winbox-window-search.png

Sorting of displayed items

Customizing list of displayed columns


Transferring Settings

On Windows Vista/7 Winbox settings are stored in:  %USERPROFILE%\AppData\Roaming\Mikrotik\Winbox\winbox.cfg

Simply copy this file to the same location on the new host.