Manual:Scripting: Difference between revisions
(51 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{Versions| | {{Versions| any}} | ||
==Scripting language manual== | |||
This manual provides introduction to RouterOS built-in powerful scripting language. | This manual provides introduction to RouterOS built-in powerful scripting language. | ||
Scripting host provides a way to automate some router maintenance tasks by means of executing user-defined scripts bounded to some event occurrence. | Scripting host provides a way to automate some router maintenance tasks by means of executing user-defined scripts bounded to some event occurrence. | ||
Scripts can be stored in [[#Script_repository|Script repository]] or can be written directly to [[M:Console|console]]. | Scripts can be stored in [[#Script_repository|Script repository]] or can be written directly to [[M:Console|console]]. | ||
The events used to trigger script execution include, but are not limited to the [[M:System/Scheduler | System Scheduler]], the [[Manual:Tools/Traffic_Monitor | Traffic Monitoring Tool]], and the [[M:Tools/Netwatch | Netwatch Tool]] generated events. | The events used to trigger script execution include, but are not limited to the [[M:System/Scheduler | System Scheduler]], the [[Manual:Tools/Traffic_Monitor | Traffic Monitoring Tool]], and the [[M:Tools/Netwatch | Netwatch Tool]] generated events. | ||
===Line structure=== | ===Line structure=== | ||
RouterOS script is divided into number of command lines. Command lines are executed one by one until the end of script or until a runtime error occurs. | |||
====Command line==== | ====Command line==== | ||
RouterOS console uses following command syntax: | RouterOS console uses following command syntax: | ||
<code>[prefix] [path] command [uparam] [param=[value]] .. [param=[value]]</code> | <code>[prefix] [path] command [uparam] [param=[value]] .. [param=[value]]</code> | ||
<ul class="bullets"> | <ul class="bullets"> | ||
Line 28: | Line 27: | ||
<li>[uparam] - unnamed parameter, must be specified if command requires it. | <li>[uparam] - unnamed parameter, must be specified if command requires it. | ||
<li>[params] - sequence of named parameters followed by respective values | <li>[params] - sequence of named parameters followed by respective values | ||
</ul> | </ul> | ||
The end of command line is represented by the token <i>“;”</i> or <i>NEWLINE</i>. Sometimes <i>“;”</i> or <i>NEWLINE</i> is not required to end the command line. | |||
The end of command line is represented by the token <i>“;”</i> or <i>NEWLINE</i>. Sometimes <i>“;”</i> or <i>NEWLINE</i> is not required to end the command line. | |||
Single command inside <code>(), [] or {}</code> does not require any end of command character. End of command is determined by content of whole script | Single command inside <code>(), [] or {}</code> does not require any end of command character. End of command is determined by content of whole script | ||
Line 47: | Line 47: | ||
Command line can be constructed from more than one physical line by following [[#Line_joining|line joining rules]]. | Command line can be constructed from more than one physical line by following [[#Line_joining|line joining rules]]. | ||
====Physical Line==== | ====Physical Line==== | ||
Line 104: | Line 104: | ||
} | } | ||
</nowiki></pre> | </nowiki></pre> | ||
Whitespace are not allowed | Whitespace characters are not allowed | ||
<ul class="bullets"> | <ul class="bullets"> | ||
<li>between '<nowiki><parameter></nowiki>=' | <li>between '<nowiki><parameter></nowiki>=' | ||
Line 139: | Line 139: | ||
=====Local scope===== | =====Local scope===== | ||
<p> | <p> | ||
User can define | User can define their own groups to block access to certain variables, these scopes are called local scopes. Each local scope is enclosed in curly braces ("{ }"). | ||
<pre> | <pre> | ||
{ | { | ||
Line 147: | Line 147: | ||
:put ($a+$b); | :put ($a+$b); | ||
} | } | ||
#line below will | #line below will show variable b in light red color since it is not defined in scope | ||
:put ($a+$b); | :put ($a+$b); | ||
} | } | ||
Line 184: | Line 184: | ||
The following words are keywords and cannot be used as variable and function names: | The following words are keywords and cannot be used as variable and function names: | ||
<pre><nowiki> | <pre><nowiki> | ||
and or | and or in | ||
</nowiki></pre> | </nowiki></pre> | ||
<!-- | <!-- | ||
Line 213: | Line 213: | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td ><b><var>number</var></b></td> | <td ><b><var>num (number)</var></b></td> | ||
<td >- 64bit signed integer, possible hexadecimal input;</td> | <td >- 64bit signed integer, possible hexadecimal input;</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td ><b><var>boolean</var></b></td> | <td ><b><var>bool (boolean)</var></b></td> | ||
<td >- values can bee <code>true</code> or <code>false</code>;</td> | <td >- values can bee <code>true</code> or <code>false</code>;</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td ><b><var>string</var></b></td> | <td ><b><var>str (string)</var></b></td> | ||
<td >- character sequence;</td> | <td >- character sequence;</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td ><b><var> | <td ><b><var>ip</var></b></td> | ||
<td >- IP address;</td> | <td >- IP address;</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td ><b><var>internal ID</var></b></td> | <td ><b><var>ip-prefix</var></b></td> | ||
<td >- IP prefix;</td> | |||
</tr> | |||
<tr> | |||
<td ><b><var>ip6</var></b></td> | |||
<td >- IPv6 address</td> | |||
</tr> | |||
<tr> | |||
<td ><b><var>ip6-prefix</var></b></td> | |||
<td >- IPv6 prefix</td> | |||
</tr> | |||
<tr> | |||
<td ><b><var>id (internal ID)</var></b></td> | |||
<td >- hexadecimal value prefixed by '*' sign. Each menu item has assigned unique number - internal ID;</td> | <td >- hexadecimal value prefixed by '*' sign. Each menu item has assigned unique number - internal ID;</td> | ||
</tr> | </tr> | ||
Line 331: | Line 343: | ||
<table class="styled_table"> | <table class="styled_table"> | ||
<tr> | <tr> | ||
<th width="100"> | <th width="100">Operator</th> | ||
<th width="300">Description</th> | <th width="300">Description</th> | ||
<th >Example</th> | <th >Example</th> | ||
Line 354: | Line 366: | ||
<td>binary division</td> | <td>binary division</td> | ||
<td><code>:put (10 / 2); :put ((10)/2)</code></td> | <td><code>:put (10 / 2); :put ((10)/2)</code></td> | ||
</tr> | |||
<tr> | |||
<td><b><var>"%"</var></b></td> | |||
<td>modulo operation</td> | |||
<td><code>:put (5 % 3);</code></td> | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 370: | Line 387: | ||
<table class="styled_table"> | <table class="styled_table"> | ||
<tr> | <tr> | ||
<th width="100"> | <th width="100">Operator</th> | ||
<th width="300">Description</th> | <th width="300">Description</th> | ||
<th>Example</th> | <th>Example</th> | ||
Line 412: | Line 429: | ||
<table class="styled_table"> | <table class="styled_table"> | ||
<tr> | <tr> | ||
<th width="100"> | <th width="100">Operator</th> | ||
<th width="300">Description</th> | <th width="300">Description</th> | ||
<th >Example</th> | <th >Example</th> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“!” | <td><b><var>“!”</var></b></td> | ||
<td>logical NOT</td> | <td>logical NOT</td> | ||
<td><code>:put (!true);</code></td> | <td><code>:put (!true);</code></td> | ||
Line 440: | Line 457: | ||
====Bitwise Operators==== | ====Bitwise Operators==== | ||
Bitwise operators are working on number and | Bitwise operators are working on number, IP and IPv6 address [[#Data_types|data types]]. | ||
<table class="styled_table"> | <table class="styled_table"> | ||
<tr> | <tr> | ||
<th width="100 | <th width="100">Operator</th> | ||
<th width="300 | <th width="300">Description</th> | ||
<th | <th>Example</th> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“~”</var></b></td> | <td><b><var>“~”</var></b></td> | ||
<td>bit inversion</td> | <td>bit inversion</td> | ||
<td><code>:put (~0.0.0.0)</code></td> | <td><code>:put (~0.0.0.0)</code><br/><code>:put (~::ffff)</code></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“|”</var></b></td> | <td><b><var>“|”</var></b></td> | ||
<td>bitwise OR. Performs logical OR operation on each pair of corresponding bits. In each pair the result is “1” if one of bits or both bits are “1”, otherwise the result is “0”.</td> | <td>bitwise OR. Performs logical OR operation on each pair of corresponding bits. In each pair the result is “1” if one of bits or both bits are “1”, otherwise the result is “0”.</td> | ||
<td><code></code></td> | <td><code>:put (192.168.88.0|0.0.0.255)</code><br/><code>:put (2001::1|::ffff)</code></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“^”</var></b></td> | <td><b><var>“^”</var></b></td> | ||
<td>bitwise XOR. The same as OR, but the result in each position is “1” if two bits are not equal, and “0” if bits are equal.</td> | <td>bitwise XOR. The same as OR, but the result in each position is “1” if two bits are not equal, and “0” if bits are equal.</td> | ||
<td><code></code></td> | <td><code>:put (1.1.1.1^255.255.0.0)</code><br/><code>:put (2001::ffff:1^::ffff:0)</code></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“&”</var></b></td> | <td><b><var>“&”</var></b></td> | ||
<td>bitwise AND. In each pair the result is “1” if first and second bit is “1”. Otherwise the result is “0”.</td> | <td>bitwise AND. In each pair the result is “1” if first and second bit is “1”. Otherwise the result is “0”.</td> | ||
<td><code></code></td> | <td><code>:put (192.168.88.77&255.255.255.0)</code><br/><code>:put (2001::1111&ffff::)</code></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“<<”</var></b></td> | <td><b><var>“<<”</var></b></td> | ||
<td>left shift by given amount of bits</td> | <td>left shift by given amount of bits, not supported for IPv6 address data type</td> | ||
<td><code></code></td> | <td><code>:put (192.168.88.77<<8)</code></td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
<td><b><var>“>>”</var></b></td> | <td><b><var>“>>”</var></b></td> | ||
<td>right shift by given amount of bits</td> | <td>right shift by given amount of bits, not supported for IPv6 address data type</td> | ||
<td><code></code></td> | <td><code>:put (192.168.88.77>>24)</code></td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
</ | |||
Calculate subnet address from given IP and CIDR Netmask using "&" operator: | |||
<pre> | |||
{ | |||
:local IP 192.168.88.77; | |||
:local CIDRnetmask 255.255.255.0; | |||
:put ($IP&$CIDRnetmask); | |||
} | |||
</pre> | |||
Get last 8 bits from given IP addresses: | |||
<pre> | |||
:put (192.168.88.77&0.0.0.255); | |||
</pre> | |||
Use "|" operator and inverted CIDR mask to calculate the broadcast address: | |||
<pre> | |||
{ | |||
:local IP 192.168.88.77; | |||
:local Network 192.168.88.0; | |||
:local CIDRnetmask 255.255.255.0; | |||
:local InvertedCIDR (~$CIDRnetmask); | |||
:put ($Network|$InvertedCIDR) | |||
} | |||
</pre> | |||
====Concatenation Operators==== | ====Concatenation Operators==== | ||
<table class="styled_table"> | <table class="styled_table"> | ||
<tr> | <tr> | ||
<th width="100"> | <th width="100">Operator</th> | ||
<th width="300">Description</th> | <th width="300">Description</th> | ||
<th>Example</th> | <th>Example</th> | ||
Line 501: | Line 544: | ||
</tr> | </tr> | ||
</table> | </table> | ||
It is possible to add variable values to strings without concatenation operator: | It is possible to add variable values to strings without concatenation operator: | ||
<pre> | <pre> | ||
Line 520: | Line 564: | ||
</pre> | </pre> | ||
====Other Operators==== | |||
<table class="styled_table"> | <table class="styled_table"> | ||
<tr> | <tr> | ||
<th width="100"> | <th width="100">Operator</th> | ||
<th width="300">Description</th> | <th width="300">Description</th> | ||
<th>Example</th> | <th>Example</th> | ||
Line 550: | Line 592: | ||
<td>binary operator that matches value against POSIX extended regular expression</td> | <td>binary operator that matches value against POSIX extended regular expression</td> | ||
<td>Print all routes which gateway ends with 202<br /> | <td>Print all routes which gateway ends with 202<br /> | ||
<code>/ip route print where gateway~"^[0-9 \\.]*202"</code></td> | <code>/ip route print where gateway~"^[0-9 \\.]*202\$"</code></td> | ||
</tr> | |||
<td><b><var>“->”</var></b></td> | |||
<td>Get an array element by key</td> | |||
<td><pre>[admin@x86] >:global aaa {a=1;b=2} | |||
[admin@x86] > :put ($aaa->"a") | |||
1 | |||
[admin@x86] > :put ($aaa->"b") | |||
2</pre></td> | |||
</tr> | </tr> | ||
</table> | </table> | ||
===Variables=== | ===Variables=== | ||
Scripting language has two types of variables: | Scripting language has two types of variables: | ||
<ul class="bullets"> | <ul class="bullets"> | ||
Line 562: | Line 611: | ||
<li> <var>local</var> - accessible only within the current [[#Scopes|scope]], defined by [[#Global_commands|local]] keyword. | <li> <var>local</var> - accessible only within the current [[#Scopes|scope]], defined by [[#Global_commands|local]] keyword. | ||
</ul> | </ul> | ||
{{Note | Starting from v6.2 there can be undefined variables. When variable is undefined parser will try to look for variables set, for example, by [[M:IP/DHCP_Server | DHCP]] <var>lease-script</var> or [[Hotspot]] <var>on-login</var> }} | |||
{{Note | Variable value size is limited to 4096bytes }} | |||
Every variable, except for built in RouterOS variables, must be declared before usage by local or global keywords. Undefined variables will be marked as undefined and will result in compilation error. | Every variable, except for built in RouterOS variables, must be declared before usage by local or global keywords. Undefined variables will be marked as undefined and will result in compilation error. | ||
Example: | Example: | ||
Line 569: | Line 621: | ||
:put $myVar | :put $myVar | ||
</pre> | </pre> | ||
Correct code: | Correct code: | ||
<pre> | <pre> | ||
Line 575: | Line 628: | ||
:put $myVar; | :put $myVar; | ||
</pre> | </pre> | ||
Exception is when using variables set, for example, by DHCP <var>lease-script</var> | |||
<pre> | |||
/system script | |||
add name=myLeaseScript policy=\ | |||
ftp,reboot,read,write,policy,test,winbox,password,sniff,sensitive,api \ | |||
source=":log info \$leaseActIP\r\ | |||
\n:log info \$leaseActMAC\r\ | |||
\n:log info \$leaseServerName\r\ | |||
\n:log info \$leaseBound" | |||
/ip dhcp-server set myServer lease-script=myLeaseScript | |||
</pre> | |||
Valid characters in variable names are letters and digits. If variable name contains any other character, then variable name should be put in double quotes. Example: | Valid characters in variable names are letters and digits. If variable name contains any other character, then variable name should be put in double quotes. Example: | ||
<pre> | <pre> | ||
Line 603: | Line 670: | ||
</pre> | </pre> | ||
</ | Set command without value will un-define the variable (remove from environment, new in v6.2) | ||
<pre> | |||
#remove variable from environment | |||
:global myVar "myValue" | |||
:set myVar; | |||
</pre> | |||
==== Reserved variable names==== | |||
All built in RouterOS properties are reserved variables. Variables which will be defined the same as the RouterOS built in properties can cause errors. To avoid such errors, use custom designations. | |||
For example, following script will not work: | |||
<pre> | |||
{ | |||
:local type "ether1"; | |||
/interface print where name=$type; | |||
} | |||
</pre> | |||
But will work with different defined variable: | |||
<pre> | |||
{ | |||
:local customname "ether1"; | |||
/interface print where name=$customname; | |||
} | |||
</pre> | |||
===Commands=== | ===Commands=== | ||
Line 723: | Line 813: | ||
<td>Generate console error and stop executing the script</td> | <td>Generate console error and stop executing the script</td> | ||
<td><code></code></td> | <td><code></code></td> | ||
</tr> | |||
<tr> | |||
<td><b><var>execute</var></b></td> | |||
<td><code><nowiki>:execute <expression> </nowiki></code></td> | |||
<td>Execute the script in background.</td> | |||
<td><pre>{ | |||
:local j [:execute {/interface print follow where [:log info ~Sname~]}]; | |||
:delay 10s; | |||
:do { /system script job remove $j } on-error={} | |||
}</pre></td> | |||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 852: | Line 952: | ||
<td><b><var>find</var></b></td> | <td><b><var>find</var></b></td> | ||
<td><code><nowiki> find <expression></nowiki></code></td> | <td><code><nowiki> find <expression></nowiki></code></td> | ||
<td> | <td>Returns list of internal numbers for items that are matched by given expression. For example: <code> :put [/interface find name~"ether"]</code></td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 880: | Line 980: | ||
<tr> | <tr> | ||
<td><b><var>as-value</var></b></td> | <td><b><var>as-value</var></b></td> | ||
<td>print output as array of parameters and its values</td> | <td>print output as an array of parameters and its values</td> | ||
<td><code><nowiki>:put [/ip address print as-value]</nowiki></code></td> | <td><code><nowiki>:put [/ip address print as-value]</nowiki></code></td> | ||
</tr> | </tr> | ||
Line 972: | Line 1,072: | ||
<td><b><var>foreach</var></b></td> | <td><b><var>foreach</var></b></td> | ||
<td><code><nowiki>:foreach <var> in=<array> do={ <commands> };</nowiki></code></td> | <td><code><nowiki>:foreach <var> in=<array> do={ <commands> };</nowiki></code></td> | ||
<td>execute commands for each | <td>execute commands for each element in a list</td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
Line 1,000: | Line 1,100: | ||
</pre> | </pre> | ||
</p> | </p> | ||
===Functions=== | |||
Scripting language does not allow to create functions directly, however you could use :parse command as a workaround. | |||
Starting from v6.2 new syntax is added to easier define such functions and even pass parameters. | |||
It is also possible to return function value with ''':return''' command. | |||
See examples below: | |||
<pre> | |||
#define function and run it | |||
:global myFunc do={:put "hello from function"} | |||
$myFunc | |||
output: | |||
hello from function | |||
</pre> | |||
<pre> | |||
#pass arguments to the function | |||
:global myFunc do={:put "arg a=$a"; :put "arg '1'=$1"} | |||
$myFunc a="this is arg a value" "this is arg1 value" | |||
output: | |||
arg a=this is arg a value | |||
arg '1'=this is arg1 value | |||
</pre> | |||
Notice that there are two ways how to pass arguments: | |||
* pass arg with specific name ("a" in our example) | |||
* pass value without arg name, in such case arg "1", "2" .. "n" are used. | |||
'''Return example''' | |||
<pre> | |||
:global myFunc do={ :return ($a + $b)} | |||
:put [$myFunc a=6 b=2] | |||
output: | |||
8 | |||
</pre> | |||
You can even clone existing script from script environment and use it as function. | |||
<pre> | |||
#add script | |||
/system script add name=myScript source=":put \"Hello $myVar !\"" | |||
</pre> | |||
<pre> | |||
:global myFunc [:parse [/system script get myScript source]] | |||
$myFunc myVar=world | |||
output: | |||
Hello world ! | |||
</pre> | |||
{{Warning | If function contains defined global variable which name matches the name of passed parameter, then globally defined variable is ignored, for compatibility with scripts written for older versions. This feature can change in future versions. '''Avoid using parameters with same name as global variables.''' }} | |||
For example: | |||
<pre> | |||
:global my2 "123" | |||
:global myFunc do={ :global my2; :put $my2; :set my2 "lala"; :put $my2 } | |||
$myFunc my2=1234 | |||
:put "global value $my2" | |||
</pre> | |||
Output will be: | |||
<pre> | |||
1234 | |||
lala | |||
global value 123 | |||
</pre> | |||
'''Nested function example''' | |||
{{Note | to call another function its name needs to be declared (the same as for variables)}} | |||
<pre> | |||
:global funcA do={ :return 5 } | |||
:global funcB do={ | |||
:global funcA; | |||
:return ([$funcA] + 4) | |||
} | |||
:put [$funcB] | |||
Output: | |||
9 | |||
</pre> | |||
===Catch run-time errors=== | |||
Starting from v6.2 scripting has ability to catch run-time errors. | |||
For example, [code]:reslove[/code] command if failed will throw an error and break the script. | |||
<pre> | |||
[admin@MikroTik] > { :put [:resolve www.example.com]; :put "lala";} | |||
failure: dns name does not exist | |||
</pre> | |||
Now we want to catch this error and proceed with our script: | |||
<pre> | |||
:do { | |||
:put [:resolve www.example.com]; | |||
} on-error={ :put "resolver failed"}; | |||
:put "lala" | |||
output: | |||
resolver failed | |||
lala | |||
</pre> | |||
===Operations with Arrays=== | |||
{{Warning| Key name in array contains any character other than lowercase character, it should be put in quotes}} | |||
For example: | |||
<pre> | |||
[admin@ce0] > {:local a { "aX"=1 ; ay=2 }; :put ($a->"aX")} | |||
1 | |||
</pre> | |||
'''Loop through keys and values''' | |||
:foreach command can be used to loop through keys and elements: | |||
<pre> | |||
[admin@ce0] > :foreach k,v in={2; "aX"=1 ; y=2; 5} do={:put ("$k=$v")} | |||
0=2 | |||
1=5 | |||
aX=1 | |||
y=2 | |||
</pre> | |||
:if foreach command is used with one argument, then element value will be returned: | |||
<pre> | |||
[admin@ce0] > :foreach k in={2; "aX"=1 ; y=2; 5} do={:put ("$k")} | |||
2 | |||
5 | |||
1 | |||
2 | |||
</pre> | |||
{{Note | If array element has key then these elements are sorted in alphabetical order, elements without keys are moved before elements with keys and their order is not changed (see example above). }} | |||
'''Change the value of single array element''' | |||
<pre> | |||
[admin@MikroTik] > :global a {x=1; y=2} | |||
[admin@MikroTik] > :set ($a->"x") 5 | |||
[admin@MikroTik] > :environment print | |||
a={x=5; y=2} | |||
</pre> | |||
==Script repository== | ==Script repository== | ||
Line 1,005: | Line 1,276: | ||
<p><b>Sub-menu level:</b> <code>/system script</code></p> | <p><b>Sub-menu level:</b> <code>/system script</code></p> | ||
<p>Contains all user created scripts. Scripts can be executed in several different ways: | <p>Contains all user created scripts. Scripts can be executed in several different ways:</p> | ||
<ul class="bullets"> | <ul class="bullets"> | ||
<li><b>on event</b> - scripts are executed automatically on some facility events ([[M:System/Scheduler | scheduler]], [[M:Tools/Netwatch | netwatch]], [[M:Interface/VRRP | VRRP]]) | <li><b>on event</b> - scripts are executed automatically on some facility events ([[M:System/Scheduler | scheduler]], [[M:Tools/Netwatch | netwatch]], [[M:Interface/VRRP | VRRP]]) | ||
Line 1,011: | Line 1,282: | ||
<li><b>manually</b> - from console executing [[#run|run]] command or in winbox | <li><b>manually</b> - from console executing [[#run|run]] command or in winbox | ||
</ul> | </ul> | ||
{{Note | Only scripts (including schedulers, netwatch etc) with equal or higher permission rights can execute other scripts. }} | |||
<br /> | <br /> | ||
Line 1,018: | Line 1,292: | ||
<th >Description</th> | <th >Description</th> | ||
</tr> | </tr> | ||
<tr> | |||
<td><var><b>comment</b></var> (<em>string</em>; Default: <i></i>)</td> | |||
<td> Descriptive comment for the script</td> | |||
</tr> | |||
<tr> | |||
<td><var><b>dont-require-permissions</b></var> (<em>yes | no</em>; Default: <i>no</i>)</td> | |||
<td> Bypass permissions check when script is being executed, useful when scripts are being executed from services that have limited permissions, such as [[ Manual:Tools/Netwatch | Netwatch]]</td> | |||
</tr> | |||
<tr> | <tr> | ||
<td><var><b>name</b></var> (<em>string</em>; Default: <i>"Script[num]"</i>)</td> | <td><var><b>name</b></var> (<em>string</em>; Default: <i>"Script[num]"</i>)</td> | ||
Line 1,033: | Line 1,316: | ||
<li><b>read</b> - can retrieve the configuration | <li><b>read</b> - can retrieve the configuration | ||
<li><b>reboot</b> - can reboot the router | <li><b>reboot</b> - can reboot the router | ||
<li><b>sensitive</b> - | <li><b>sensitive</b> - allows to change "hide sensitive" parameter | ||
<li><b>sniff</b> - can run sniffer, torch etc | <li><b>sniff</b> - can run sniffer, torch etc | ||
<li><b>ssh</b> - can log on remotely via secure shell | <li><b>ssh</b> - can log on remotely via secure shell | ||
Line 1,040: | Line 1,323: | ||
<li><b>web</b> - can log on remotely via http | <li><b>web</b> - can log on remotely via http | ||
<li><b>winbox</b> - winbox permissions | <li><b>winbox</b> - winbox permissions | ||
<li><b>write</b> - can | <li><b>write</b> - can change the configuration | ||
</ul> | </ul> | ||
Read more detailed policy descriptions [[Manual:Router_AAA#Properties | here]] | |||
</td> | </td> | ||
</tr> | </tr> | ||
Line 1,083: | Line 1,367: | ||
</tr> | </tr> | ||
</table> | </table> | ||
===Environment=== | ===Environment=== | ||
Line 1,151: | Line 1,435: | ||
</p> | </p> | ||
== See also == | == See also == |
Revision as of 06:29, 30 August 2019
Scripting language manual
This manual provides introduction to RouterOS built-in powerful scripting language.
Scripting host provides a way to automate some router maintenance tasks by means of executing user-defined scripts bounded to some event occurrence.
Scripts can be stored in Script repository or can be written directly to console. The events used to trigger script execution include, but are not limited to the System Scheduler, the Traffic Monitoring Tool, and the Netwatch Tool generated events.
Line structure
RouterOS script is divided into number of command lines. Command lines are executed one by one until the end of script or until a runtime error occurs.
Command line
RouterOS console uses following command syntax:
[prefix] [path] command [uparam] [param=[value]] .. [param=[value]]
- [prefix] - ":" or "/" character which indicates if command is ICE or path. May or may not be required.
- [path] - relative path to the desired menu level. May or may not be required.
- command - one of the commands available at the specified menu level.
- [uparam] - unnamed parameter, must be specified if command requires it.
- [params] - sequence of named parameters followed by respective values
The end of command line is represented by the token “;” or NEWLINE. Sometimes “;” or NEWLINE is not required to end the command line.
Single command inside (), [] or {}
does not require any end of command character. End of command is determined by content of whole script
:if ( true ) do={ :put "lala" }
Each command line inside another command line starts and ends with square brackets "[ ]" (command concatenation).
:put [/ip route get [find gateway=1.1.1.1]];
Notice that code above contains three command lines:
- :put
- /ip route get
- find gateway=1.1.1.1
Command line can be constructed from more than one physical line by following line joining rules.
Physical Line
A physical line is a sequence of characters terminated by an end-of-line (EOL) sequence. Any of the standard platform line termination sequences can be used:
- unix – ASCII LF;
- windows – ASCII CR LF;
- mac – ASCII CR;
Standard C conventions for new line characters can be used ( the \n character).
Comments
A comment starts with a hash character (#) and ends at the end of the physical line. Whitespace or any other symbols are not allowed before hash symbol. Comments are ignored by syntax. If (#) character appear inside string it is not considered a comment.
Example
# this is a comment # bad comment :global a; # bad comment :global myStr "lala # this is not a comment"
Line joining
Two or more physical lines may be joined into logical lines using backslash character (\). A line ending in a backslash cannot carry a comment. A backslash does not continue a comment. A backslash does not continue a token except for string literals. A backslash is illegal elsewhere on a line outside a string literal.
Example
:if ($a = true \ and $b=false) do={ :put “$a $b”; } :if ($a = true \ # bad comment and $b=false) do={ :put “$a $b”; } # comment \ continued – invalid (syntax error)
Whitespace between tokens
Whitespace can be used to separate tokens. Whitespace is necessary between two tokens only if their concatenation could be interpreted as a different token. Example:
{ :local a true; :local b false; # whitespace is not required :put (a&&b); # whitespace is required :put (a and b); }
Whitespace characters are not allowed
- between '<parameter>='
- between 'from=' 'to=' 'step=' 'in=' 'do=' 'else='
Example:
#incorrect: :for i from = 1 to = 2 do = { :put $i } #correct syntax: :for i from=1 to=2 do={ :put $i } :for i from= 1 to= 2 do={ :put $i } #incorrect /ip route add gateway = 3.3.3.3 #correct /ip route add gateway=3.3.3.3
Scopes
Variables can be used only in certain regions of the script. These regions are called scopes. Scope determines visibility of the variable. There are two types of scopes - global and local. A variable declared within a block is accessible only within that block and blocks enclosed by it, and only after the point of declaration.
Global scope
Global scope or root scope is default scope of the script. It is created automatically and can not be turned off.
Local scope
User can define their own groups to block access to certain variables, these scopes are called local scopes. Each local scope is enclosed in curly braces ("{ }").
{ :local a 3; { :local b 4; :put ($a+$b); } #line below will show variable b in light red color since it is not defined in scope :put ($a+$b); }
In code above variable b has local scope and will not be accessible after closed curly brace.
So for example, defined local variable will not be visible in next command line and will generate syntax error
[admin@MikroTik] > :local myVar a; [admin@MikroTik] > :put $myVar syntax error (line 1 column 7)
Note that even variable can be defined as global, it will be available only from its scope unless it is not already defined.
{ :local a 3; { :global b 4; } :put ($a+$b); }
Code above will generate an error.
Keywords
The following words are keywords and cannot be used as variable and function names:
and or in
Delimiters
The following tokens serve as delimiters in the grammar:
() [] {} : ; $ /
Data types
RouterOS scripting language has following data types:
Type | Description |
---|---|
num (number) | - 64bit signed integer, possible hexadecimal input; |
bool (boolean) | - values can bee true or false ; |
str (string) | - character sequence; |
ip | - IP address; |
ip-prefix | - IP prefix; |
ip6 | - IPv6 address |
ip6-prefix | - IPv6 prefix |
id (internal ID) | - hexadecimal value prefixed by '*' sign. Each menu item has assigned unique number - internal ID; |
time | - date and time value; |
array | - sequence of values organized in an array; |
nil | - default variable type if no value is assigned; |
Constant Escape Sequences
Following escape sequences can be used to define certain special character within string:
\" | Insert double quote |
\\ | Insert backslash |
\n | Insert newline |
\r | Insert carriage return |
\t | Insert horizontal tab |
\$ | Output $ character. Otherwise $ is used to link variable. |
\? | Output ? character. Otherwise ? is used to print "help" in console. |
\_ | - space |
\a | - BEL (0x07) |
\b | - backspace (0x08) |
\f | - form feed (0xFF) |
\v | Insert vertical tab |
\xx | Print character from hex value. Hex number should use capital letters. |
Example
:put "\48\45\4C\4C\4F\r\nThis\r\nis\r\na\r\ntest";
which will show on display
HELLO
This
is
a
test
Operators
Arithmetic Operators
Usual arithmetic operators are supported in RouterOS scripting language
Operator | Description | Example |
---|---|---|
"+" | binary addition | :put (3+4); |
"-" | binary subtraction | :put (1-6); |
"*" | binary multiplication | :put (4*5); |
"/" | binary division | :put (10 / 2); :put ((10)/2) |
"%" | modulo operation | :put (5 % 3); |
"-" | unary negation | { :local a 1; :put (-a); } |
Note: for division to work you have to use braces or spaces around dividend so it is not mistaken as IP address
Relational Operators
Operator | Description | Example |
---|---|---|
"<" | less | :put (3<4); |
">" | greater | :put (3>4); |
"=" | equal | :put (2=2); |
"<=" | less or equal | |
">=" | greater or equal | |
"!=" | not equal |
Logical Operators
Operator | Description | Example |
---|---|---|
“!” | logical NOT | :put (!true); |
“&&” , “and” | logical AND | :put (true&&true) |
“||” , “or” | logical OR | :put (true||false); |
“in” | :put (1.1.1.1/32 in 1.0.0.0/8); |
Bitwise Operators
Bitwise operators are working on number, IP and IPv6 address data types.
Operator | Description | Example |
---|---|---|
“~” | bit inversion | :put (~0.0.0.0) :put (~::ffff) |
“|” | bitwise OR. Performs logical OR operation on each pair of corresponding bits. In each pair the result is “1” if one of bits or both bits are “1”, otherwise the result is “0”. | :put (192.168.88.0|0.0.0.255) :put (2001::1|::ffff) |
“^” | bitwise XOR. The same as OR, but the result in each position is “1” if two bits are not equal, and “0” if bits are equal. | :put (1.1.1.1^255.255.0.0) :put (2001::ffff:1^::ffff:0) |
“&” | bitwise AND. In each pair the result is “1” if first and second bit is “1”. Otherwise the result is “0”. | :put (192.168.88.77&255.255.255.0) :put (2001::1111&ffff::) |
“<<” | left shift by given amount of bits, not supported for IPv6 address data type | :put (192.168.88.77<<8) |
“>>” | right shift by given amount of bits, not supported for IPv6 address data type | :put (192.168.88.77>>24) |
Calculate subnet address from given IP and CIDR Netmask using "&" operator:
{ :local IP 192.168.88.77; :local CIDRnetmask 255.255.255.0; :put ($IP&$CIDRnetmask); }
Get last 8 bits from given IP addresses:
:put (192.168.88.77&0.0.0.255);
Use "|" operator and inverted CIDR mask to calculate the broadcast address:
{ :local IP 192.168.88.77; :local Network 192.168.88.0; :local CIDRnetmask 255.255.255.0; :local InvertedCIDR (~$CIDRnetmask); :put ($Network|$InvertedCIDR) }
Concatenation Operators
Operator | Description | Example |
---|---|---|
“.” | concatenates two strings | :put (“concatenate” . “ “ . “string”); |
“,” | concatenates two arrays or adds element to array | :put ({1;2;3} , 5 ); |
It is possible to add variable values to strings without concatenation operator:
:global myVar "world"; :put ("Hello " . $myVar); # next line does the same as above :put "Hello $myVar";
By using $[] and $() in string it is possible to add expressions inside strings:
:local a 5; :local b 6; :put " 5x6 = $($a * $b)"; :put " We have $[ :len [/ip route find] ] routes";
Other Operators
Operator | Description | Example |
---|---|---|
“[]” | command substitution. Can contain only single command line | :put [ :len "my test string"; ]; |
“()” | sub expression or grouping operator | :put ( "value is " . (4+5)); |
“$” | substitution operator | :global a 5; :put $a; |
“~” | binary operator that matches value against POSIX extended regular expression | Print all routes which gateway ends with 202/ip route print where gateway~"^[0-9 \\.]*202\$" |
“->” | Get an array element by key | [admin@x86] >:global aaa {a=1;b=2} [admin@x86] > :put ($aaa->"a") 1 [admin@x86] > :put ($aaa->"b") 2 |
Variables
Scripting language has two types of variables:
- global - accessible from all scripts created by current user, defined by global keyword;
- local - accessible only within the current scope, defined by local keyword.
Note: Starting from v6.2 there can be undefined variables. When variable is undefined parser will try to look for variables set, for example, by DHCP lease-script or Hotspot on-login
Every variable, except for built in RouterOS variables, must be declared before usage by local or global keywords. Undefined variables will be marked as undefined and will result in compilation error. Example:
# following code will result in compilation error, because myVar is used without declaration :set myVar "my value"; :put $myVar
Correct code:
:local myVar; :set myVar "my value"; :put $myVar;
Exception is when using variables set, for example, by DHCP lease-script
/system script add name=myLeaseScript policy=\ ftp,reboot,read,write,policy,test,winbox,password,sniff,sensitive,api \ source=":log info \$leaseActIP\r\ \n:log info \$leaseActMAC\r\ \n:log info \$leaseServerName\r\ \n:log info \$leaseBound" /ip dhcp-server set myServer lease-script=myLeaseScript
Valid characters in variable names are letters and digits. If variable name contains any other character, then variable name should be put in double quotes. Example:
#valid variable name :local myVar; #invalid variable name :local my-var; #valid because double quoted :global "my-var";
If variable is initially defined without value then variable data type is set to nil, otherwise data type is determined automatically by scripting engine. Sometimes conversion from one data type to another is required. It can be achieved using data conversion commands. Example:
#convert string to array :local myStr "1,2,3,4,5"; :put [:typeof $myStr]; :local myArr [:toarray $myStr]; :put [:typeof $myArr]
Variable names are case sensitive.
:local myVar "hello" # following line will generate error, because variable myVAr is not defined :put $myVAr # correct code :put $myVar
Set command without value will un-define the variable (remove from environment, new in v6.2)
#remove variable from environment :global myVar "myValue" :set myVar;
Reserved variable names
All built in RouterOS properties are reserved variables. Variables which will be defined the same as the RouterOS built in properties can cause errors. To avoid such errors, use custom designations.
For example, following script will not work:
{ :local type "ether1"; /interface print where name=$type; }
But will work with different defined variable:
{ :local customname "ether1"; /interface print where name=$customname; }
Commands
Global commands
Every global command should start with ":" token, otherwise it will be treated as variable.
Command | Syntax | Description | Example |
---|---|---|---|
/ | go to root menu | ||
.. | go back by one menu level | ||
? | list all available menu commands and brief descriptions | ||
global | :global <var> [<value>] |
define global variable | :global myVar "something"; :put $myVar; |
local | :local <var> [<value>] |
define local variable | { :local myLocalVar "I am local"; :put $myVar; } |
beep | :beep <freq> <length> |
beep built in speaker |
|
delay | :delay <time> |
do nothing for a given period of time |
|
put | :put <expression> |
put supplied argument to console |
|
len | :len <expression> |
return string length or array element count | :put [:len "length=8"]; |
typeof | :typeof <var> |
return data type of variable | :put [:typeof 4]; |
pick | :pick <var> <start>[<end>] |
return range of elements or substring. If end position is not specified, will return only one element from an array. | :put [:pick "abcde" 1 3] |
log | :log <topic> <message> |
write message to system log. Available topics are "debug, error, info and warning" |
:log info "Hello from script"; |
time | :time <expression> |
return interval of time needed to execute command | :put [:time {:for i from=1 to=10 do={ :delay 100ms }}]; |
set | :set <var> [<value>] |
assign value to declared variable. | :global a; :set a true; |
find | :find <arg> <arg> <start> |
return position of substring or array element | :put [:find "abc" "a" -1]; |
environment | :environment print <start> |
print initialized variable information | :global myVar true; :environment print; |
terminal |
|
terminal related commands |
|
error | :error <output> |
Generate console error and stop executing the script |
|
execute | :execute <expression> |
Execute the script in background. | { :local j [:execute {/interface print follow where [:log info ~Sname~]}]; :delay 10s; :do { /system script job remove $j } on-error={} } |
parse | :parse <expression> |
parse string and return parsed console commands. Can be used as function. | :global myFunc [:parse ":put hello!"]; |
resolve | :resolve <arg> |
return IP address of given DNS name | :put [:resolve "www.mikrotik.com"]; |
toarray | :toarray <var> |
convert variable to array |
|
tobool | :tobool <var> |
convert variable to boolean |
|
toid | :toid <var> |
convert variable to internal ID |
|
toip | :toip <var> |
convert variable to IP address |
|
toip6 | :toip6 <var> |
convert variable to IPv6 address |
|
tonum | :tonum <var> |
convert variable to integer |
|
tostr | :tostr <var> |
convert variable to string |
|
totime | :totime <var> |
convert variable to time |
|
Menu specific commands
Common commands
Following commands available from most sub-menus:
Command | Syntax | Description |
---|---|---|
add | add <param>=<value>..<param>=<value> |
add new item |
remove | remove <id> |
remove selected item |
enable | enable <id> |
enable selected item |
disable | disable <id> |
disable selected item |
set | set <id> <param>=<value>..<param>=<value> |
change selected items parameter, more than one parameter can be specified at the time. Parameter can be unset by specifying '!' before parameter. Example:
|
get | get <id> <param>=<value> |
get selected items parameter value |
print <param><param>=[<value>] |
print menu items. Output depends on print parameters specified. Most common print parameters are described here | |
export | export [file=<value>] |
export configuration from current menu and its sub-menus (if present). If file parameter is specified output will be written to file with extension '.rsc', otherwise output will be printed to console. Exported commands can be imported by import command |
edit | edit <id> <param> |
edit selected items property in built-in text editor |
find | find <expression> |
Returns list of internal numbers for items that are matched by given expression. For example: :put [/interface find name~"ether"] |
import
Import command is available from root menu and is used to import configuration from files created by export command or written manually by hand.
print parameters
Several parameters are available for print command:
Parameter | Description | Example |
---|---|---|
append |
|
|
as-value | print output as an array of parameters and its values | :put [/ip address print as-value] |
brief | print brief description |
|
detail | print detailed description, output is not as readable as brief output, but may be useful to view all parameters |
|
count-only | print only count of menu items |
|
file | print output to file |
|
follow | print all current entries and track new entries until ctrl-c is pressed, very useful when viewing log entries | /log print follow |
follow-only | print and track only new entries until ctrl-c is pressed, very useful when viewing log entries | /log print follow-only |
from | print parameters only from specified item | /user print from=admin |
interval | continuously print output in selected time interval, useful to track down changes where follow is not acceptable |
/interface print interval=2 |
terse | show details in compact and machine friendly format |
|
value-list | show values one per line (good for parsing purposes) |
|
without-paging | If output do not fit in console screen then do not stop, print all information in one piece |
|
where | expressions followed by where parameter can be used to filter out matched entries | /ip route print where interface="ether1" |
More than one parameter can be specified at a time, for example, /ip route print count-only interval=1 where interface="ether1"
Loops and conditional statements
Loops
Command | Syntax | Description |
---|---|---|
do..while | :do { <commands> } while=( <conditions> ); :while ( <conditions> ) do={ <commands> }; |
execute commands until given condition is met. |
for | :for <var> from=<int> to=<int> step=<int> do={ <commands> } |
execute commands over a given number of iterations |
foreach | :foreach <var> in=<array> do={ <commands> }; |
execute commands for each element in a list |
Conditional statement
Command | Syntax | Description |
---|---|---|
if | :if(<condition>) do={<commands>} else={<commands>} <expression> |
If a given condition is true then execute commands in the do block, otherwise execute commands in the else block if specified. |
Example:
{ :local myBool true; :if ($myBool = false) do={ :put "value is false" } else={ :put "value is true" } }
Functions
Scripting language does not allow to create functions directly, however you could use :parse command as a workaround.
Starting from v6.2 new syntax is added to easier define such functions and even pass parameters. It is also possible to return function value with :return command.
See examples below:
#define function and run it :global myFunc do={:put "hello from function"} $myFunc output: hello from function
#pass arguments to the function :global myFunc do={:put "arg a=$a"; :put "arg '1'=$1"} $myFunc a="this is arg a value" "this is arg1 value" output: arg a=this is arg a value arg '1'=this is arg1 value
Notice that there are two ways how to pass arguments:
- pass arg with specific name ("a" in our example)
- pass value without arg name, in such case arg "1", "2" .. "n" are used.
Return example
:global myFunc do={ :return ($a + $b)} :put [$myFunc a=6 b=2] output: 8
You can even clone existing script from script environment and use it as function.
#add script /system script add name=myScript source=":put \"Hello $myVar !\""
:global myFunc [:parse [/system script get myScript source]] $myFunc myVar=world output: Hello world !
Warning: If function contains defined global variable which name matches the name of passed parameter, then globally defined variable is ignored, for compatibility with scripts written for older versions. This feature can change in future versions. Avoid using parameters with same name as global variables.
For example:
:global my2 "123" :global myFunc do={ :global my2; :put $my2; :set my2 "lala"; :put $my2 } $myFunc my2=1234 :put "global value $my2"
Output will be:
1234 lala global value 123
Nested function example
:global funcA do={ :return 5 } :global funcB do={ :global funcA; :return ([$funcA] + 4) } :put [$funcB] Output: 9
Catch run-time errors
Starting from v6.2 scripting has ability to catch run-time errors.
For example, [code]:reslove[/code] command if failed will throw an error and break the script.
[admin@MikroTik] > { :put [:resolve www.example.com]; :put "lala";} failure: dns name does not exist
Now we want to catch this error and proceed with our script:
:do { :put [:resolve www.example.com]; } on-error={ :put "resolver failed"}; :put "lala" output: resolver failed lala
Operations with Arrays
Warning: Key name in array contains any character other than lowercase character, it should be put in quotes
For example:
[admin@ce0] > {:local a { "aX"=1 ; ay=2 }; :put ($a->"aX")} 1
Loop through keys and values
- foreach command can be used to loop through keys and elements:
[admin@ce0] > :foreach k,v in={2; "aX"=1 ; y=2; 5} do={:put ("$k=$v")} 0=2 1=5 aX=1 y=2
- if foreach command is used with one argument, then element value will be returned:
[admin@ce0] > :foreach k in={2; "aX"=1 ; y=2; 5} do={:put ("$k")} 2 5 1 2
Note: If array element has key then these elements are sorted in alphabetical order, elements without keys are moved before elements with keys and their order is not changed (see example above).
Change the value of single array element
[admin@MikroTik] > :global a {x=1; y=2} [admin@MikroTik] > :set ($a->"x") 5 [admin@MikroTik] > :environment print a={x=5; y=2}
Script repository
Sub-menu level: /system script
Contains all user created scripts. Scripts can be executed in several different ways:
- on event - scripts are executed automatically on some facility events ( scheduler, netwatch, VRRP)
- by another script - running script within script is allowed
- manually - from console executing run command or in winbox
Note: Only scripts (including schedulers, netwatch etc) with equal or higher permission rights can execute other scripts.
Property | Description |
---|---|
comment (string; Default: ) | Descriptive comment for the script |
dont-require-permissions (yes | no; Default: no) | Bypass permissions check when script is being executed, useful when scripts are being executed from services that have limited permissions, such as Netwatch |
name (string; Default: "Script[num]") | name of the script |
policy (string; Default: ) | list of applicable policies:
Read more detailed policy descriptions here |
source (string;) | Script source code |
Read only status properties:
Property | Description |
---|---|
last-started (date) | Date and time when the script was last invoked. |
owner (string) | User who created the script |
run-count (integer) | Counter that counts how many times script has been executed |
Menu specific commands
Command | Description |
---|---|
run (run [id|name]) | Execute specified script by ID or name |
Environment
Sub-menu level:
/system script environment
/environment
Contains all user defined variables and their assigned values.
[admin@MikroTik] > :global example; [admin@MikroTik] > :set example 123 [admin@MikroTik] > /environment print "example"=123
Read only status properties:
Property | Description |
---|---|
name (string) | Variable name |
user (string) | User who defined variable |
value () | Value assigned to variable |
Job
Sub-menu level: /system script job
Contains list of all currently running scripts.
Read only status properties:
Property | Description |
---|---|
owner (string) | User who is running script |
policy (array) | List of all policies applied to script |
started (date) | Local date and time when script was started |
See also
- Scripting Examples
- User submitted Scripts
[ Top | Back to Content ]