Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description of menu items in loader screen.

--File

  • New - Create new managed router list in specified location;
  • Open - Open managed router list file;
  • Save As - Save current managed router list to file;
  • Exit - Exit Winbox loader.

--Tools

  • Advanced Mode - Enables/Disables advanced mode view;
  • Import - Imports saved session file;
  • Export - Exports saved session file;
  • Move Session Folder - Change path where session files are stored;
  • Clear cache - Clear Winbox cache;
  • Check For Updates - Check for Winbox loader updates.

...

Example: admin+c80w - will disable console colors and set terminal width to 80.

ParamDefaultImplicitDescription
"w"autoautoSet terminal width
"h"autoautoSet terminal height
"c"onoffdisable/enable console colors
"t"onoffdDo auto detection of terminal capabilities
"e"onoffEnables "dumb" terminal mode

Banner and Messages

Login process will display MikroTik banner and short help after validating user name and password.

...

There are some commands that are common to nearly all menu levels, namely: print, set, remove, add, find, get, export, enable, disable, comment, move. These commands have similar behavior throughout different menu levels.

PropertyDescription
addThis command usually has all the same arguments as set, except the item number argument. It adds a new item with the values you have specified, usually at the end of the item list, in places where the order of items is relevant. There are some required properties that you have to supply, such as the interface for a new address, while other properties are set to defaults unless you explicitly specify them.

Common Parameters

  • copy-from - Copies an existing item. It takes default values of new item's properties from another item. If you do not want to make exact copy, you can specify new values for some properties. When copying items that have names, you will usually have to give a new name to a copy
  • place-before - places a new item before an existing item with specified position. Thus, you do not need to use the move command after adding an item to the list
  • disabled - controls disabled/enabled state of the newly added item(-s)
  • comment - holds the description of a newly created item

Return Values

  • add command returns internal number of item it has added
editThis command is associated with the set command. It can be used to edit values of properties that contain large amount of text, such as scripts, but it works with all editable properties. Depending on the capabilities of the terminal, either a fullscreen editor, or a single line editor is launched to edit the value of the specified property.
findThe find command has the same arguments as set, plus the flag arguments like disabled or active that take values yes or no depending on the value of respective flag. To see all flags and their names, look at the top of print command's output. The find command returns internal numbers of all items that have the same values of arguments as specified.
moveChanges the order of items in list. Parameters:
  • first argument specifies the item(-s) being moved.
  • second argument specifies the item before which to place all items being moved (they are placed at the end of the list if the second argument is omitted).
printhows all information that\'s accessible from particular command level. Thus, /system clock print shows system date and time, /ip route print shows all routes etc. If there\'s a list of items in current level and they are not read-only, i.e. you can c hange/remove them (example of read-only item list is /system history, which shows history of executed actions), then print command also assigns numbers that are used by all commands that operate with items in this list.

Common Parameters:

  • from - show only specified items, in the same order in which they are given.
  • where - show only items that match specified criteria. The syntax of where property is similar to the find command.
  • brief - forces the print command to use tabular output form
  • detail - forces the print command to use property=value output form
  • count-only - shows the number of items
  • file - prints the contents of the specific submenu into a file on the router.
  • interval - updates the output from the print command for every interval seconds.
  • oid - prints the OID value for properties that are accessible from SNMP
  • without-paging - prints the output without stopping after each screenful.
removeRemoves specified item(-s) from a list.
setAllows you to change values of general parameters or item parameters. The set command has arguments with names corresponding to values you can change. Use ? or double Tab to see list of all arguments. If there is a list of items in this command level, then set has one action argument that accepts the number of item (or list of numbers) you wish to set up. This command does not return anything.


Input Modes

It is possible to switch between several input modes:

  • Normal mode - indicated by normla command prompt.
  • Safe mode - safe mode is indicated by a word SAFE after command prompt. In this mode configuration is saved to disk only after safe mod eis turned off. Safe mode can bet turned on/off with Ctrl+c
  • Hotlock mode - indicated by additional yellow >. Hotlock mode auto completes commands and can be turned on/off with Ctrl+v

List of Keys

KeyDescription
Control-Ckeyboard interrupt
Control-Dlog out (if input line is empty)
Control-Kclear from cursor to the end of line
Control-Xtoggle safe mode
Control-Vtoggle hotlock mode mode
F6toggle cellar
F1or?show context sensitive help. If the previous character is \, then inserts literal ?.
Tabperform line completion. When pressed second time, show possible completions.
Deleteremove character at cursor
Control-HorBackspaceremove character before cursor and move cursor back one position.
Control-\split line at cursor. Insert newline at cursor position. Display second of the two resulting lines.
Control-BorLeftmove cursor backwards one character
Control-ForRightmove cursor forward one character
Control-PorUpgo to previous line. If this is the first line of input then recall previous input from history.
Control-NorDowngo to next line. If this is the last line of input then recall next input from history
Control-AorHomemove cursor to the beginning of the line. If cursor is already at the beginning of the line, then go to the beginning of the first line of current input
Control-EorEndmove cursor to the end of line. If cursor is already at the end of line, then move it to the end of the last line of current input
Control-LorF5reset terminal and repaint screen