Scripting language manual
This manual provides an introduction to RouterOS’s 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 the Script repository or can be written directly to the 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.
If you are already familiar with scripting in RouterOS, you might want to see our Tips & Tricks.
Line structure
RouterOS script is divided into a number of command lines. Command lines are executed one by one until the end of the script or until a runtime error occurs.
Command-line
RouterOS console uses the following command syntax:
[prefix] [path] command [uparam] [param=[value]] .. [param=[value]]
- [prefix] — «:» or «/» character which indicates if command is ICE or path. It may not be required.
- [path] — relative path to the desired menu level. It may not be required.
- command — one of the commands available at the specified menu level.
- [uparam] — unnamed parameter, must be specified if the command requires it.
- [params] — a sequence of named parameters followed by respective values
The end of the 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. The end of the command is determined by the content of the 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 the 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 newline characters can be used ( the n character).
The following rules apply to a comment:
- A comment starts with a hash character (#) and ends at the end of the physical line.
- RouterOS does not support multiline comments.
- If (#) character appears inside the string it is not considered a comment.
Example
# this is a comment # next line comment :global a; # another valid comment :global myStr "part of the string # is not a comment"
Line joining
Two or more physical lines may be joined into logical lines using the backslash character ().
The following rules apply to use backslash as a line joining tool:
- 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 called scopes. These regions determine the 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 the 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 the code above variable, b has local scope and will not be accessible after a closing curly brace.
Each line written in the terminal is treated as local scope
So for example, the defined local variable will not be visible in the next command line and will generate a syntax error
[admin@MikroTik] > :local myVar a; [admin@MikroTik] > :put $myVar syntax error (line 1 column 7)
Do not define global variables inside local scopes.
Note that even variable can be defined as global, it will be available only from its scope unless it is not referenced to be visible outside of the scope.
{ :local a 3; { :global b 4; } :put ($a+$b); }
The code above will output 3, because outside of the scope b is not visible.
Following code will fix the problem and will output 7:
{ :local a 3; { :global b 4; } :global b; :put ($a+$b); }
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 the 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 an assigned a 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 characters within a string:
« | Insert double quote |
\ | Insert backslash |
n | Insert newline |
r | Insert carriage return |
t | Insert horizontal tab |
$ | Output $ character. Otherwise, $ is used to link the variable. |
? | |
_ | — space |
a | — BEL (0x07) |
b | — backspace (0x08) |
f | — form feed (0xFF) |
v | Insert vertical tab |
xx | A print character from hex value. Hex numbers should use capital letters. |
Example
:put "48454C4C4FrnThisrnisrnarntest";
which will show on displayHELLO
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 the division to work you have to use braces or spaces around the dividend so it is not mistaken as an 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 the bits or both bits is “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 the 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 a given amount of bits, not supported for IPv6 address data type | :put (192.168.88.77<<8) |
“>>” | right shift by a 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 the last 8 bits from the given IP addresses:
:put (192.168.88.77&0.0.0.255);
Use the «|» 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 an element to the array | :put ({1;2;3} , 5 ); |
It is possible to add variable values to strings without a concatenation operator:
:global myVar "world"; :put ("Hello " . $myVar); # next line does the same as above :put "Hello $myVar";
By using $[] and $() in the 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
</tr>
Operator | Description | Example |
---|---|---|
“[]” | command substitution. Can contain only a single command line | :put [ :len "my test string"; ]; |
“()” | subexpression or grouping operator | :put ( "value is " . (4+5)); |
“$” | substitution operator | :global a 5; :put $a; |
“~” | the 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
The scripting language has two types of variables:
- global — accessible from all scripts created by the 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 a variable is undefined, the parser will try to look for variables set, for example, by DHCP lease-script or Hotspot on-login
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 a 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;
The 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 $leaseActIPr n:log info $leaseActMACr n:log info $leaseServerNamer n:log info $leaseBound" /ip dhcp-server set myServer lease-script=myLeaseScript
Valid characters in variable names are letters and digits. If the variable name contains any other character, then the 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 a variable is initially defined without value then the variable data type is set to nil, otherwise, a data type is determined automatically by the 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;
Use quotes on the full variable name when the name of the variable contains operators. Example:
:local “my-Var”; :set “my-Var” "my value"; :put $”my-Var”;
Reserved variable names
All built-in RouterOS properties are reserved variables. Variables that will be defined the same as the RouterOS built-in properties can cause errors. To avoid such errors, use custom designations.
For example, the following script will not work:
{ :local type "ether1"; /interface print where name=$type; }
But will work with different defined variables:
{ :local customname "ether1"; /interface print where name=$customname; }
Commands
Global commands
Every global command should start with the «:» token, otherwise it will be treated as a variable.
Command | Syntax | Description | Example |
---|---|---|---|
/ | go to the root menu | ||
.. | go back by one menu level | ||
? | list all available menu commands and brief descriptions | ||
global | :global <var> [<value>] |
define a global variable | :global myVar "something"; :put $myVar; |
local | :local <var> [<value>] |
define the 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 the console | |
len | :len <expression> |
return string length or array element count | :put [:len "length=8"]; |
typeof | :typeof <var> |
the return data type of variable | :put [:typeof 4]; |
pick | :pick <var> <start>[<count>] |
return range of elements or substring. If the count is not specified, will return only one element from an array.
|
:put [:pick "abcde" 1 3] |
log | :log <topic> <message> |
write a message to the 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 the command | :put [:time {:for i from=1 to=10 do={ :delay 100ms }}]; |
timestamp | returns the time since epoch, where epoch is January 1, 1970, not counting leap seconds |
[admin@MikroTik] > :put [:timestamp] 2735w21:41:43.481891543 |
|
set | :set <var> [<value>] |
assign value to a declared variable. | :global a; :set a true; |
find | :find <arg> <arg> <start> |
return position of a 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 the background. The result can be written in the file by setting a «file» parameter or printed to the CLI by setting «as-string». When using «as-string» parameter executed script is blocking (not executed in the 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 the string and return parsed console commands. Can be used as a function. | :global myFunc [:parse ":put hello!"]; |
resolve | :resolve <arg> |
return the IP address of the given DNS name | :put [:resolve "www.mikrotik.com"]; |
retry | :retry command=<expr> delay=[num] max=[num] on-error=<expr> | Try to execute the given command «max» amount of times with a given «delay» between tries. On failure, execute the expression given in the «on-error» block |
[admin@MikroTik] > :retry command={abc} delay=1 max=2 on-error={:put "got error"} got error |
rndnum | :rndnum from=[num] to=[num] |
random number generator | :put [:rndnum from=1 to=99]; |
rndstr | :rndstr from=[str] length=[num] |
random string generator |
|
toarray | :toarray <var> |
convert variable to the 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 an integer | |
tostr | :tostr <var> |
convert variable to a string | |
totime | :totime <var> |
convert variable to time |
Menu specific commands
Common commands
The following commands are 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. The parameter can be unset by specifying ‘!’ before the 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. The most common print parameters are described here | |
export | export [file=<value>] |
export configuration from the current menu and its sub-menus (if present). If the file parameter is specified output will be written to file with extension ‘.rsc’, otherwise the output will be printed to console. Exported commands can be imported by import command |
edit | edit <id> <param> |
edit selected items property in the 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
The import command is available from the root menu and is used to import configuration from files created by an 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, the 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 a selected time interval, useful to track down changes where follow is not acceptable |
/interface print interval=2 |
terse | show details in a compact and machine-friendly format | |
value-list | show values one per line (good for parsing purposes) | |
without-paging | If the output does not fit in the console screen then do not stop, print all information in one piece | |
where | expressions followed by where parameters can be used to filter outmatched 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 a 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 a specific name («a» in our example)
- pass value without arg name, in such case arg «1», «2» .. «n» is used.
Return example
:global myFunc do={ :return ($a + $b)} :put [$myFunc a=6 b=2] output: 8
You can even clone an existing script from the script environment and use it as a 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 !
If the function contains a defined global variable that names match the name of the passed parameter, then the globally defined variable is ignored, for compatibility with scripts written for older versions. This feature can change in future versions. Avoid using parameters with the 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"
The output will be:
1234 lala global value 123
Nested function example
Note: to call another function its name needs to be declared (the same as for variables)
: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 the ability to catch run-time errors.
For example, the [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 the 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 the «foreach» command is used with one argument, then the 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 the array element has a 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 a 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 the script is allowed
- manually — from console executing a 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 the 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) | The 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 the 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) | The user who defined variable |
value () | The value assigned to a variable |
Job
Sub-menu level: /system script job
Contains a list of all currently running scripts.
Read-only status properties:
Property | Description |
---|---|
owner (string) | The user who is running the script |
policy (array) | List of all policies applied to script |
started (date) | Local date and time when the script was started |
See also
- Scripting Examples
- User-submitted Scripts
- Manual: Scripting Tips and Tricks
Ошибка в скрипте назначение интерфейсов
-
mmm
- Сообщения: 12
- Зарегистрирован: 04 окт 2018, 11:39
Ошибка в скрипте назначение интерфейсов
Доброго времени суток! Ошибка возникла после обновления routeros до 6.42.7 скрипт писал не я и о данунгрейте речи быть не может. Помогите разобраться, собственно сам скрипт:
Код: Выделить всё
### INT ###
$ipCONF iptmp=($config->3)
:global ether1NAME [/interface ethernet get [ find default-name="ether1" ] name ]
:global ether1 {ip="$ip";netmask="$prefix";gateway=($network+1)}
$ipCONF iptmp=($config->4)
:global ether5NAME [/interface ethernet get ($intCOUNT-1) name]
:global ether5 {ip="$ip";netmask="$prefix";gateway=($network+3)}
:if ( $MODE != "vsat" and $intCOUNT="5" ) do={
/interface ethernet set [find name="$ether5NAME" ] name="ether$intCOUNT-$ISP5" master-port=none
:set ether5NAME [/interface ethernet get ($intCOUNT-1) name]
}
$ipCONF iptmp=($config->5)
:global lanNAME [/ip address get [find network="192.168.88.0"] interface ]
:global lan {ip=($network+1);netmask="$prefix";network="$network";pool="$poolSTART-$poolEND"}
$ipCONF iptmp=($config->6)
:global l2tpNAME "l2tp-$ORG"
:global l2tp {network=($network+1)}
$ipCONF iptmp=($config->7)
:global greNAME "gre-$ORG"
:global gre {ip=($network+2);netmask="$prefix";network="$network"}
собственно ошибка:
Код: Выделить всё
[[email protected]] /ip address> :if ( $MODE != "vsat" and $intCOUNT="5" ) do={
{... /interface ethernet set [find name="$ether5NAME" ] name="ether$intCOUNT-$ISP5" master-port=none
expected end of command (line 2 column 80)
Спасибо!
-
Chupaka
- Сообщения: 3631
- Зарегистрирован: 29 фев 2016, 15:26
- Откуда: Минск
- Контактная информация:
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
Chupaka » 04 окт 2018, 14:35
В скриптах обращаться к интерфейсам по номеру нельзя, результат непредсказуемый. А судя по первому посту, переменная intCOUNT у вас вообще не инициализируется, поэтому я даже угадать затрудняюсь, что там должно происходить…
-
Chupaka
- Сообщения: 3631
- Зарегистрирован: 29 фев 2016, 15:26
- Откуда: Минск
- Контактная информация:
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
Chupaka » 04 окт 2018, 19:14
В общем, раньше в скриптах всё, что использовало команду print, работало кое-как и не всегда, а сейчас, видимо, это вообще на всякий случай закрыли
Полотенце сильно большое, чтобы с наскоку разобраться, чего же оно там хочет. Если просто найти последний интерфейс на роутере — то можно сделать как-то так:
Код: Выделить всё
:global ether5NAME [/interface ethernet get ($intCOUNT-1) name]
заменить на
Код: Выделить всё
:local i5; :foreach i in=[/interface ethernet find] do={ :set i5 $i }; :global ether5NAME [/interface ethernet get $i5 name];
, а
Код: Выделить всё
:set ether5NAME [/interface ethernet get ($intCOUNT-1) name]
— на
Ну и использовать global-переменные в таком количестве без надобности — тоже так себе подход…
-
mmm
- Сообщения: 12
- Зарегистрирован: 04 окт 2018, 11:39
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
mmm » 05 окт 2018, 11:11
День добрый Chupaka! ошибок при заливке скрипта нет но результат нулевой. По идее скрип должен отключить дефолтную конфигурацию и выдать новый ИП этого почему то не происходит. После перезагрузки адрес не получаю a Neighbors пишет что 192.168.88.1. Хэлп!!!!!
-
mmm
- Сообщения: 12
- Зарегистрирован: 04 окт 2018, 11:39
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
mmm » 05 окт 2018, 12:11
мои действия:
-New terminal
-копипаст скрипта
-reboot
и….вуаля микротик должен работать но на деле после перезагрузки ИП адрес не получаю a Neighbors пишет что 192.168.88.1
-
Chupaka
- Сообщения: 3631
- Зарегистрирован: 29 фев 2016, 15:26
- Откуда: Минск
- Контактная информация:
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
Chupaka » 05 окт 2018, 13:34
Ну, команда, добавляющая LAN-адрес — вот тут:
Код: Выделить всё
/ip address {
remove [find address="$lanIP$lanMASK"]
add address="$lanIP$lanMASK" interface="$lanNAME"
Можно вывести в Терминал, что же она пытается добавить:
Код: Выделить всё
/ip address {
:put "Adding $lanIP$lanMASK";
remove [find address="$lanIP$lanMASK"]
add address="$lanIP$lanMASK" interface="$lanNAME"
И посмотреть, что именно он в этот момент добавляет.
-
mmm
- Сообщения: 12
- Зарегистрирован: 04 окт 2018, 11:39
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
mmm » 06 окт 2018, 09:24
Код: Выделить всё
MMM MMM KKK TTTTTTTTTTT KKK
MMMM MMMM KKK TTTTTTTTTTT KKK
MMM MMMM MMM III KKK KKK RRRRRR OOOOOO TTT III KKK KKK
MMM MM MMM III KKKKK RRR RRR OOO OOO TTT III KKKKK
MMM MMM III KKK KKK RRRRRR OOO OOO TTT III KKK KKK
MMM MMM III KKK KKK RRR RRR OOOOOO TTT III KKK KKK
MikroTik RouterOS 6.43.2 (c) 1999-2018 http://www.mikrotik.com/
Последний раз редактировалось mmm 07 окт 2018, 13:15, всего редактировалось 1 раз.
-
Chupaka
- Сообщения: 3631
- Зарегистрирован: 29 фев 2016, 15:26
- Откуда: Минск
- Контактная информация:
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
Chupaka » 06 окт 2018, 12:57
Прячьте код под тег [code]
Вижу, в новой версии комментарий «default configuration» сменили на «defconf», поэтому 192.168.88.1 у вас не выключается, хотя 172…. добавился нормально. Измените комментарий в скрипте.
-
mmm
- Сообщения: 12
- Зарегистрирован: 04 окт 2018, 11:39
Re: Ошибка в скрипте назначение интерфейсов
Сообщение
mmm » 06 окт 2018, 14:55
Ничего я не менял! и «defconf» в скрипте не нашел, к сожалению
менять здесь?
Код: Выделить всё
/ip dhcp-server {
:local o [find name="default" ]
:if ([:len $o] != 0) do={ remove $o }
}
/ip pool {
:local o [find name="default-dhcp"]
:if ([:len $o] != 0) do={ remove $o }
На чтение 56 мин. Просмотров 6.1k.
Содержание
- РУКОВОДСТВО ПО ЯЗЫКУ СКРИПТОВ
- СТРУКТУРА КОМАНДЫ
- Команда
- Команда и EOL (End of Line)
- Комментарии
- Объединение команд
- Пробелы между токенами
- Области видимости
- ЗАРЕЗЕРВИРОВАННЫЕ СЛОВА
- ОГРАНИЧИТЕЛИ
- ТИПЫ ДАННЫХ
- Escape последовательности
- ОПЕРАТОРЫ
- Арифметические операторы
- Операторы сравнения
- Логические операторы
- Битовые операторы
- Операторы конкатенации
- Другие операторы
- ПЕРЕМЕННЫЕ
- ВСТРОЕННЫЕ КОМАНДЫ
- Навигация и справка
- Команды общего назначения
- Команды, специфичные для меню
- Импорт
- Параметры команды print
- ЦИКЛЫ И ВЕТВЛЕНИЯ
- Циклы
- ФУНКЦИИ
- ПЕРЕХВАТ И ОБРАБОТКА ОШИБОК ВО ВРЕМЯ ИСПОЛНЕНИЯ
- ОПЕРАЦИИ С МАССИВАМИ
- РЕПОЗИТОРИЙ (ХРАНИЛИЩЕ) СКРИПТОВ
- Окружение
- Список выполняющихся скриптов
- ПРАКТИКА
- Настройка и выполнение
РУКОВОДСТВО ПО ЯЗЫКУ СКРИПТОВ
Это руководство является введением в мощный встроенный язык скриптов для RouterOS.
В качестве полезных данных следует привести ссылки на страницы из официальной документации:
- Синтаксис языка — оригинал данной статьи
- Полезные трюки при написании скриптов;
- Набор готовых скриптов по категориям.
Скриптовый язык routeros предоставляет возможность для автоматизации задач средствами исполнения определённых пользователем скриптов, связанных с какими-либо событиями.
Скрипты могут могут храниться в репозитории (хранилище) или могут быть написаны прямо в консоли. События, вызывающие исполнение скриптов генерируются системным планировщиком, утилитой мониторинга траффика и утилитой netwatch, но не ограничены только этими генераторами.
СТРУКТУРА КОМАНДЫ
Скрипты для RouterOS состоят из команд. Команды исполняются одна за одной, пока не будет достигнут конец скрипта или не возникнет ошибка во время исполнения.
Команда
Консоль использует следующий синтакс команды:
[prefix] [path] command [uparam] [param=[value] .. param=[value]]
[prefix] — может принимать следующие символьные значения, «:» или «/», что определяет команду, как ICE или путь.
[path] — относительный путь к желаемому уровню меню.
command — одна из возможных встроенных команд, определённых уровнем меню.
[uparam] — безымянный параметр, кот. должен быть определён, если этого требует встроенная команда (command).
[params] — последовательность именованных параметров со значениями.
* Всё, что перечислено в квадратных скобках является необязательными составными частями команды.
Каждая команда заканчивается символом «;» или концом строки. В некоторых случаях эти символы не нужны для окончания команды. Команда внутри (), [] или {} не нуждается в таких символах.
:if ( true ) do={ :put "lala" }
Каждая команда внутри другой команды начинается и заканчивается квадратными скобками [] (объединение команд):
:put [/ip route get [find gateway=1.1.1.1]];
Команда может состоять из нескольких строк, объединённых специальным символом. Смотри «Объединение команд».
Команда и EOL (End of Line)
Команда — это последовательность символов, заканчивающихся EOL последовательностью. Любая из стандартных последовательностей EOL может быть использована:
— Unix = ASCII LF
— Windows = ASCII CR LF
— Mac = ASCII CR
Комментарии
Комментарий начинается с символа «#» и заканчивается последовательностью EOL. Пробел и любые другие символы не разрешены к использованию перед #. Комментарии игнорируются синтаксическим анализатором. Если символ # появится в строке, то это не будет считаться комментарием:
# хороший комментарий
# плохой комментарий
:global a; # плохой комментарий
:global myStr "лала # это не комментарий"
Объединение команд
Две или более строки могут быть объединены в одну команду, если использовать символ «» (обратный слэш). Это не работает с комментариями и с токенами исключая строки. Примеры:
:if ($a = true
and $b=false) do={ :put “$a $b”; }
:if ($a = true # неудачная попытка
and $b=false) do={ :put “$a $b”; }
# comment
continued – invalid (синтаксическая ошибка)
Пробелы между токенами
Пробелы используются для разделения токенов. Пробел необходим между двумя токенами только если их объединение может быть интерпретировано, как другой токен. Пример:
{
:local a true; :local b false;
# пробелы не нужны
:put (a&&b);
# пробелы нужны
:put (a and b);
}
Пробелы не разрешены в следующих конструкциях:
— =
— from=, to=, step=, in=, do=, else=
Пример:
#неправильно:
:for i from = 1 to = 2 do = { :put $i }#правильно:
:for i from=1 to=2 do={ :put $i }
:for i from= 1 to= 2 do={ :put $i }
#неправильно
/ip route add gateway = 3.3.3.3
#правильно
/ip route add gateway=3.3.3.3
Области видимости
Переменные могут быть использованы только в определённых областях скрипта. Эти области называют областями видимости. Существует два типа областей видимости: локальная и глобальная. Переменная, объявленная внутри блока может быть использована только в его пределах после места объявления.
Глобальная область видимости, по другому корневая область, видимости является областью по умолчанию для скрипта. Она создаётся автоматически и существует всегда.
Пользователь может определить свои области видимости при помощи скобок {}. Такие области называются локальными. Пример:
{
:local a 3;
{
:local b 4;
:put ($a+$b);
}
# команда ниже некорректна, так как переменная b не определена в данной области видимости
:put ($a+$b);
}
Важное замечание: каждая команда в консоли обрабатывается в своей локальной области видимости.
[admin@MikroTik] > :local myVar a;
[admin@MikroTik] > :put $myVar
syntax error (line 1 column 7)
Важно: не определяйте глобальные переменные внутри локальных областей видимости.
# этот код сгенерирует ошибку
{
:local a 3;
{
:global b 4;
}
:put ($a+$b);
}
ЗАРЕЗЕРВИРОВАННЫЕ СЛОВА
Следующие слова являются зарезервированными и не могут быть использованы, как имена переменных или функций:
and or not in
ОГРАНИЧИТЕЛИ
Следующие токены служат ограничителями в грамматике:
() [] {} : ; $ /
ТИПЫ ДАННЫХ
Язык имеет следующие типы данных:
— num — 64 битное знаковое целое. может быть инициализировано шестнадцатиричным значением
— bool — булев тип. может быть true или false
— str — строковый тип. последовательность символов
— ip — IP адрес
— ip6-prefix — IPv6 префикс
— id — шестнадцатиричное значение с префиксом *. Каждая позиция меню имеет уникальный внутрений ID
— time — дата и время
— array — последовательность значений, массив
— nil — тип переменной по умолчанию, если она не инициализирована никаким значением
Escape последовательности
Следующие последовательности могут быть использованы для помещения спецсимволов в строки:
» — двойные кавычки
\ — обратный слэш
n — символ конца строки
r — return
t — горизонтальная табуляция
$ — знак доллара
? — знак вопроса. спецназначение этого символа — выводить справку меню
_ — пробел
a — звуковой сигнал терминала BEL (0x07)
b — бэкспейс
f — form feed (0xFF)
v — вертикальная табуляция
xx — шестнадцатиричный код символа
Пример:
:put "48454C4C4FrnThisrnisrnarntest";
Вывод:HELLO
This
is
a
test
ОПЕРАТОРЫ
Арифметические операторы
+ бинарное сложение
— бинарное вычитание
* бинарное умножение
/ бинарное деление
— унарное отрицание
Примеры:
:put (3+4);
:put (3-4);
:put (3*4);
:put (10 / 2); :put ((10)/2)
{ :local a 1; :put (-a); }
Операторы сравнения
< меньше
> больше
= равно
<= меньше или равно
>= больше или равно
!= не равно
Логические операторы
(!, not)
НЕ(&&, and)
И(||, or)
ИЛИ(in)
оператор принадлежности (пример, :put (1.1.1.1/32 in 1.0.0.0/8);)
Битовые операторы
Применимы к числовому типу и типу IP address.
| ИЛИ
& И
~ Инверсия
^ XOR
<< сдвиг влево
>> сдвиг вправо
Примеры. Вычисление адреса подсети по IP адресу и маске
{
:local IP 192.168.88.77;
:local CIDRnetmask 255.255.255.0;
:put ($IP&$CIDRnetmask);
}
Получение последних 8 бит IP адреса
:put (192.168.88.77&0.0.0.255);
Вычисление широковещательного адреса
{
:local IP 192.168.88.77;
:local Network 192.168.88.0;
:local CIDRnetmask 255.255.255.0;
:local InvertedCIDR (~$CIDRnetmask);
:put ($Network|$InvertedCIDR)
}
Операторы конкатенации
конкатенация двух строк :put (“concatenate” . “ “ . “string”)
;
конкатенация двух массивов или объявление значения в массив :put ({1;2;3} , 5 );
Также возможно добавлять значения переменных в строки без конкатенации
:global myVar "world";
:put ("Hello " . $myVar);
# следующая команда делает тоже, что предыдущая
:put "Hello $myVar";
Используя $[] и $() можно добавлять выражения внутрь строк
:local a 5;
:local b 6;
:put "5x6 = $($a * $b)";
:put "We have $[ :len [/ip route find] ] routes";
Другие операторы
[]
Использование команды в команде()
Группировка выражений$
Унарный оператор подстановки. доступ к значению переменной~
Бинарный оператор, сравнивающий значение с POSIX регулярным выражением->
Получение элемента массива по ключу
Пример с регулярными выражениями
# печатаем все маршруты со шлюзом, у которого адрес заканчивается на 202/ip route print where gateway~"^[0-9\.]*202"
Пример с массивом
[admin@x86] >:global aaa {a=1;b=2}
[admin@x86] > :put ($aaa->"a")
1
[admin@x86] > :put ($aaa->"b")
2
ПЕРЕМЕННЫЕ
Язык допускает два типа переменных, глобальные и локальные.
global — доступно из всех скриптов, созданных текущим пользователем.
local — доступно только внутри текущей области видимости.
Замечание: значение переменной ограничено 4096 байтами.
Каждая переменная, исключая встроенные, должна быть объявлена перед использованием при помощи зарезервированных слов global или local.
# некорректный код
:set myVar "my value";
:put $myVar
# корректный код
:local myVar;
:set myVar "my value";
:put $myVar;
Исключая случай, когда используется множество (set) переменных. Пример
/system script
add name=myLeaseScript policy=
ftp,reboot,read,write,policy,test,winbox,password,sniff,sensitive,api
source=":log info $leaseActIPr
n:log info $leaseActMACr
n:log info $leaseServerNamer
n:log info $leaseBound"
/ip dhcp-server set myServer lease-script=myLeaseScript
Допустимыми символами для составления имён переменных являются буквы и цифры. Если имя содержит любые другие символы, то его нужно помещать в двойные кавычки «».
# корректно
:local myVar;
# некорректно
:local my-var;
# корректно
:global "my-var";
Если переменная объявлена, но не инициализирована, то ей назначается тип nil. Иначе тип определяется автоматически. Иногда необходимо преобразовать переменную из одного типа в другой. Это можно сделать при помощи специальных команд.
# преобразование строки в массив
:local myStr "1,2,3,4,5";
:put [:typeof $myStr];
:local myArr [:toarray $myStr];
:put [:typeof $myArr]
Имена переменных чувствительны к регистру. Команда set без значения удаляет переменную из окружения.
:global myVar "myValue"
:set myVar;
ВСТРОЕННЫЕ КОМАНДЫ
Навигация и справка
1) /
— переход в корень меню
2) ..
— переход в меню на один уровень выше
3) ?
— список всех возможных команд меню с описанием
Команды общего назначения
Любая встроенная команда начинается с символа «:», иначе она будет воспринята, как переменная.
1) global — определение глобальной переменной
Синтаксис::global []
Пример::global myVar "something"; :put $myVar;
2) local — определение локальной переменной
Синтаксис::local []
Пример:{ :local myLocalVar "I am local"; :put $myVar; }
3) beep — звуковой сингнал из встроенного спикера
Синтаксис::beep
Пример::beep frequency=320 length=100ms;
4) delay — задержка заданный период времени
Синтаксис::delay
Пример::delay 50ms;
5) put — вывод в консоль
Синтаксис::put
6) len — печать длины переданой последовательности (массива или строки)
Синтаксис::len
Пример::put [:len "length=8"];
7) typeof — определение типа переменной
Синтаксис::typeof
Пример::put [:typeof 4];
pick — вернуть подпоследовательность массива или строки. если неопределено, то вернёт элемент из позиции
Синтаксис::pick []
Пример::put [:pick "abcde" 1 3]
9) log — запись в системный лог. topic={debug, error, info, warning}
Синтаксис::log
Пример::log info "Hello from script";
10) time — определить время, необходимое для выполнения команды
Синтаксис::time
Пример::put [:time {:for i from=1 to=10 do={ :delay 100ms }}];
11) set — присвоить значение переменной
Пример::global a; :set a true;
12) find — вернуть позицию искомого в строке или массиве
Синтаксис::find
Пример::put [:find "abc" "a" -1];
13) environment — печать информации об инициализированных переменных
Синтаксис::environment print
Пример::global myVar true; :environment print;
14) terminal — ?
15) error — сгенерировать ошибку в консоль и остановить выполнение
Синтаксис::error
16) execute — выполнение скрипта в фоне
Синтаксис::execute
Пример:
:local j [:execute {/interface print follow where [:log info ~Sname~]}];
:delay 10s;
:do { /system script job remove Sj } on-error={}
17) parse — парсинг текста в набор команд для исполнения. можно использовать для определения функций
Синтаксис:
:parse <text>
Пример:
:global myFunc [:parse ":put hello!"];
$myFunc;
18) resolve — разрешение имени в IP адрес
Пример:
:put [:resolve "www.mikrotik.com"];
* Команды преобразования типов *
1) toarray <var>
2) tobool <var>
3) toid <var>
4) toip <var>
5) toip6 <var>
6) tonum <var>
7) tostr <var>
totime <var>
Команды, специфичные для меню
Следующие команды доступны в большинстве подменю и не требуют использования символа «:»
1) add — добавить запись
Синтаксис:
add <param>=<value>..<param>=<value>
2) remove — удалить запись
Синтаксис:
remove <id>
3) enable — активировать запись
Синтаксис:
enable <id>
4) disable — дизактивировать запись
Синтаксис:
disable <id>
5) set — изменение параметров записи с заданным ID
Синтаксис:
set <id> <param>=<value>..<param>=<value>
6) get — ?
Синтаксис:
get <id> <param>=<value>
Пример:
/system script get myScript source
7) print — печать записей. вывод зависит от параметров
Синтаксис:
print <param><param>=[<value>]
export — сохранить записи в файл в виде скрипта, если файл указан. иначе вывести записи в окно терминала
Синтаксис:
export [file=<value>]
9) edit — редактирование выделеной записи во встроеном текстовом редакторе
Синтаксис:
edit <id> <param>
10) find — вернуть список ID записей, которые совпадают с expression.
Синтаксис:
find <expression>
Пример:
:put [/interface find name~"ether"]
Возможный вывод:
*1;*2;*3;*4
Импорт
Команда import доступна из корневого меню и используется для импорта конфигураций из файлов, созданных командой export или вручную.
Параметры команды print
append —
as-value — вернуть, как массив параметров и их значений ( :put [/ip address print as-value] )
brief — печать в сокращённом табличном виде
advanced —
detail — детальная печать, отображает все параметры
count-only — печатать количество записей, а не сами записи
file — перенаправить печать в файл
follow — печать текущих записей и слежение за появлением новых записей, пока не будет нажата комбинация ctrl+c ( /log print follow )
follow-only — печать и слежение только за новыми записями. выход также по ctrl+c
from — печатать параметры только указанной записи ( /user print from=admin )
interval — непрерывно печатать через определённые интервалы времени
terse — отобразить в компактном, удобном для программной обработки виде
value-list — отобразить параметры и значения по одному на линии. удобно для парсинга
without-paging — печать информации без разбиения на части
where — фильтр по значению какого-либо параметра
Одновременно можно использовать несколько параметров. Пример:
# печатать текущее количество маршрутов через интерфейс ether1 каждую секунду
/ip route print count-only interval=1 where interface="ether1"
ЦИКЛЫ И ВЕТВЛЕНИЯ
Циклы
— while и do-while
:while ( <conditions> ) do={ <commands> };
:do { <commands> } while=( <conditions> );
— for
:for <var> from=<int> to=<int> step=<int> do={ <commands> }
— foreach
:foreach <var> in=<array> do={ <commands> };
* Ветвление *
:if(<condition>) do={<commands>} else={<commands>}
Пример:
{
:local myBool true;
:if ($myBool = false) do={ :put "value is false" } else={ :put "value is true" }
}
ФУНКЦИИ
Язык не позволяет создавать функции напрямую, однако можно использовать команду :parse, как обходной способ для создания функций. Начиная с версии 6.2 добавлен новый синтаксис, позволяющий определять функции и передавать им параметры. Также возможно возвращать значение из функции при помощи команды :return. Пример:
# создание и выполнение простой функции
:global myFunc do={:put "hello from function"}
$myFunc
Вывод:
hello from function
# передача аргументов в функцию
:global myFunc do={:put "arg a=$a"; :put "arg '1'=$1"}
$myFunc a="this is arg a value" "this is arg1 value"
Вывод:
arg a=this is arg a value
arg '1'=this is arg1 value
Из примера видно, что существуют два способа передачи аргументов в функцию:
— передача по имени
— передача по порядковому номеру
Пример использования :return
:global myFunc do={ :return ($a + $b)}
:put [$myFunc a=6 b=2]
Вывод:
8
Также возможно копирование существующего скрипта из окружения и использование его, как функции. Пример:
#add script
/system script add name=myScript source=":put "Hello $myVar !""
:global myFunc [:parse [/system script get myScript source]]
$myFunc myVar=world
Вывод:
Hello world !
Внимание: если функция содержит глобально определённую переменную с именем совпадающим с именем передаваемого параметра, то глобально определённая переменная будет проигнорирована, для совместимости со старыми версиями. Эта возможность может быть изменена в будущих версиях. Избегайте использование параметров с теми же именами, что и глобальные переменные. Пример:
:global my2 "123"
«
:global myFunc do={ :global my2; :put $my2; :set my2 "lala"; :put $my2 }
$myFunc my2=1234
:put "global value $my2
Вывод:
1234
lala
global value 123
Чтобы вызвать функцию внутри другой функции, её имя должно быть определено.
:global funcA do={ :return 5 }
:global funcB do={
:global funcA;
:return ([$funcA] + 4)
}
:put [$funcB]
Вывод:
9
ПЕРЕХВАТ И ОБРАБОТКА ОШИБОК ВО ВРЕМЯ ИСПОЛНЕНИЯ
Начиная с версии 6.2 скрипты могут перехватывать ошибки, возникающие во время выполнения. Рассмотрим следующий скрипт:
{ :put [:resolve www.a.com]; :put "lala"; }
failure: dns name does not exist
Мы хотим перехватить эту ошибку и обработать её:
:do {
:put [:resolve www.a.com]
} on-error={ :put "resolver failed"};
:put "lala"
Вывод:
resolver failed
lala
ОПЕРАЦИИ С МАССИВАМИ
Внимание: Если имя ключа содержит символы, отличающиеся от латинских в нижнем регистре, то такое имя нужно заключать в двойные кавычки. Пример:
{:local a { "aX"=1 ; ay=2 }; :put ($a->"aX")}
Конструкция foreach может быть использована для циклического прохода элементам массива.
:foreach k,v in={2; "aX"=1 ; y=2; 5} do={:put ("$k=$v")}
Вывод:
0=2
1=5
aX=1
y=2
Если элементы массива имеют ключевую часть, то они сортируются в алфавитном порядке (alphabetical order) по ключу. Элементы без ключевой части распологаются до элементов с ключевой частью и их порядок остаётся неизменным.
Если конструкиця foreach используется с одним аргументом, то возвращаются значения элементов.
:foreach k in={2; "aX"=1 ; y=2; 5} do={:put ("$k")}
Вывод:
2
5
1
2
Пример изменеия значения элемента массива:
:global a {x=1; y=2}
:set ($a->"x") 5
:environment print
Вывод:
a={x=5; y=2}
РЕПОЗИТОРИЙ (ХРАНИЛИЩЕ) СКРИПТОВ
Уровень меню: /system script
Содержит скрипты, созданные пользователями. Скрипты могут быть выполнены в следующих случаях:
— по событию
— один скрипт вызывает другой скрипт
— запуск вручную
Параметры скриптов:
— comment (тип: string, значение по умолчанию: «») — комментарий, облегчающий понимание, что делает скрипт
— name (тип: string, значение по умолчанию: «Script[num]») — уникальное имя
— policy (тип: string, значение по умолчанию: «») — список применяемых политик
* api — разрешает использование API
* ftp — разрешает удалённый доступ по ftp, передачу файлов на и с роутера
* local — разрешает локальный вход через консоль
* password — разрешает смену паролей
* policy — управление пользователями, добавление/удаление
* read — разрешение чтения конфигурации
* reboot — разрешение на перезагрузку
* sensitive — просмотр паролей и прочей информации
* sniff — разрешение использовать sniffer, torch и тд
* ssh — разрешение на удалённый логин по ssh
* telnet — разрешение на удалённый логин по telnet
* test — разрешение использовать ping, traceroute, bandwidth test
* web — разрешение на удалённый логин по http
* winbox — разрешает использование winbox
* write — разрешение изменения конфигурации
— source (тип: string, значение по умолчанию: «») — код скрипта
Параметры состояния, доступные только для чтения:
— last-started (тип: date) — дата и время последнего запуска
— owner (тип: string) — владелец скрипта
— run-count (тип: integer) — количство запусков
Команда запуска:
run [id | name]
Окружение
Уровень меню: /system script environment или /environment
Содержит все переменные, определённые пользователем и их значения. Пример:
[admin@MikroTik] > :global example;
[admin@MikroTik] > :set example 123
[admin@MikroTik] > /environment print
Вывод:
"example"=123
Параметры только для чтения:
* name (тип: string)
* user (тип: string)
* value
Список выполняющихся скриптов
Уровень меню: /system script job
Содержит список всех скриптов, выполняющихся в данный момент.
Параметры только для чтения:
* owner (тип: string)
* policy (тип: array)
* started (тип: date)
ПРАКТИКА
Задача: базовая настройка домашнего или офисного маршрутизатора на базе hAp lite.
Решение:
Данное решение предполагает, что провайдер даёт доступ в интернет через PPPoE. Настройку других способов подключения можно почитать в статье на хабре (https://habrahabr.ru/post/265387/). Основа для скрипта была взята из репозитория (https://github.com/jadiaz/MikroTik).
{
# Encoding must be UTF-8!
#-------------------------------------------------------------------------------
# Set the name of the router and its SSID
:local systemName ""
# Set the password you would like to use when logging on as 'admin'.
:local adminPassword ""
# Time Servers (NTP)
:local ntpA "173.230.149.23"
:local ntpB "198.110.48.12"
# Name Servers (DNS) - set to OpenDNS. This should be set to a set of servers that are local and FAST
:local nsA "216.116.96.2"
:local nsB "216.52.254.33"
:local nsC "68.111.16.30"
# DHCP
:local dhcpServer "dhcp-local-server"
:local lanPoolName "dhcp-local-pool"
:local poolStart "192.168.20.100"
:local poolEnd "192.168.20.200"
# Addresses
:local lanAddress "192.168.20.1"
:local lanNetworkAddress "192.168.20.0"
:local lanNetworkBits "24"
# Interfaces
:local ether1 "ether1-wan"
:local ether2 "ether2-slave-lan"
:local ether3 "ether3-slave-lan"
:local ether4 "ether4-master-lan"
:local tap1 "tap1-gateway"
:local tap1Login ""
:local tap1Password ""
:local br1 "br1-local"
# wpa/wpa2 pre-shared key
:local wpaPreSharedKey ""
#-------------------------------------------------------------------------------
:log info "--- Setting timezone ---";
/system clock set time-zone-autodetect=yes;
:log info "--- Setting up the time server client ---";
/system ntp client set enabled=yes primary-ntp=$ntpA secondary-ntp=$ntpB;
:log info "--- Setting the system name ---";
/system identity set name=$systemName;
:log info "--- Setting the admin password ---";
/user set admin password=$adminPassword;
#——————————————————————————-
:log info "--- Clearing all pre-existing settings ---";
:log info "--- Clearing firewall ---";
/ip firewall {
:log info "--- Clearing any existing NATs ---";
:local o [nat find]
:if ([:len $o] != 0) do={ nat remove numbers=$o }
:log info "--- Clearing old filters ---";
:local o [filter find where dynamic=no]
:if ([:len $o] != 0) do={ filter remove $o }
:log info "--- Clearing old address lists ---";
:local o [address-list find]
:if ([:len $o] != 0) do={ address-list remove numbers=$o }
:log info "--- Clearing previous mangles ---";
:local o [mangle find where dynamic=no]
:if ([:len $o] != 0) do={ mangle remove numbers=$o }
:log info "--- Clearing previous layer-7 ---";
:local o [layer7-protocol find]
:if ([:len $o] != 0) do={ layer7-protocol remove numbers=$o }
}
:log info "--- Resetting Mac Server ---";
/tool mac-server remove [find interface!=all]
/tool mac-server set [find] disabled=no
/tool mac-server mac-winbox remove [find interface!=all]
/tool mac-server mac-winbox set [find] disabled=no
:log info "--- Resetting neighbor discovery ---";
/ip neighbor discovery set [find name=$ether1] discover=yes
:log info "--- Reset interfaces to default ---";
:foreach iface in=[/interface ethernet find] do={
/interface ethernet set $iface name=[get $iface default-name]
/interface ethernet set $iface master-port=none
}
:log info "--- Remove old DHCP client ---";
:local o [/ip dhcp-client find]
:if ([:len $o] != 0) do={ /ip dhcp-client remove $o }
:log info "--- Remove old PPPoE client ---";
:local o [/interface pppoe-client find]
:if ([:len $o] != 0) do={ /interface pppoe-client remove $o }
:log info "--- Disable wireless interface ---";
/interface wireless set wlan1 disabled=yes security-profile=default;
:log info "--- Remove old non-default security profiles ---";
:local o [/interface wireless security-profiles find where name!=default]
:if ([:len $o] != 0) do={ /interface wireless security-profiles remove $o }
:log info "--- Remove old bridge interfaces and their ports ---";
:local o [/interface bridge port find where dynamic=no]
:if ([:len $o] != 0) do={ /interface bridge port remove $o }
:local o [/interface bridge find]
:if ([:len $o] != 0) do={ /interface bridge remove $o }
:log info "--- Clearing all pre-existing settings (DHCP) ---";
:local o [/ip dhcp-server network find]
:if ([:len $o] != 0) do={ /ip dhcp-server network remove $o }
:local o [/ip dhcp-server find]
:if ([:len $o] != 0) do={ /ip dhcp-server remove $o }
:local o [/ip pool find]
:if ([:len $o] != 0) do={ /ip pool remove $o }
/ip dns {
set allow-remote-requests=no
:local o [static find]
:if ([:len $o] != 0) do={ static remove $o }
}
/ip address {
:local o [find]
:if ([:len $o] != 0) do={ remove $o }
}
:log info "--- Disabling UPnP ---";
:local o [/ip upnp interfaces find]
:if ([:len $o] != 0) do={ /ip upnp interfaces remove $o }
/ip upnp set enabled=no;
#-------------------------------------------------------------------------------
:log info "--- Setup interface(s) ---";
/interface set ether1 name="$ether1";
:log info "--- Setting up a dhcp client on the wan interface ---";
/ip dhcp-client add interface=$ether1 disabled=no comment="Gateway Interface" use-peer-dns=no use-peer-ntp=no add-default-route=no;
:log info "--- Setup switching ---";
/interface ethernet {
set ether4 name="$ether4";
set ether2 name="$ether2" master-port=$ether4;
set ether3 name="$ether3" master-port=$ether4;
}
:log info "--- Setup PPPoE ---";
/interface pppoe-client add interface=$ether1 name=$tap1 disabled=no user=$tap1Login password=$tap1Password use-peer-dns=no add-default-route=yes default-route-distance=0
:log info "--- Add WPA/WPA2 security profile ---";
/interface wireless security-profiles
add authentication-types=wpa-psk,wpa2-psk eap-methods="" group-ciphers=
tkip,aes-ccm mode=dynamic-keys name=wpa2-protected supplicant-identity=""
unicast-ciphers=tkip,aes-ccm wpa-pre-shared-key=$wpaPreSharedKey
wpa2-pre-shared-key=$wpaPreSharedKey
:log info "--- Enable and setting wireless interface ---";
/interface wireless set wlan1 disabled=no ssid="$systemName" mode=ap-bridge band=2ghz-b/g/n
frequency=2432 bridge-mode=enabled wireless-protocol=802.11 security-profile=wpa2-protected
default-authentication=yes default-forwarding=yes hide-ssid=no
:log info "--- Disable nstreme protocol ---";
/interface wireless nstreme set wlan1 enable-nstreme=no enable-polling=no disable-csma=no
:log info "--- Setting local network bridge ---";
/interface bridge add name=$br1
/interface bridge port add interface=$ether4 bridge=$br1
/interface bridge port add interface=wlan1 bridge=$br1
#-------------------------------------------------------------------------------
:log info "--- Setting the routers LAN address to $lanAddress/$lanNetworkBits ---";
/ip address add address="$lanAddress/$lanNetworkBits" interface=$br1 network=$lanNetworkAddress comment="router LAN address";
:log info "--- Setting DHCP server on interface, pool $poolStart-$poolEnd ---";
/ip pool add name=$lanPoolName ranges="$poolStart-$poolEnd";
/ip dhcp-server add name="$dhcpServer" address-pool=$lanPoolName interface=$br1 disabled=no lease-time=10m;
/ip dhcp-server network add address="$lanNetworkAddress/$lanNetworkBits" gateway=$lanAddress dns-server=$lanAddress comment="local DHCP network";
:log info "--- Setting DNS servers to $nsA and $nsB ---";
/ip dns {
set allow-remote-requests=yes servers="$nsA,$nsB,$nsC";
static add name=$systemName address=$lanAddress;
}
#-------------------------------------------------------------------------------
# open ports: 8291 - winbox, 22 - ssh, 53 - dns, 123 - ntp
#
/ip firewall filter {
add action=accept chain=input protocol=icmp
add action=accept chain=input connection-state=new dst-port=8291,22 in-interface=$br1 protocol=tcp src-address="$lanNetworkAddress/$lanNetworkBits"
add action=accept chain=input connection-state=new dst-port=53,123 protocol=udp src-address="$lanNetworkAddress/$lanNetworkBits"
add action=accept chain=input connection-state=established,related comment="Allow established connections"
add action=accept chain=output connection-state=!invalid
add action=accept chain=forward connection-state=established,new in-interface=$br1 out-interface=$tap1 src-address="$lanNetworkAddress/$lanNetworkBits"
add action=accept chain=forward connection-state=established,related in-interface=$tap1 out-interface=$br1
add action=drop chain=input
add action=drop chain=output
add action=drop chain=forward
}
/ip firewall nat {
add action=masquerade chain=srcnat out-interface=$tap1 src-address="$lanNetworkAddress/$lanNetworkBits";
}
#-------------------------------------------------------------------------------
:log info "--- Setting UPnP ---";
/ip upnp set enabled=yes;
/ip upnp interfaces add interface=$tap1 type=external;
/ip upnp interfaces add interface=$br1 type=internal;
#-------------------------------------------------------------------------------
:log info "--- Disabling neighbor discovery ---";
/ip neighbor discovery set [find name=$ether1] discover=no;
/ip neighbor discovery set [find name=$tap1] discover=no;
:log info "--- Disabling bandwidth test server ---";
/tool bandwidth-server set enabled=no;
:log info "--- Disabling router services ---";
/ip service {
:foreach s in=[find where !disabled and name!=winbox] do={
set $s disabled=yes;
}
:log info "--- Enabling secure shell service on port ---";
:local o [find name=ssh !disabled]
:if ([:len $o] = 0) do={
set ssh disabled=no port=22;
}
}
:log info "--- Disabling firewall service ports ---";
/ip firewall service-port {
:foreach o in=[find where !disabled and name!=sip and name!=pptp] do={
set $o disabled=yes;
}
}
:log info "--- Disable mac server tools ---";
/tool mac-server disable [find];
/tool mac-server mac-winbox disable [find];
:log info "Auto configuration ended.";
/system reboot;
}
Настройка и выполнение
1) Задаём свои значения параметрам systemName, adminPassword, tap1Login, tap1Password, wpaPreSharedKey. По желанию изменяем другие параметры.
2) Добавляем скрипт при помощи winbox в System -> Scripts -> [+]
3) Выполнять можно двумя способами:
* /system reset-configuration no-defaults=yes skip-backup=yes run-after-reset=<script_name>.rsc
* /system script run <script_name>.rsc
Перевод Алексей Орлов
Оригинал статьи
Перевёл: Алексей Орлов
1. РУКОВОДСТВО ПО ЯЗЫКУ СКРИПТОВ
Это руководство является введением в мощный встроенный язык скриптов для RouterOS.
Язык предоставляет возможность для автоматизации задач средствами исполнения определённых ползователем скриптов, связанных с какими-либо событиями.
Скрипты могут могут храниться в репозитории (хранилище) или могут быть написаны прямо в консоли. События, вызывающие исполнение скриптов генерируются системным планировщиком, утилитой мониторинга траффика и утилитой netwatch, но не ограничены только этими генераторами.
1.1 СТРУКТУРА КОМАНДЫ
Скрипты для RouterOS состоят из команд. Команды исполняются одна за одной, пока не будет достигнут конец скрипта или не возникнет ошибка во время исполнения.
Команда
Консоль использует следующий синтакс команды:
[prefix] [path] command [uparam] [param=[value] .. param=[value]]
- [prefix] — может принимать следующие символьные значения, «:» или «/», что определяет команду, как ICE или путь.
- [path] — относительный путь к желаемому уровню меню.
- command — одна из возможных встроенных команд, определённых уровнем меню.
- [uparam] — безымянный параметр, кот. должен быть определён, если этого требует встроеная команда (command).
- [params] — последовательность именованых параметров со значениями.
Каждая команда заканчивается символом ";"
или концом строки. В некоторых случаях эти символы не нужны для окончания команды. Команда внутри ()
, []
или {}
не нуждается в таких символах.
:if ( true ) do={ :put "lala" }
Каждая команда внутри другой команды начинается и заканчивается квадратными скобками [] (объединение команд):
:put [/ip route get [find gateway=1.1.1.1]];
Команда может состоять из нескольких строк, объединённых специальным символом. Смотри «Объединение команд».
* Команда и EOL (End of Line) *
Команда — это последовательность символов, заканчивающихся EOL последовательностью. Любая из стандартных последовательностей EOL может быть использована:
- Unix = ASCII LF
- Windows = ASCII CR LF
- Mac = ASCII CR
Комментарии
Комментарий начинается с символа «#» и заканчивается последовательностью EOL. Пробел и любые другие символы не разрешены к использованию перед #. Комментарии игнорируются синтаксическим анализатором. Если символ # появится в строке, то это не будет считаться комментарием:
# хороший комментарий # плохой комментарий :global a; # плохой комментарий :global myStr "лала # это не комментарий"
Объединение команд
Две или более строки могут быть объединены в одну команду, если использовать символ «» (обратный слэш). Это не работает с комментариями и с токенами исключая строки. Примеры:
:if ($a = true and $b=false) do={ :put “$a $b”; } :if ($a = true # неудачная попытка and $b=false) do={ :put “$a $b”; } # comment continued – invalid (синтаксическая ошибка)
Пробелы между токенами
Пробелы используются для разделения токенов. Пробел необходим между двумя токенами только если их объединение может быть интерпретировано, как другой токен. Пример:
{ :local a true; :local b false; # whitespace is not required :put (a&&b); # whitespace is required :put (a and b); }
Пробелы не разрешены в следующих конструкциях:
- <parameter>=
- from=, to=, step=, in=, do=, else=
Пример:
#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
Области видимости
Переменные могут быть использованы только в определённых областях скрипта. Эти области называют областями видимости. Существует два типа областей видимости: локальная и глобальная. Переменная, объявленная внутри блока может быть использована только в его пределах после места объявления.
Глобальная область видимости, по другому корневая область, видимости является областью по умолчанию для скрипта. Она создаётся автоматически и существует всегда.
Пользователь может определить свои области видимости при помощи скобок {}
. Такие области называются локальными. Пример:
{ :local a 3; { :local b 4; :put ($a+$b); } # команда ниже некорректна, так как переменная b не определена в данной области видимости :put ($a+$b); }
Важное замечание: каждая команда в консоли обрабатывается в своей локальной области видимости.
[admin@MikroTik] > :local myVar a; [admin@MikroTik] > :put $myVar syntax error (line 1 column 7)
Важно: не определяйте глобальные переменные внутри локальных областей видимости.
# этот код сгенерирует ошибку { :local a 3; { :global b 4; } :put ($a+$b); }
1.2 ЗАРЕЗЕРВИРОВАННЫЕ СЛОВА
Следующие слова являются зарезервированными и не могут быть использованы, как имена переменных или функций:
and or not in
1.3 ОГРАНИЧИТЕЛИ
Следующие токены служат ограничителями в грамматике:
() [] {} : ; $ /
1.4 ТИПЫ ДАННЫХ
Язык имеет следующие типы данных:
- num — 64 битное знаковое целое. может быть инициализировано шестнадцатиричным значением
- bool — булев тип. может быть true или false
- str — строковый тип. последовательность символов
- ip — IP адрес
- ip6-prefix — IPv6 префикс
- id — шестнадцатиричное значение с префиксом *. Каждая позиция меню имеет уникальный внутрений ID
- time — дата и время
- array — последовательность значений, массив
- nil — тип переменной по умолчанию, если она не инициализирована никаким значением
Escape последовательности
Следующие последовательности могут быть использованы для помещения спецсимволов в строки:
- » — двойные кавычки
- \ — обратный слэш
- n — символ конца строки
- r — return
- t — горизонтальная табуляция
- $ — знак доллара
- ? — знак вопроса. спецназначение этого символа — выводить справку меню
- _ — пробел
- a — звуковой сигнал терминала BEL (0x07)
- b — бэкспейс
- f — form feed (0xFF)
- v — вертикальная табуляцияxx — шестнадцатиричный код символа
Пример:
:put «48454C4C4FrnThisrnisrnarntest»;
Вывод:
HELLO This is a test
1.5 ОПЕРАТОРЫ
Арифметические операторы
- + бинарное сложение
- — бинарное вычитание
- * бинарное умножение
- / бинарное деление
- — унарное отрицание
Примеры:
:put (3+4); :put (3-4); :put (3*4); :put (10 / 2); :put ((10)/2) { :local a 1; :put (-a); }
Операторы сравнения
- < меньше
- > больше
- = равно
- <= меньше или равно
- >= больше или равно
- != не равно
Логические операторы
- (!, not) НЕ
- (&&, and) И
- (||, or) ИЛИ
- (in) оператор принадлежности (пример, :put (1.1.1.1/32 in 1.0.0.0/8);)
Битовые операторы
Применимы к числовому типу и типу IP address.
- | ИЛИ
- & И
- ~ Инверсия
- ^ XOR
- << сдвиг влево
- >> сдвиг вправо
Примеры. Вычисление адреса подсети по IP адресу и маске
{ :local IP 192.168.88.77; :local CIDRnetmask 255.255.255.0; :put ($IP&$CIDRnetmask); }
Получение последних 8 бит IP адреса
:put (192.168.88.77&0.0.0.255);
Вычисление широковещательного адреса
{ :local IP 192.168.88.77; :local Network 192.168.88.0; :local CIDRnetmask 255.255.255.0; :local InvertedCIDR (~$CIDRnetmask); :put ($Network|$InvertedCIDR) }
* Операторы конкатенации *
- . конкатенаци двух строк :put (“concatenate” . “ “ . “string”);
- , конкатенация двух массивов или обавление значения в массив :put ({1;2;3} , 5 );
Также возможно добавлять значения переменных в строки без конкатенации
:global myVar "world"; :put ("Hello " . $myVar); # следующая команда делает тоже, что предыдущая :put "Hello $myVar";
Используя $[] и $() можно добавлять выражения внутрь строк
:local a 5; :local b 6; :put "5x6 = $($a * $b)"; :put "We have $[ :len [/ip route find] ] routes";
* Другие операторы *
[] Использование команды в команде
() Группировка выражений
$ Унарный оператор подстановки. доступ к значению переменной
~ Бинарный оператор, сравнивающий значение с POSIX регулярным выражением
-> Получение элемента массива по ключу
Пример с регулярными выражениями
# печатаем все маршруты со шлюзом, у которого адрес заканчивается на 202 /ip route print where gateway~"^[0-9\.]*202"
Пример с массивом
[admin@x86] >:global aaa {a=1;b=2} [admin@x86] > :put ($aaa->"a") 1 [admin@x86] > :put ($aaa->"b") 2
1.6 ПЕРЕМЕННЫЕ
Язык допускает два типа переменных, глобальные и локальные.
global — доступно из всех скриптов, созданных текущим пользователем.
local — доступно только внутри текущей области видимости.
Замечание: значение переменной ограничено 4096 байтами.
Каждая переменная, исключая встроенные, должна быть объявлена перед использованием при помощи зарезервированных слов global или local.
# некорректный код :set myVar "my value"; :put $myVar # корректный код :local myVar; :set myVar "my value"; :put $myVar;
Исключая случай, когда используется множество (set) переменных. Пример
/system script add name=myLeaseScript policy= ftp,reboot,read,write,policy,test,winbox,password,sniff,sensitive,api source=":log info $leaseActIPr n:log info $leaseActMACr n:log info $leaseServerNamer n:log info $leaseBound" /ip dhcp-server set myServer lease-script=myLeaseScript
Допустимыми символами для составления имён переменных являются буквы и цифры. Если имя содержит любые другие символы, то его нужно помещать в двойные кавычки «».
# корректно :local myVar; # некорректно :local my-var; # корректно :global "my-var";
Если переменная объявлена, но не инициализирована, то ей назначается тип nil. Иначе тип определяется автоматически. Иногда необходимо преобразовать переменную из одного типа в другой. Это можно сделать при помощи специалных команд.
# преобразование строки в массив :local myStr "1,2,3,4,5"; :put [:typeof $myStr]; :local myArr [:toarray $myStr]; :put [:typeof $myArr]
Имена переменных чувствительны к регистру. Команда set без значения удаляет переменную из окружения.
:global myVar "myValue" :set myVar;
1.7 ВСТРОЕННЫЕ КОМАНДЫ
* Навигация и справка *
1) / — переход в корень меню
2) .. — переход в меню на один уровень выше
3) ? — список всех возможных команд меню с описанием
* Команды общего назначения *
Любая встроенная команда начинается с символа «:», иначе она будет воспринята, как переменная.
1) global — определение глобальной переменной
Синтаксис:
:global <var> [<value>]
Пример:
:global myVar "something"; :put $myVar; 2) local - определение локальной переменной
Синтаксис:
:local <var> [<value>]
Пример:
{ :local myLocalVar «I am local»; :put $myVar; }
3) beep — звуковой сингнал из встроенного спикера
Синтаксис:
:beep <frequency> <length>
Пример:
:beep frequency=320 length=100ms;
4) delay — задержка заданный период времени
Синтаксис:
:delay <time>
Пример:
:delay 50ms;
5) put — вывод в консоль
Синтаксис:
:put <expression>
6) len — печать длины переданой последовательности (массива или строки)
Синтаксис:
:len <expression>
Пример:
:put [:len «length=8»];
7) typeof — определение типа переменной
Синтаксис:
:typeof <var>
Пример:
:put [:typeof 4];
pick — вернуть подпоследовательность массива или строки. если <end> неопределено, то вернёт элемент из позиции <start>
Синтаксис:
:pick <var> <start> [<end>]
Пример:
:put [:pick «abcde» 1 3]
9) log — запись в системный лог. topic={debug, error, info, warning}
Синтаксис:
:log <topic> <message>
Пример:
:log info «Hello from script»;
10) time — определить время, необходимое для выполнения команды
Синтаксис:
:time <expression>
Пример:
:put [:time {:for i from=1 to=10 do={ :delay 100ms }}];
11) set — присвоить значение переменной
Пример:
:global a; :set a true;
12) find — вернуть позицию искомого в строке или массиве
Синтаксис:
:find <arg> <arg> <start>
Пример:
:put [:find «abc» «a» -1];
13) environment — печать информации об инициализированных переменных
Синтаксис:
:environment print <start>
Пример:
:global myVar true; :environment print;
14) terminal — ?
15) error — сгенерировать ошибку в консоль и остановить выполнение
Синтаксис:
:error <output>
16) execute — выполнение скрипта в фоне
Синтаксис:
:execute <script>
Пример:
:local j [:execute {/interface print follow where [:log info ~Sname~]}];
:delay 10s;
:do { /system script job remove Sj } on-error={}
17) parse — парсинг текста в набор команд для исполнения. можно использовать для определения функций
Синтаксис:
:parse <text>
Пример:
:global myFunc [:parse «:put hello!»];
$myFunc;
18) resolve — разрешение имени в IP адрес
Пример:
:put [:resolve «www.mikrotik.com»];
* Команды преобразования типов *
1) toarray <var>
2) tobool <var>
3) toid <var>
4) toip <var>
5) toip6 <var>
6) tonum <var>
7) tostr <var>
totime <var>
* Команды, специфичные для меню *
Следующие команды доступны в большинстве подменю и не требуют использования символа «:»
1) add — добавить запись
Синтаксис:
add <param>=<value>..<param>=<value>
2) remove — удалить запись
Синтаксис:
remove <id>
3) enable — активировать запись
Синтаксис:
enable <id>
4) disable — дизактивировать запись
Синтаксис:
disable <id>
5) set — изменение параметров записи с заданным ID
Синтаксис:
set <id> <param>=<value>..<param>=<value>
6) get — ?
Синтаксис:
get <id> <param>=<value>
Пример:
/system script get myScript source
7) print — печать записей. вывод зависит от параметров
Синтаксис:
print <param><param>=[<value>]
export — сохранить записи в файл в виде скрипта, если файл указан. иначе вывести записи в окно терминала
Синтаксис:
export [file=<value>]
9) edit — редактирование выделеной записи во встроеном текстовом редакторе
Синтаксис:
edit <id> <param>
10) find — вернуть список ID записей, которые совпадают с expression.
Синтаксис:
find <expression>
Пример:
:put [/interface find name~»ether»]
Возможный вывод:
*1;*2;*3;*4
* Импорт *
Команда import доступна из корневого меню и используется для импорта конфигураций из файлов, созданных командой export или вручную.
* Параметры команды print *
append —
as-value — вернуть, как массив параметров и их значений ( :put [/ip address print as-value] )
brief — печать в сокращённом табличном виде
advanced —
detail — детальная печать, отображает все параметры
count-only — печатать количество записей, а не сами записи
file — перенаправить печать в файл
follow — печать текущих записей и слежение за появлением новых записей, пока не будет нажата комбинация ctrl+c ( /log print follow )
follow-only — печать и слежение только за новыми записями. выход также по ctrl+c
from — печатать параметры только указанной записи ( /user print from=admin )
interval — непрерывно печатать через определённые интервалы времени
terse — отобразить в компактном, удобном для программной обработки виде
value-list — отобразить параметры и значения по одному на линии. удобно для парсинга
without-paging — печать информации без разбиения на части
where — фильтр по значению какого-либо параметра
Одновременно можно использовать несколько параметров. Пример:
# печатать текущее количество маршрутов через интерфейс ether1 каждую секунду
/ip route print count-only interval=1 where interface=»ether1″
1.8 ЦИКЛЫ И ВЕТВЛЕНИЯ
* Циклы *
— while и do-while
:while ( <conditions> ) do={ <commands> };
:do { <commands> } while=( <conditions> );
— for
:for <var> from=<int> to=<int> step=<int> do={ <commands> }
— foreach
:foreach <var> in=<array> do={ <commands> };
* Ветвление *
:if(<condition>) do={<commands>} else={<commands>}
Пример:
{
:local myBool true;
:if ($myBool = false) do={ :put «value is false» } else={ :put «value is true» }
}
1.9 ФУНКЦИИ
Язык не позволяет создавать функции напрямую, однако можно использовать команду :parse, как обходной способ для создания функций. Начиная с версии 6.2 добавлен новый синтаксис, позволяющий определять функции и передавать им параметры. Также возможно возвращать значение из функции при помощи команды :return. Пример:
# создание и выполнение простой функции :global myFunc do={:put "hello from function"} $myFunc
Вывод:
hello from function # передача аргументов в функцию :global myFunc do={:put "arg a=$a"; :put "arg '1'=$1"} $myFunc a="this is arg a value" "this is arg1 value" Вывод: arg a=this is arg a value arg '1'=this is arg1 value
Из примера видно, что существуют два способа передачи аргументов в функцию:
— передача по имени
— передача по порядковому номеру
Пример использования :return
:global myFunc do={ :return ($a + $b)}
:put [$myFunc a=6 b=2]
Вывод:
8
Также возможно копирование существующего скрипта из окружения и использование его, как функции. Пример:
#add script /system script add name=myScript source=":put "Hello $myVar !"" :global myFunc [:parse [/system script get myScript source]] $myFunc myVar=world Вывод: Hello world !
Внимание: если функция содержит глобально определённую переменную с именем совпадающим с именем передаваемого параметра, то глобально определённая переменная будет проигнорирована, для совместимости со старыми версиями. Эта возможность может быть изменена в будущих версиях. Избегайте использование параметров с теми же именами, что и глобальные переменные. Пример:
:global my2 "123" :global myFunc do={ :global my2; :put $my2; :set my2 "lala"; :put $my2 } $myFunc my2=1234 :put "global value $my2"
Вывод:
1234
lala
global value 123
Чтобы вызвать функцию внутри другой функции, её имя должно быть определено.
:global funcA do={ :return 5 } :global funcB do={ :global funcA; :return ([$funcA] + 4) } :put [$funcB]
Вывод:
9
1.10 ПЕРЕХВАТ И ОБРАБОТКА ОШИБОК ВО ВРЕМЯ ИСПОЛНЕНИЯ
Начиная с версии 6.2 скрипты могут перехватывать ошибки, возникающие во время выполнения. Рассмотрим следующий скрипт:
{ :put [:resolve www.a.com]; :put «lala»; }
failure: dns name does not exist
Мы хотим перехватить эту ошибку и обработать её:
:do {
:put [:resolve www.a.com]
} on-error={ :put «resolver failed»};
:put «lala»
Вывод:
resolver failed
lala
1.11 ОПЕРАЦИИ С МАССИВАМИ
Внимание: Если имя ключа содержит символы, отличающиеся от латинских в нижнем регистре, то такое имя нужно заключать в двойные кавычки. Пример:
{:local a { «aX»=1 ; ay=2 }; :put ($a->»aX»)}
Конструкция foreach может быть использована для циклического прохода элементам массива.
:foreach k,v in={2; «aX»=1 ; y=2; 5} do={:put («$k=$v»)}
Вывод:
0=2
1=5
aX=1
y=2
Если элементы массива имеют ключевую часть, то они сортируются в алфавитном порядке (alphabetical order) по ключу. Элементы без ключевой части распологаются до элементов с ключевой частью и их порядок остаётся неизменным.
Если конструкиця foreach используется с одним аргументом, то возвращаются значения элементов.
:foreach k in={2; «aX»=1 ; y=2; 5} do={:put («$k»)}
Вывод:
2
5
1
2
Пример изменеия значения элемента массива:
:global a {x=1; y=2}
:set ($a->»x») 5
:environment print
Вывод:
a={x=5; y=2}
2. РЕПОЗИТОРИЙ (ХРАНИЛИЩЕ) СКРИПТОВ
Уровень меню: /system script
Содержит скрипты, созданные пользователями. Скрипты могут быть выполнены в следующих случаях:
— по событию
— один скрипт вызывает другой скрипт
— запуск вручную
Параметры скриптов:
— comment (тип: string, значение по умолчанию: «») — комментарий, облегчающий понимание, что делает скрипт
— name (тип: string, значение по умолчанию: «Script[num]») — уникальное имя
— policy (тип: string, значение по умолчанию: «») — список применяемых политик
* api — разрешает использование API
* ftp — разрешает удалённый доступ по ftp, передачу файлов на и с роутера
* local — разрешает локальный вход через консоль
* password — разрешает смену паролей
* policy — управление пользователями, добавление/удаление
* read — разрешение чтения конфигурации
* reboot — разрешение на перезагрузку
* sensitive — просмотр паролей и прочей информации
* sniff — разрешение использовать sniffer, torch и тд
* ssh — разрешение на удалённый логин по ssh
* telnet — разрешение на удалённый логин по telnet
* test — разрешение использовать ping, traceroute, bandwidth test
* web — разрешение на удалённый логин по http
* winbox — разрешает использование winbox
* write — разрешение изменения конфигурации
— source (тип: string, значение по умолчанию: «») — код скрипта
Параметры состояния, доступные только для чтения:
— last-started (тип: date) — дата и время последнего запуска
— owner (тип: string) — владелец скрипта
— run-count (тип: integer) — количство запусков
Команда запуска:
run [id | name]
2.1 Окружение
Уровень меню: /system script environment или /environment
Содержит все переменные, определённые пользователем и их значения. Пример:
[admin@MikroTik] > :global example;
[admin@MikroTik] > :set example 123
[admin@MikroTik] > /environment print
Вывод:
«example»=123
Параметры только для чтения:
* name (тип: string)
* user (тип: string)
* value
2.2 Список выполняющихся скриптов
Уровень меню: /system script job
Содержит список всех скриптов, выполняющихся в данный момент.
Параметры только для чтения:
* owner (тип: string)
* policy (тип: array)
* started (тип: date)
3. ПРАКТИКА
Задача: базовая настройка домашнего или офисного маршрутизатора на базе hAp lite.
Решение: Данное решение предполагает, что провайдер даёт доступ в интернет через PPPoE. Настройку других способов подключения можно почитать в статье на хабре (https://habrahabr.ru/post/265387/). Основа для скрипта была взята из репозитория (https://github.com/jadiaz/MikroTik).
{ # Encoding must be UTF-8! #------------------------------------------------------------------------------- # Set the name of the router and its SSID :local systemName "" # Set the password you would like to use when logging on as 'admin'. :local adminPassword "" # Time Servers (NTP) :local ntpA "173.230.149.23" :local ntpB "198.110.48.12" # Name Servers (DNS) - set to OpenDNS. This should be set to a set of servers that are local and FAST :local nsA "216.116.96.2" :local nsB "216.52.254.33" :local nsC "68.111.16.30" # DHCP :local dhcpServer "dhcp-local-server" :local lanPoolName "dhcp-local-pool" :local poolStart "192.168.20.100" :local poolEnd "192.168.20.200" # Addresses :local lanAddress "192.168.20.1" :local lanNetworkAddress "192.168.20.0" :local lanNetworkBits "24" # Interfaces :local ether1 "ether1-wan" :local ether2 "ether2-slave-lan" :local ether3 "ether3-slave-lan" :local ether4 "ether4-master-lan" :local tap1 "tap1-gateway" :local tap1Login "" :local tap1Password "" :local br1 "br1-local" # wpa/wpa2 pre-shared key :local wpaPreSharedKey "" #------------------------------------------------------------------------------- :log info "--- Setting timezone ---"; /system clock set time-zone-autodetect=yes; :log info "--- Setting up the time server client ---"; /system ntp client set enabled=yes primary-ntp=$ntpA secondary-ntp=$ntpB; :log info "--- Setting the system name ---"; /system identity set name=$systemName; :log info "--- Setting the admin password ---"; /user set admin password=$adminPassword; #------------------------------------------------------------------------------- :log info "--- Clearing all pre-existing settings ---"; :log info "--- Clearing firewall ---"; /ip firewall { :log info "--- Clearing any existing NATs ---"; :local o [nat find] :if ([:len $o] != 0) do={ nat remove numbers=$o } :log info "--- Clearing old filters ---"; :local o [filter find where dynamic=no] :if ([:len $o] != 0) do={ filter remove $o } :log info "--- Clearing old address lists ---"; :local o [address-list find] :if ([:len $o] != 0) do={ address-list remove numbers=$o } :log info "--- Clearing previous mangles ---"; :local o [mangle find where dynamic=no] :if ([:len $o] != 0) do={ mangle remove numbers=$o } :log info "--- Clearing previous layer-7 ---"; :local o [layer7-protocol find] :if ([:len $o] != 0) do={ layer7-protocol remove numbers=$o } } :log info "--- Resetting Mac Server ---"; /tool mac-server remove [find interface!=all] /tool mac-server set [find] disabled=no /tool mac-server mac-winbox remove [find interface!=all] /tool mac-server mac-winbox set [find] disabled=no :log info "--- Resetting neighbor discovery ---"; /ip neighbor discovery set [find name=$ether1] discover=yes :log info "--- Reset interfaces to default ---"; :foreach iface in=[/interface ethernet find] do={ /interface ethernet set $iface name=[get $iface default-name] /interface ethernet set $iface master-port=none } :log info "--- Remove old DHCP client ---"; :local o [/ip dhcp-client find] :if ([:len $o] != 0) do={ /ip dhcp-client remove $o } :log info "--- Remove old PPPoE client ---"; :local o [/interface pppoe-client find] :if ([:len $o] != 0) do={ /interface pppoe-client remove $o } :log info "--- Disable wireless interface ---"; /interface wireless set wlan1 disabled=yes security-profile=default; :log info "--- Remove old non-default security profiles ---"; :local o [/interface wireless security-profiles find where name!=default] :if ([:len $o] != 0) do={ /interface wireless security-profiles remove $o } :log info "--- Remove old bridge interfaces and their ports ---"; :local o [/interface bridge port find where dynamic=no] :if ([:len $o] != 0) do={ /interface bridge port remove $o } :local o [/interface bridge find] :if ([:len $o] != 0) do={ /interface bridge remove $o } :log info "--- Clearing all pre-existing settings (DHCP) ---"; :local o [/ip dhcp-server network find] :if ([:len $o] != 0) do={ /ip dhcp-server network remove $o } :local o [/ip dhcp-server find] :if ([:len $o] != 0) do={ /ip dhcp-server remove $o } :local o [/ip pool find] :if ([:len $o] != 0) do={ /ip pool remove $o } /ip dns { set allow-remote-requests=no :local o [static find] :if ([:len $o] != 0) do={ static remove $o } } /ip address { :local o [find] :if ([:len $o] != 0) do={ remove $o } } :log info "--- Disabling UPnP ---"; :local o [/ip upnp interfaces find] :if ([:len $o] != 0) do={ /ip upnp interfaces remove $o } /ip upnp set enabled=no; #------------------------------------------------------------------------------- :log info "--- Setup interface(s) ---"; /interface set ether1 name="$ether1"; :log info "--- Setting up a dhcp client on the wan interface ---"; /ip dhcp-client add interface=$ether1 disabled=no comment="Gateway Interface" use-peer-dns=no use-peer-ntp=no add-default-route=no; :log info "--- Setup switching ---"; /interface ethernet { set ether4 name="$ether4"; set ether2 name="$ether2" master-port=$ether4; set ether3 name="$ether3" master-port=$ether4; } :log info "--- Setup PPPoE ---"; /interface pppoe-client add interface=$ether1 name=$tap1 disabled=no user=$tap1Login password=$tap1Password use-peer-dns=no add-default-route=yes default-route-distance=0 :log info "--- Add WPA/WPA2 security profile ---"; /interface wireless security-profiles add authentication-types=wpa-psk,wpa2-psk eap-methods="" group-ciphers= tkip,aes-ccm mode=dynamic-keys name=wpa2-protected supplicant-identity="" unicast-ciphers=tkip,aes-ccm wpa-pre-shared-key=$wpaPreSharedKey wpa2-pre-shared-key=$wpaPreSharedKey :log info "--- Enable and setting wireless interface ---"; /interface wireless set wlan1 disabled=no ssid="$systemName" mode=ap-bridge band=2ghz-b/g/n frequency=2432 bridge-mode=enabled wireless-protocol=802.11 security-profile=wpa2-protected default-authentication=yes default-forwarding=yes hide-ssid=no :log info "--- Disable nstreme protocol ---"; /interface wireless nstreme set wlan1 enable-nstreme=no enable-polling=no disable-csma=no :log info "--- Setting local network bridge ---"; /interface bridge add name=$br1 /interface bridge port add interface=$ether4 bridge=$br1 /interface bridge port add interface=wlan1 bridge=$br1 #------------------------------------------------------------------------------- :log info "--- Setting the routers LAN address to $lanAddress/$lanNetworkBits ---"; /ip address add address="$lanAddress/$lanNetworkBits" interface=$br1 network=$lanNetworkAddress comment="router LAN address"; :log info "--- Setting DHCP server on interface, pool $poolStart-$poolEnd ---"; /ip pool add name=$lanPoolName ranges="$poolStart-$poolEnd"; /ip dhcp-server add name="$dhcpServer" address-pool=$lanPoolName interface=$br1 disabled=no lease-time=10m; /ip dhcp-server network add address="$lanNetworkAddress/$lanNetworkBits" gateway=$lanAddress dns-server=$lanAddress comment="local DHCP network"; :log info "--- Setting DNS servers to $nsA and $nsB ---"; /ip dns { set allow-remote-requests=yes servers="$nsA,$nsB,$nsC"; static add name=$systemName address=$lanAddress; } #------------------------------------------------------------------------------- # open ports: 8291 - winbox, 22 - ssh, 53 - dns, 123 - ntp # /ip firewall filter { add action=accept chain=input protocol=icmp add action=accept chain=input connection-state=new dst-port=8291,22 in-interface=$br1 protocol=tcp src-address="$lanNetworkAddress/$lanNetworkBits" add action=accept chain=input connection-state=new dst-port=53,123 protocol=udp src-address="$lanNetworkAddress/$lanNetworkBits" add action=accept chain=input connection-state=established,related comment="Allow established connections" add action=accept chain=output connection-state=!invalid add action=accept chain=forward connection-state=established,new in-interface=$br1 out-interface=$tap1 src-address="$lanNetworkAddress/$lanNetworkBits" add action=accept chain=forward connection-state=established,related in-interface=$tap1 out-interface=$br1 add action=drop chain=input add action=drop chain=output add action=drop chain=forward } /ip firewall nat { add action=masquerade chain=srcnat out-interface=$tap1 src-address="$lanNetworkAddress/$lanNetworkBits"; } #------------------------------------------------------------------------------- :log info "--- Setting UPnP ---"; /ip upnp set enabled=yes; /ip upnp interfaces add interface=$tap1 type=external; /ip upnp interfaces add interface=$br1 type=internal; #------------------------------------------------------------------------------- :log info "--- Disabling neighbor discovery ---"; /ip neighbor discovery set [find name=$ether1] discover=no; /ip neighbor discovery set [find name=$tap1] discover=no; :log info "--- Disabling bandwidth test server ---"; /tool bandwidth-server set enabled=no; :log info "--- Disabling router services ---"; /ip service { :foreach s in=[find where !disabled and name!=winbox] do={ set $s disabled=yes; } :log info "--- Enabling secure shell service on port ---"; :local o [find name=ssh !disabled] :if ([:len $o] = 0) do={ set ssh disabled=no port=22; } } :log info "--- Disabling firewall service ports ---"; /ip firewall service-port { :foreach o in=[find where !disabled and name!=sip and name!=pptp] do={ set $o disabled=yes; } } :log info "--- Disable mac server tools ---"; /tool mac-server disable [find]; /tool mac-server mac-winbox disable [find]; :log info "Auto configuration ended."; /system reboot; }
* Настройка и выполнение
1) Задаём свои значения параметрам systemName, adminPassword, tap1Login, tap1Password, wpaPreSharedKey. По желанию изменяем другие параметры.
2) Добавляем скрипт при помощи winbox в System -> Scripts -> [+]
3) Выполнять можно двумя способами:
* /system reset-configuration no-defaults=yes skip-backup=yes run-after-reset=<script_name>.rsc
* /system script run <script_name>.rsc
-
agach
- Сообщения: 40
- Зарегистрирован: Вт янв 22, 2008 19:32
mikrotik syntax
непонятная проблема с синтаксисом микротика.
посылается команда добавления в ip firewall address-list — все нормально. А вот при удалении возникает синтаксическая ошибка. микротик ругается именно на номер
вот лист
ssh utmagent@192.168.100.5 «/ip firewall address-list print «
Flags: X — disabled, D — dynamic
# LIST ADDRESS
0 ;;; 1
allow_ip 192.168.10.2
а вот ругается на команду
[root@localhost bin]# ssh utmagent@192.168.100.5 «/ip firewall address-list remove 1»
syntax error (line 1 column 34)
хотя на самом микротике(в терминале) эта же команда хавается без проблем
Последний раз редактировалось agach Вт май 19, 2009 11:59, всего редактировалось 2 раза.
-
shoorickello
- Сообщения: 134
- Зарегистрирован: Ср июн 29, 2005 13:08
Сообщение
shoorickello » Вт май 19, 2009 11:59
Команда remove работает только после print.
Делайте так:
добавление IP: :foreach i in=[/ip firewall address-list find comment=»UIP/UBITS-allow-ip»] do={/ip firewall address-list remove $i}; ip firewall address-list add address=UIP/UBITS list=allow-ip comment=UIP/UBITS-allow-ip
удаление IP: :foreach i in=[/ip firewall address-list find comment=»UIP/UBITS-allow-ip»] do={/ip firewall address-list remove $i}
-
shoorickello
- Сообщения: 134
- Зарегистрирован: Ср июн 29, 2005 13:08
Сообщение
shoorickello » Вт май 19, 2009 12:00
В той ветке вредный совет использовать UID в качестве идентификатора, ящитаю. Что, если к счёту привязано два тарифных плана с разными IP? Или в сервисной связке два IP?
-
agach
- Сообщения: 40
- Зарегистрирован: Вт янв 22, 2008 19:32
Сообщение
agach » Вт май 19, 2009 12:05
огромное спасибо ответившим!!
действительно тупо иногда смотришь — вроде все правильно, а грабли все равно есть.