Scripting Host

Document revision 2.7 (Thu Sep 22 13:33:55 GMT 2005)

This document applies to V2.9

Table of Contents
Table of Contents
Summary
Specifications
Related Documents
Console Command Syntax
Description
Notes
Example
Expression Grouping
Description
Notes
Example
Variables
Description
Notes
Example
Command Substitution and Return Values
Description
Example
Operators
Description
Command Description
Notes
Example
Data types
Description
Command Reference
Description
Command Description
Special Commands
Description
Notes
Example
Additional Features
Description
Script Repository
Description
Property Description
Command Description
Notes
Example

Page 1 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
Task Management
Description
Property Description
Example
Script Editor
Description
Command Description
Notes
Example

General Information

Summary

 
   

  
  
 
 

 
           


    
   


   
   
 
 !   
  
 



 
 "#$%  

 
  
&  
 

  
  

'  /ip firewall filter add chain=forward protocol=gre action=drop   
 
 
 
 '   
     :
    



 
       

'  
     '   
(

 '
  )   
  


Specifications
Packages required: system
License required: level1
Home menu level: /system script
Standards and Technologies: None
Hardware usage: Not significant

Related Documents

•   *   (


••  
• ) (

•   (

•   * (


Console Command Syntax

Description

Page 2 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
$
 
      
 '  
      

+

• prefix  
    
 
#$%'  : 
:put     
   
   
 '  / 

[admin@MikroTik] ip firewall mangle> /ping 10.0.0.1

• path        

 '  .. filter 

[admin@MikroTik] ip firewall mangle> .. filter print

• path_args     ,    

 '      
  

  
'  mylist 

[admin@MikroTik] ip firewall mangle> /routeing prefix-list list mylist

• action  
   
        
 '  add 

[admin@MikroTik] ip firewall mangle> /ip firewall filter add chain=forward action=drop

• unnamed parameter    ,   


   
 
   
 

'  
10.0.0.1 

[admin@MikroTik] ip firewall mangle> /ping 10.0.0.1

• name[=value]  ,
   
      '  ,' 
ssid=myssid 

/interface wireless set wlan1 ssid=myssid

Notes

-   
' 
 

  
   
  path_args

unnamed parameter   prefix' path' action
 name[=value]  
 

 '
  ' :put (1 + 2)   
 :("pu" . "t") 3 


Example

   

 
 
     
 
 
   +
/ping 10.0.0.1 count=5

prefix /
action ping
unnamed parameter 10.0.0.1
name[=value] count=5

.. ip firewall rule input

path .. ip firewall rule

path_args input

:for i from=1 to=10 do={:put $i}

Page 3 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
 prefix :
action for
unnamed parameter i
pname[=value] from=1 to=10 do={:put $i}

/interface monitor-traffic ether1,ether2,ipip1

prefix /
path interface
action monitor-traffic
unnamed parameter ether1,ether2,ipip1

Expression Grouping

Description

   
       
  

 
 '  

 

  ./ 0.

Notes

,
   
        
    
   $
 

   +
[admin@MikroTik] ip route> /user {
{... /ip route
{... print}
Flags: X - disabled
# NAME GROUP ADDRESS
0 ;;; system default user
admin full 0.0.0.0/0
1 uuu full 0.0.0.0/0
[admin@MikroTik] ip route>

!  

 
   
  /ip route'   
  

  
 

  '  print 
   
   /user print

Example

     
         user 

[admin@MikroTik] ip route> /user {
{... add name=x password=y group=write
{... add name=y password=z group=read
{... print}
Flags: X - disabled
# NAME GROUP ADDRESS
0 ;;; system default user
admin full 0.0.0.0/0
1 x write 0.0.0.0/0
2 y read 0.0.0.0/0
[admin@MikroTik] ip route>

Page 4 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
Variables

Description

  
 
          '     " &
  
"  
 
 
  &'   !    
 
  .1. " & 

  
          
 set
 unset 
       

  
   
 -  
      
 
' 
 ..
   !          
  
          

  +
• global - defined by global keyword, global variables can be accessed by all scripts and console
logins on the same router. However, global variables are not kept across reboots.
• local - defined by local keyword, local variables are not shared with any other script, other
instance of the same script or other console logins. The value of local variable value is lost
when script finishes.
• loop index variables - defined within for and foreach statements, these variables are used only
in do block of commands and are removed after command completes.
• monitor variables - some monitor commands that have do part can also introduce variables.
You can obtain a list of available variables by placing :environment print statement inside the
do block of commands.

2 


       
 set 
 #    

  + 

  
  
 
        #    
 

' .
 
  
:unset 
 #       ' .     #       ' .      

'  3  
  
  

Notes

4    5 5   

       


Example
[admin@MikroTik] ip route> /
[admin@MikroTik] > :global g1 "this is global variable"
[admin@MikroTik] > :put $g1
this is global variable
[admin@MikroTik] >

Command Substitution and Return Values

Description

 
 
        
    
 


  #
 
   
  
  
   
 
  

   
 
    
   
'    
 
,   
.6 7. 8 
 
 
     
           

Page 5 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
  
 


 
    
  ' 
  + find'  
 
 
  ' ping'  
 
   
' time'  
    
 ' incr
 decr'  

      '
 add'  
  




   

Example

$
     find 
+
[admin@MikroTik] > /interface
[admin@MikroTik] interface> find type=ether
[admin@MikroTik] interface>
[admin@MikroTik] interface> :put [find type=ether]
*1,*2
[admin@MikroTik] interface>

    
 

 

   )  '  
   
 


+
[admin@MikroTik] interface> enable [find type=ether]
[admin@MikroTik] interface>

Operators

Description

 
 
     
 
'   ' #* ' 

  
  
 
   ' 
  

 .".
 .&.   

  
    


Command Description
- - unary minus. Inverts given number value.
- - binary minus. Substracts two numbers, two time values, two IP addresses or an IP address and a
number
! - logical NOT. Unary operator, which inverts given boolean value
/ - division. Binary operator. Divides one number by another (gives number) or a time value by a
number (gives time value).
. - concatenation. Binary operator, concatenates two string or append one list to another or appends
an element to a list.
^ - bitwise XOR. The argumens and the result are both IP addresses
~ - bit inversion. Unary operator, which inverts bits in IP address
* - multiplication. Binary operator, which can multiply two numbers or a time value by a number.
& - bitwise AND The argumens and the result are both IP addresses
&& - logical AND. Binary operator. The argumens and the result are both logical values
+ - binary plus. Adds two numbers, two time values or a number and an IP address.

Page 6 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
< - less. Binary operator which compares two numbers, two time values or two IP addresses.
Returns boolean value
<< - left shift. Binary operator, which shifts IP address by a given amount of bits. The first
argument is an IP address, the second is an integer and the result is an IP address.
<= - less or equal. Binary operator which compares two numbers, two time values or two IP
addresses. Returns boolean value
> - greater. Binary operator which compares two numbers, two time values or two IP addresses.
Returns boolean value
>= - greater or equal. Binary operator which compares two numbers, two time values or two IP
addresses. Returns boolean value
>> - right shift. Binary operator, which shifts IP address by a given amount of bits. The first
argument is an IP address, the second is an integer and the result is an IP address.
| - bitwise OR. The argumens and the result are both IP addresses
|| - logical OR. Binary operator. The argumens and the result are both logical values

Notes

9
 
   
'       ,  
     
  , 

Example

   
   

[admin@MikroTik] ip firewall rule forward> :put (10+1-6*2=11-12=2+(-3)=-1)
false
[admin@MikroTik] ip firewall rule forward> :put (10+1-6*2=11-12=(2+(-3)=-1))
true
[admin@MikroTik] ip firewall rule forward

  )
[admin@MikroTik] interface> :put (!true)
false
[admin@MikroTik] interface> :put (!(2>3))
true
[admin@MikroTik] interface>


 

[admin@MikroTik] interface> :put (-1<0)
true
[admin@MikroTik] >
1

 


[admin@MikroTik] interface> :put (~255.255.0.0)

0.0.255.255
[admin@MikroTik] interface>


[admin@MikroTik] interface> :put (3ms + 5s)
00:00:05.003
[admin@MikroTik] interface> :put (10.0.0.15 + 0.0.10.0)
cannot add ip address to ip address

Page 7 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
 [admin@MikroTik] interface> :put (10.0.0.15 + 10)
10.0.0.25
[admin@MikroTik] interface>

 

[admin@MikroTik] interface> :put (15 - 10)

5
[admin@MikroTik] interface> :put (10.0.0.15 - 10.0.0.3)
12
[admin@MikroTik] interface> :put (10.0.0.15 - 12)
10.0.0.3
[admin@MikroTik] interface> :put (15h - 2s)
14:59:58
[admin@MikroTik] interface>

  

[admin@MikroTik] interface> :put (12s * 4)

00:00:48
[admin@MikroTik] interface> :put (-5 * -2)
10
[admin@MikroTik] interface>



[admin@MikroTik] interface> :put (10s / 3)

00:00:03.333
[admin@MikroTik] interface> :put (5 / 2)
2
[admin@MikroTik] interface>
[admin@MikroTik] > :put (0:0.10 / 3)
00:00:02
[admin@MikroTik] >

 

[admin@MikroTik] interface> :put (10.0.2.3<=2.0.3.10)

false
[admin@MikroTik] interface> :put (100000s>27h)
true
[admin@MikroTik] interface> :put (60s,1d!=1m,3600s)
true
[admin@MikroTik] interface> :put (bridge=routing)
false
[admin@MikroTik] interface> :put (yes=false)
false
[admin@MikroTik] interface> :put (true=aye)
false
[admin@MikroTik] interface>

  !):'   

[admin@MikroTik] interface> :put ((yes && yes) || (yes && no))
true
[admin@MikroTik] interface> :put ((no || no) && (no || yes))
false
[admin@MikroTik] interface>

 !):'  '  ;

[admin@MikroTik] interface> :put (10.16.0.134 & ~255.255.255.0)
0.0.0.134
[admin@MikroTik] interface>

   
[admin@MikroTik] interface> :put (~((0.0.0.1 << 7) - 1))

Page 8 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
 255.255.255.128
[admin@MikroTik] interface>

$
 


[admin@MikroTik] interface> :put (1 . 3)

13
[admin@MikroTik] interface> :put (1,2 . 3)
1,2,3
[admin@MikroTik] interface> :put (1 . 3,4)
13,4
[admin@MikroTik] interface> :put (1,2 . 3,4)
1,2,3,4
[admin@MikroTik] interface> :put ((1 . 3) + 1)
14
[admin@MikroTik] interface>

Data types

Description

  
 
  
     '   
' 
'
' 

 ' #* ' 



   
   

       
  '  
       
  
    


   

 +

• 
• 



•

• #* 
• 
• 

• 


#

  
 
       

    
   

  toarray'
tobool' toid' toip' tonum' tostr
 totime 

 
   
  list' boolean'
internal number' IP address' number' string  time

    

  
  <=  
 
'    
      

   

  >??@@A?B@<CD=AADCBC  >??@@A?B@<CD=AADCBA #    


  
   '   
   0x' +
[admin@MikroTik] > :global MyVar 0x10
[admin@MikroTik] > :put $MyVar
16
[admin@MikroTik] >

4         ,

    *
   
   


'     
 
  . 
 

E
  
  true  false $
    yes  true'
 no  false
#


   * 


Page 9 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
 
  
 
  
 FF+((+(
 
' +
[admin@MikroTik] > :put 01:12:1.01
01:12:01.010
[admin@MikroTik] >

  ,
 
'  
     
  
     " d   '
h  ' m  
' s  

 ms  
&' +
[admin@MikroTik] > :put 2d11h12
2d11:00:12
[admin@MikroTik] >

! 
 
'      
          


• d, day, days - one day, or 24 hours
• h, hour, hours - one hour
• m, min - one minute
• s - one second
• ms - one millisecond, id est 0.001 second
*     
+

 
          
+
[admin@MikroTik] > :put 0.1day1.2s
02:24:01.200
[admin@MikroTik] >

Command Reference

Description

  
  

 

  
 "#$%&   
  
 


 
   
 
 
 
 
'     
 
    


     #$%  
    
 .G.   .+. 
"  
       #$%   .+.  &'    +
[admin@MikroTik] > :
beep execute global list pick time toip typeof
delay find if local put toarray tonum while
do for led log resolve tobool tostr
environment foreach len nothing set toid totime
[admin@MikroTik] >

Command Description
beep - forces the built-in PC beeper to produce a signal for length seconds at frequency Hz.
(integer; default: 1000) - signal frequency measured in Hz (time; default: 100ms) - signal length
[admin@MikroTik] > :beep length=2s frequency=10000
[admin@MikroTik] >

delay - does nothing for a given amount of time. (time) - amount of time to wait
• omitted - delay forever

Page 10 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
do - executes commands repeatedly until given conditions are met. If no parameters are given, do
just executes its payload once, which does not make much use. If a logical condition is specified for
the while parameter, it will be evaluated after executing commands, and in case it is true, do
statement is executed again and again until false. The if parameter, if present, is evaluated only once
before doing anything else, and if it is false then no action is taken (text) - actions to execute
repeatedly (yes | no) - condition, which is evaluated each time after the execution of enclosed
statements (yes | no) - condition, which is evaluated once before the execution of enclosed
statements
[admin@MikroTik] > {:global i 10; :do {:put $i; :set i ($i - 1);} \
\... while (($i < 11) && ($i > 0)); :unset i;}
10
9
8
7
6
5
4
3
2
1
[admin@MikroTik] >

environment print - prints information about variables that are currently initialised. All global
variables in the system are listed under the heading Global Variables. All variables that are
introduced in the current script (variables introduced by :local or created by :for or :foreach
statements) are listed under the heading Local Variables.
$ 
   
   
   
[admin@MikroTik] > :local A "This is a local variable"
[admin@MikroTik] > :global B "This is a global one"
[admin@MikroTik] > :environment print
Global Variables
B=This is a global one
Local Variables
A=This is a local variable
[admin@MikroTik] >

find - searches for substring inside a string or for an element with particular value inside an array,
depending on argument types and returns position at which the value is found. The elements in list
and characters in string are numbered from 0 upwards (text | ) - the string or value list the search
will be performed in (text) - value to be searched for (integer) - position after which the search is
started
[admin@MikroTik] interface pppoe-server> :put [:find "13sdf1sdfss1sfsdf324333" ]
0
[admin@MikroTik] interface pppoe-server> :put [:find "13sdf1sdfss1sfsdf324333" 3 ]
1
[admin@MikroTik] interface pppoe-server> :put [:find "13sdf1sdfss1sfsdf324333" 3 3]
17
[admin@MikroTik] interface pppoe-server> :put [:find "1,1,1,2,3,3,4,5,6,7,8,9,0,1,2,3"
3 ]
4
[admin@MikroTik] interface pppoe-server> :put [:find "1,1,1,2,3,3,4,5,6,7,8,9,0,1,2,3"
3 3]
4
[admin@MikroTik] interface pppoe-server> :put [:find "1,1,1,2,3,3,4,5,6,7,8,9,0,1,2,3"
3 4]
5
[admin@MikroTik] interface pppoe-server> :put [:find "1,1,1,2,3,3,4,5,6,7,8,9,0,1,2,3"
3 5]
15
[admin@MikroTik]

Page 11 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
for - executes supplied commands over a given number of iterations, which is explicity set through
from and to parameters (name) - the name of the loop counter variable (integer) - start value of the
loop counter variable (integer) - end value of the loop counter variable (integer; default: 1) -
increment value. Depending on the loop counter variable start and end values, step parameter can be
treated also as decrement (text) - contains the command to be executed repeatedly
[admin@MikroTik] > :for i from=1 to=100 step=37 do={:put ($i . " - " . 1000/$i)}
1 - 1000
38 - 26
75 - 13
[admin@MikroTik] >

foreach - executes supplied commands for each element in list (name) - the name of the loop
counter variable () - list of values over which to iterate (text) - contains the command to be
executed repeatedly
*

      
      #* 
:foreach i in=[/interface find type=ether ] \
\... do={:put ("+--" . [/interface get $i name]); \
\... :foreach j in=[/ip address find interface=$i]
\... do={:put ("| `--" . [/ip address get $j address])}}
+--ether1
| `--1.1.1.3/24
| `--192.168.50.1/24
| `--10.0.0.2/24
+--ether2
| `--10.10.0.2/24
[admin@MikroTik] >

global - declares global variable (name) - name of the variable (text) - value, which should be
assigned to the variable
[admin@MikroTik] > :global MyString "This is a string"
[admin@MikroTik] > :global IPAddr 10.0.0.1
[admin@MikroTik] > :global time 0:10
[admin@MikroTik] > :environment print
Global Variables
IPAddr=10.0.0.1
time=00:10:00
MyString=This is a string
Local Variables
[admin@MikroTik] >

if - conditional statement. If a given logical condition evaluates to true then the do block of
commands is executed. Otherwice an optional else block is executed. (yes | no) - logical condition,
which is evaluated once before the execution of enclosed statements (text) - this block of commands
is executed if the logical condition evaluates to true (text) - this block of commands is executed if
the logical condition evaluates to false
$      
  
[admin@MikroTik] > :if ([:len [/ip firewall filter find]] > 0) do={:put true}
else={:put false}
true
[admin@MikroTik] >

$          #

   '  #*        10.0.0.254
[admin@MikroTik] > :if ([/ping 10.0.0.254 count=1] = 0) do {:put "gateway unreachable"}
10.0.0.254 ping timeout
1 packets transmitted, 0 packets received, 100% packet loss
gateway unreachable
[admin@MikroTik] >

led - allows to control the LEDs (Light Emitting Diodes) of the RouterBOARD 200 series

Page 12 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
embedded boards. This command is available only on RouterBoard 200 platform with the
routerboard package installed (yes | no) - controls first LED (yes | no) - controls second LED (yes |
no) - controls third LED (yes | no) - controls fourth LED (time) - specifies the length of the action
• omitted - altar LED state forever
 
4%: ?
 @  D 

[admin@MikroTik] > :led led2=yes led3=yes length=5s

len - returns the number of characters in string or the number of elements in list depending on the
type of the argument (name) - string or list the length of which should be returned
[admin@MikroTik] > :put [:len gvejimezyfopmekun]
17
[admin@MikroTik] > :put [:len gve,jim,ezy,fop,mek,un]
6
[admin@MikroTik] >

list - displays a list of all available console commands that match given search key(s) (text) - first
search key (text) - second search key (text) - third search key
:   
 
     hotspot' add
 user  
 
.

 
[admin@MikroTik] > :list user hotspot "add "
List of console commands under "/" matching "user" and "hotspot" and "add ":
ip hotspot profile add name= hotspot-address= dns-name= \
\... html-directory= rate-limit= http-proxy= smtp-server= \
\... login-by= http-cookie-lifetime= ssl-certificate= split-user-domain= \
\... use-radius= radius-accounting= radius-interim-update= copy-from=
ip hotspot user add server= name= password= address= mac-address= \
\... profile= routes= limit-uptime= limit-bytes-in= limit-bytes-out= \
\... copy-from= comment= disabled=
ip hotspot user profile add name= address-pool= session-timeout= \
\... idle-timeout= keepalive-timeout= status-autorefresh= \
\... shared-users= rate-limit= incoming-filter= outgoing-filter= \
\... incoming-mark= outgoing-mark= open-status-page= on-login= on-logout= copy-from=
[admin@MikroTik] >

local - declares local variable (name) - name of the variable (text) - value, which should be assigned
to the variable
[admin@MikroTik] > :local MyString "This is a string"
[admin@MikroTik] > :local IPAddr 10.0.0.1
[admin@MikroTik] > :local time 0:10
[admin@MikroTik] > :environment print
Global Variables
Local Variables
IPAddr=10.0.0.1
time=00:10:00
MyString=This is a string
[admin@MikroTik] >

log - adds a message specified by message parameter to the system logs. (name) - name of the
logging facility to send message to (text) - the text of the message to be logged

    info 
[admin@MikroTik] > :log info "Very Good thing happened. We have received our first
packet!"
[admin@MikroTik] > /log print follow
...
19:57:46 script,info Very Good thing happened. We have received our first packet!
...

nothing - has no action, and returns value of type "nothing". In conditions nothing behaves as
"false"

Page 13 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
*    
    

[admin@MikroTik] > :local string qwerty
[admin@MikroTik] > :if ([:pick $string 10]=[:nothing]) do={
{... :put "pick and nothing commands return the same value"}
pick and nothing commands return the same value
[admin@MikroTik] >

pick - returns a range of elements or a substring depending on the type of input value (text | ) - the
string or value list from which a substring or a subrange should be returned (integer) - start position
of substring or subrange (integer) - end position for substring or subrange
[admin@MikroTik] > :set a 1,2,3,4,5,6,7,8
[admin@MikroTik] > :put [:len $a]
8
[admin@MikroTik] > :put [:pick $a]
1
[admin@MikroTik] > :put [:pick $a 0 4]
1,2,3,4
[admin@MikroTik] > :put [:pick $a 2 4]
3,4
[admin@MikroTik] > :put [:pick $a 2]
3
[admin@MikroTik] > :put [:pick $a 5 1000000]
6,7,8
[admin@MikroTik] > :set a abcdefghij
[admin@MikroTik] > :put [:len $a]
10
[admin@MikroTik] > :put [:pick $a]
a
[admin@MikroTik] > :put [:pick $a 0 4]
abcd
[admin@MikroTik] > :put [:pick $a 2 4]
cd
[admin@MikroTik] > :put [:pick $a 2]
c
[admin@MikroTik] > :put [:pick $a 5 1000000]
fghij

put - echoes supplied argument to the console (text) - the text to be echoed to the console
:    (8  ether1 
 
[admin@MikroTik] > :put [/interface get ether1 mtu]
1500
[admin@MikroTik] >

resolve - returns IP address of the host resolved from the DNS name. The DNS settings should be
configured on the router (/ip dns submenu) prior to using this command. (text) - domain name to be
resolved into an IP address
:) 
 

 resolve 
   
[admin@MikroTik] ip route> /ip dns set primary-dns=159.148.60.2
[admin@MikroTik] ip route> :put [:resolve www.example.com]
192.0.34.166

set - assigns new value to a variable (name) - the name of the variable (text) - the new value of the
variable
( 
 
     
[admin@MikroTik] > :put [:time [:resolve www.example.com ]]
00:00:00.006
[admin@MikroTik] >

time - measures the amount of time needed to execute given console commands (text) - the console

Page 14 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
commands to measure execution time of
( 
 
     
[admin@MikroTik] > :put [:time [:resolve www.example.com ]]
00:00:00.006
[admin@MikroTik] >

while - executes given console commands repeatedly while the logical conditions is true (yes | no) -
condition, which is evaluated each time before the execution of enclosed statements (text) - console
commands that should be executed repeatedly
[admin@MikroTik] > :set i 0; :while ($i < 10) do={:put $i; :set i ($i + 1)};
0
1
2
3
4
5
6
7
8
9
[admin@MikroTik] >

Special Commands

Description

Monitor

#          

  monitor 
    ! monitor 

    do   
     
 " /system scripts&'  
 
 
 

Get

( print 

            print 
  
 

 get 
 
   
   get 
   
   


          

  

Notes

(
 
  do 
 
        # 
 


 
'
3    
 


       
   get      
 print 
' 

     "    

    & 2 
 6 7   
  
   
   get 




Example

#
     monitor 
   
      
   
 
'
 
 
 
            
+

Page 15 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
 [admin@MikroTik] interface> monitor-traffic ether2 once do={:environment print}
received-packets-per-second: 0
received-bits-per-second: 0bps
sent-packets-per-second: 0
sent-bits-per-second: 0bps
Global Variables
i=1
Local Variables
sent-bits-per-second=0
received-packets-per-second=0
received-bits-per-second=0
sent-packets-per-second=0
[admin@MikroTik] interface>

Additional Features

Description

 
 
 
 
      .H. #

         .H.    

 

     


    
 

 
      .I. $
   .I.   
  
 

 

!
   {}[]"'\$        
,  
  .J.    $
  

   
 .J.  '  


    

  '       +
\a bell (alarm), character code 7
\b backspace, character code 8
\f form feed, character code 12
\n newline, character code 10
\r carriage return, character code 13
\t tabulation, character code 9
\v vertical tabulation, character code 11
\_ space, character code 32

Note   .J.'  

 
       " '

'    
'
  
&'  

     
  '    
 ,'     


     
     
 
 
  
     


Script Repository
Home menu level: /system script

Description

!     
 /system script 
 
    
 
   
'
  
'
         
 
     

#
'           
 
  +

•   
• 

 
     ' 
   
 

 
   

  
  

• 
  

Page 16 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
#         
   /system script run 


Property Description
last-started (time) - date and time when the script has been last invoked. The argument is shown
only if the run-count!=0.
owner (name; default: admin) - the name of the user who created the script
policy (multiple choice: ftp | local | policy | read | reboot | ssh | telnet | test | web | write; default:
reboot,read,write,policy,test) - the list of the policies applicable:
• ftp - user can log on remotely via ftp and send and retrieve files from the router
• local - user can log on locally via console
• policy - manage user policies, add and remove user
• read - user can retrieve the configuration
• reboot - user can reboot the router
• ssh - user can log on remotely via secure shell
• telnet - user can log on remotely via telnet
• test - user can run ping, traceroute, bandwidth test
• web - user can log on remotely via http
• write - user can retrieve and change the configuration
run-count (integer; default: 0) - script usage counter. This counter is incremented each time the
script is executed. The counter will reset after reboot.
source (text; default: "") - the script source code itself

Command Description
run (name) - executes a given script (name) - the name of the script to execute

Notes

2 

   
  
       
  '   '  

 
   K   '      
/user group   
ssh,local,telnet,read,write,policy,test,web
    
   
' 



         

Example

 
        
   5F 9L5   info +
[admin@MikroTik] system script> add name="log-test" source={:log info "Hello World!"}
[admin@MikroTik] system script> run log-test
[admin@MikroTik] system script> print
0 name="log-test" owner="admin"
policy=ftp,reboot,read,write,policy,test,winbox,password last-started=mar/20/2001
22:51:41
run-count=1 source=:log info "Hello World!"
[admin@MikroTik] system script>

Page 17 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
Task Management
Home menu level: /system script job

Description

      

      

Property Description
name (read-only: name) - the name of the script to be referenced when invoking it
owner (text) - the name of the user who created the script
source (read-only: text) - the script source code itself

Example
[admin@MikroTik] system script> job print
# SCRIPT OWNER STARTED
0 DelayeD admin dec/27/2003 11:17:33
[admin@MikroTik] system script>

2 

  
    
    3 
[admin@MikroTik] system script> job remove 0
[admin@MikroTik] system script> job print
[admin@MikroTik] system script>

Script Editor
Command name: /system script edit

Description

 
     
        
   


Keyboard Shortcuts

• Delete - deletes character at cursor position

• Ctrl+h, backspase - deletes character before cursor. Unindents line
• Tab - indents line
• Ctrl+b, LeftArrow - moves cursor left
• Ctrl+f, RightArrow - moves cursor right
• Ctrl+p, UpArrow - moves cursor up
• Ctrl+n, DownArrow - moves cursor down
• Ctrl+a, Home - moves cursor to the beginning of line or script
• Ctrl+e, End - moves cursor to the end of line or script

Page 18 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.
 • Ctrl+y - inserts contents of buffer at cursor position
• Ctrl+k - deletes characters from cursor position to the end of line
• Ctrl+u - undoes last action
• Ctrl+o - exits editor accepting changes
• Ctrl+x - exits editor discarding changes

Command Description
edit (name) - opens the script specified by the name argument in full-screen editor

Notes

!         backspace, delete  Ctrl+k     

 
*

   
 
    "Ctrl+y 
 . 

&'
 
  
  
    . 

 8
 
. 
 

   

    

 
-MB?   
 "

 5MB?5' 5
 5' 5 5' 5 5 

N  -MB?   
& :'   
   
    

 '  .$. 
 
  

Example

 
         
        
+

      

   55
 @   55    

Page 19 of 19
Copyright 1999-2006, MikroTik. All rights reserved. Mikrotik, RouterOS and RouterBOARD are trademarks of Mikrotikls SIA.
Other trademarks and registred trademarks mentioned herein are properties of their respective owners.