Page History

...

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 timeput:put <expression>put the supplied argument into the consolelen: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.

var - value to pick elements from
start - element to start picking from (the first element index is 0)
count - number of elements to pick starting from the first element with index=0

Code Block

language	ros

[admin@MikroTik] > :put [:pick "abcde" 1 3]
bc

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 }}];timestampreturns the time since epoch, where epoch is January 1, 1970, not counting leap seconds

Code Block

language	text

[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;terminalterminal related commandserror:error <output>Generate console error and stop executing the scriptexecute: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 the "as-string" parameter executed script is blocked (not executed in the background).

convert

:convert from=[arg] to=[arg]

Converts specified value from one format to another. By default uses an automatically parsed value, if the "from" format is not specified (for example, "001" becomes "1", "10.1" becomes "10.0.0.1", etc.).

from specifies the format of the value - base32, base64, hex, raw, rot13, url.

to specifies the format of the output value - base32, base64, hex, raw, rot13, url.

:put [:convert 001 to=hex ]

31

:put [:convert [/ip dhcp-client/option/get hostname raw-value] from=hex to=raw ]

MikroTik

delay :delay <time> do nothing for a given period of time

environment :environment print <start> print initialized variable information :global myVar true; :environment print;

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 the "as-string" parameter executed script is blocked (not executed in the background).

Executed script can not be larger than 64kB

Code Block

language	ros

{
:local j [:execute {/interface print follow where [:log info ~Sname~]}];
:delay 10s;
:do { /system script job remove $j } on-error={}
}

find :find <arg> <arg> <start> return position of a substring or array element :put [:find "abc" "a" -1];

jobname

:jobname

return current script name

Code Block

language	ros
title	Limit script execution to single instance

:if ([/system script job print count-only as-value where script=[:jobname] ] > 1) do={
  :error "script instance already running"
  }

len :len <expression> return string length or array element count :put [:len "length=8"];

log :log <topic> <message> write a message to the system log. Available topics are "debug, error, info and warning" :log info "Hello from script";

parse :parse <expression> parse the string and return parsed console commands

Code Block

language	ros

{
: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!"]; $myFunc;

resolve

pick :

resolve <arg>

pick <var> <start>[<count>]

return

the IP address of the given DNS name:put [:resolve "www.mikrotik.com"];retry:retry command=<expr>

range of elements or substring. If the count is not specified, will return only one element from an array.

var - value to pick elements from
start - element to start picking from (the first element index is 0)
count - number of elements to pick starting from the first element with index=0

Code Block

language	ros

[admin@MikroTik] > :put [:pick "abcde" 1 3]
bc

put :put <expression> put the supplied argument into the console :put "Hello world"

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

:retry command={abc} delay=1 max=2 on-error={:put "got error"}
got error

Code Block

language	text

:retry command={abc} delay=1 max=2 on-error={:put "got error"}
got error

typeof :typeof <var> the return data type of variable :put [:typeof 4];

rndnum :rndnum from=[num] to=[num] random number generator :put [:rndnum from=1 to=99];

rndstr

:rndstr from=[str] length=[num]

Random string generator.

from specifies characters to construct the string from and defaults to all ASCII letters and numerals.
length specifies the length of the string to create and defaults to 16.

:put [:rndnum from="abcdef%^&" length=33];

convert

set :

convert from=[arg] to=[arg]

Converts specified value from one format to another. By default uses an automatically parsed value, if the "from" format is not specified (for example, "001" becomes "1", "10.1" becomes "10.0.0.1", etc.).

from specifies the format of the value - base32, base64, hex, raw, rot13, uri.

to specifies the format of the output value - base32, base64, hex, raw, rot13, URI.

set <var> [<value>] assign value to a declared variable. :global a; :set a true;

terminal :terminal terminal related commands

time :time <expression> return interval of time needed to execute the command :put [:time {:for i from=1 to=10 do={ :delay 100ms }}];

timestamp

:timestamp

returns the time since epoch, where epoch is January 1, 1970 (Thursday), not counting leap seconds

Code Block

language	text

[admin@MikroTik] > :put [:timestamp]
2735w21:41:43.481891543
or
[admin@MikroTik] > :put [:timestamp]
2735w1d21:41:43.481891543
with the day offset

:put [:convert 001 to=hex ]

31

:put [:convert [/ip dhcp-client/option/get hostname raw-value] from=hex to=raw ]

MikroTik

toarray :toarray <var> convert a variable to the array

tobool :tobool <var> convert a variable to boolean

toid :toid <var> convert a variable to internal ID

toip :toip <var> convert a variable to IP address

toip6 :toip6 <var> convert a variable to IPv6 address

tonum :tonum <var> convert a variable to an integer

tostr :tostr <var> convert a variable to a string

totime :totime <var> convert a variable to time

Menu specific commands

Common commands

...

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: ftp,reboot,read,write,policy,test,password,sniff,sensitive,romon)	list of applicable policies: ftp - can log on remotely via FTP and send and retrieve files from the router password - change passwords policy - manage user policies, add and remove user read - can retrieve the configuration reboot - can reboot the router sensitive - allows changing "hide sensitive" parameter sniff - can run sniffer, torch, etc test - can run ping, traceroute, bandwidth test write - can change the configuration Read more detailed policy descriptions here
source (string;)	Script source code

Read-only status properties:

...

Page tree

Versions Compared

Old Version 40

New Version 57

Key

Menu specific commands

Common commands