脚本

脚本语言手册

本手册介绍了RouterOS内置的强大脚本语言。l雷竞技

脚本主机提供了一种自动化一些路由器维护任务的方法，方法是执行用户定义的绑定到某些事件发生的脚本。

脚本可以存储在的脚本库或者可以直接写入的控制台．用于触发脚本执行的事件包括但不限于系统调度程序,流量监控工具，和Netwatch工具生成的事件。

如果你已经熟悉了RouterOS中的脚本，你可能会想看看我们的l雷竞技提示和技巧．

行结构

l雷竞技RouterOS脚本分为多个命令行。命令行一个接一个地执行，直到脚本结束或发生运行时错误。

命令行

l雷竞技RouterOS控制台使用的命令格式如下:

[prefix] [path] command [uparam] [param=[value]] ..[参数=[价值]]

• [prefix] -“:”或“/”字符，表示命令是否为冰或路径。这可能不是必需的。
• [path] -到所需菜单级别的相对路径。这可能不是必需的。
• 命令-其中之一命令在指定的菜单级别上可用。
• [uparam] -未命名参数，命令需要时必须指定。
• [params] -命名参数序列，后面跟着相应的值

命令行的末尾由令牌表示”;“或换行符．有时”;“或换行符命令行结束时不需要。

内部单命令()，[]或{}不需要任何命令结束符。命令的结尾由整个脚本的内容决定

:if (true) do={:put "lala"}

每个命令行在另一个命令行中以方括号"[]"开始和结束(命令连接)．

:put [/ip route get [find gateway=1.1.1.1]];

注意，上面的代码包含三个命令行:

• :把
• /ip route get
• 找到网关= 1.1.1.1

命令行可以通过以下命令从多个物理行构造线路连接规则．

物理行

物理行是由行尾(EOL)序列结束的字符序列。任何标准的平台线终止序列都可以使用:

• Unix- ASCII f;
• 窗户- ASCII cr lf;
• mac- ASCII cr;

可以使用换行符的标准C约定(\n字符)。

评论

以下规则适用于注释:

• 注释以散列字符(#)开始，并在物理行末尾结束。
• l雷竞技RouterOS不支持多行注释。
• 如果(#)字符出现在字符串中，它不被认为是注释。

例子

#这是一个注释#下一行注释:global a;#另一个有效的注释:global myStr "字符串的一部分#不是注释"

线连接

两个或多个物理行可以使用反斜杠字符(\)连接成逻辑行。

以下规则适用于使用反斜杠作为行连接工具:

• 以反斜杠结尾的行不能包含注释。
• 反斜杠不能继续注释。
• 反斜杠不延续符号，除了字符串字面值。
• 在字符串字面值以外的行中使用反斜杠是非法的。

例子

:如果($ = true \ b = false)美元做={:把“一个b美元”;}:if ($a = true \ #不良评论且$b=false) do={:put " $a $b ";} # comment \ continue -无效(语法错误)

记号之间的空白

空格可用于分隔令牌。只有当两个标记的连接可以被解释为不同的标记时，才需要在它们之间使用空白。例子:

{: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路由添加网关=3.3.3.3 #正确/ip路由添加网关=3.3.3.3

作用域

变量只能在脚本中称为作用域的特定区域中使用。这些区域决定变量的可见性。作用域有两种类型全球和当地。在块中声明的变量只能在该块及其所包含的块中访问，并且只能在声明点之后访问。

全局作用域

全局作用域或根作用域是脚本的默认作用域。它是自动创建的，不能关闭。

局部作用域

用户可以定义自己的组来阻止对某些变量的访问，这些作用域称为局部作用域。每个局部作用域都用大括号(“{}”)括起来。

{:本地a 3;{:本地b 4;:把(a + b)美元;由于变量b没有在作用域中定义，下面的#line将显示为浅红色:}

在上述变量的代码中，b具有局部作用域，在右花括号之后将无法访问。

因此，例如，定义的局部变量在下一个命令行中将不可见，并将生成语法错误

[admin@雷竞技网站MikroTik] >:local myVar a;[admin@雷竞技网站MikroTik] >:put $myVar语法错误(第1行第7列)

注意，即使变量可以被定义为全局的，它也只能从它的作用域中使用，除非它在作用域外不被引用可见。

{:本地a 3;{:全局b 4;}:put ($a+$b);}

上面的代码将输出3，因为在作用域之外b是不可见的。

下面的代码将修复这个问题并输出7:

{:本地a 3;{:全局b 4;}:全局b;:把(a + b)美元;}

关键字

以下词语为关键字，不能用作变量名和函数名:

And或in

分隔符

以下标记在语法中用作分隔符:

() [] {}:;美元/

数据类型

l雷竞技RouterOS脚本语言的数据类型如下:

常量转义序列

以下转义序列可用于定义字符串中的某些特殊字符:

例子

:把“4 c \ 48 \ 45 \ \ 4 c \ 4 f \ \服装\ r \ nis \ \ na \ r \ nt”;

哪些将会展出
你好
这
是
一个
测试


运营商

算术运算符

RouterOS脚本语言支持常用的算术运算符l雷竞技

注意:要进行除法，必须在除数周围加上大括号或空格，以免被误认为是IP地址

关系运算符

逻辑运算符

按位运算符

按位运营商正在处理号码、IP和IPv6地址数据类型．

使用“&”运算符从给定IP和CIDR Netmask计算子网地址:

{:本地IP 192.168.88.77;:local CIDRnetmask 255.255.255.0;:把(ip CIDRnetmask美元);}

从给定的IP地址中获取最后8位:

:把(192.168.88.77&0.0.0.255);

使用“|”运算符和反向CIDR掩码计算广播地址:

{:本地IP 192.168.88.77;:本地网络192.168.88.0;:local CIDRnetmask 255.255.255.0;: localinvertedcidr (~$CIDRnetmask);:put ($Network|$InvertedCIDR)}

连接运算符

可以在没有连接操作符的情况下向字符串添加变量值:

:全局myVar "world";:put ("Hello ")。$ myVar);#下一行和上面一样:放"Hello $myVar";

通过在字符串中使用$[]和$()，可以在字符串中添加表达式:

:本地a 5;:本地b 6;:put " 5x6 = $($a * $b)";:put "我们有$[:len [/ip route find]]路由";

其他运营商

< / tr >

[admin@x86] >:全球aaa {a = 1, b = 2} [admin@x86] >:把(aaa - >“a”)1 (admin@x86) >:把(aaa - >“b”)2

变量

脚本语言有两种类型的变量:

• 全球-可从当前用户创建的所有脚本访问，定义为全球关键字;
• 当地的-只能在当前范围内访问范围，定义为当地的关键字。

注意:从v6.2开始，可以有未定义的变量。当变量未定义时，解析器将尝试查找设置的变量，例如由DHCPlease-script或热点在登录

除了内置的RouterOS变量，每个变量都必须在被局部或全局关键字使用之l雷竞技前声明。未定义的变量将被标记为未定义，并将导致编译错误。例子:

下面的代码会导致编译错误，因为没有声明myVar就使用了::把$ myVar

正确的代码:

当地myVar;:设置myVar "my value";:把$ myVar;

例外情况是使用由DHCP设置的变量lease-script

/system script add name=myLeaseScript policy=\ ftp,reboot,read,write,policy,test,winbox,password,sniff,sensitive,api \ source=":log info \$leaseActIP\r\ \n:log info \$leaseActMAC\r\ \n:log info \$leaseServerName\r\ \n:log info \$leaseBound" /ip dhcp-server set myServer lease-script=myLeaseScript

变量名中的有效字符是字母和数字。如果变量名包含任何其他字符，则变量名应放在双引号中。例子:

#有效的变量名:local myVar;#无效变量名:local my-var;#valid因为双引号:global "my-var";

如果变量最初定义时没有值，则的可变数据类型设为零否则，由脚本引擎自动确定数据类型。有时需要从一种数据类型转换为另一种数据类型。可以用数据转换命令．例子:

#将字符串转换为数组:local myStr "1,2,3,4,5";:put [:typeof $myStr];:local myStr [:toarray $myStr];:put [:typeof $myArr]

变量名区分大小写。

下面一行会产生错误，因为变量myVar没有定义:put $myVar #正确的代码:put $myVar

不带值的Set命令将取消对变量的定义(从环境中删除，v6.2新增功能)

#从环境中移除变量:全局myVar "myValue":设置myVar;

当变量名中包含操作符时，在完整的变量名上使用引号。例子:

:本地“my-Var”;:设置“my- var”为“my value”;:把美元“my-Var”;

保留变量名

所有内置的RouterOSl雷竞技属性都是保留变量。与RouterOS内置属性定义相同的变量可能会导致错误。l雷竞技为避免此类错误，请使用自定义名称。

例如，下面的脚本将不起作用:

{:本地类型为“ether1”;/ print where name=$type;}

但是可以使用不同定义的变量:

{:本地用户名"ether1";/ print where name=$customname;}

命令

全球的命令

每个全局命令都应该以的”:“令牌，否则将被视为变量。

[admin@雷竞技网站MikroTik] >:put [:timestamp] 2735w21:41:43.481891543

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

[admin@雷竞技网站MikroTik] >:retry command={abc} delay=1 max=2 on-error={:put "got error"} got error

菜单特定命令

常用命令

以下命令在大多数子菜单中可用:

进口

import命令可从根菜单中获得，用于从创建的文件导入配置一个出口命令或手工书写。

打印参数

print命令有几个参数:

一次可以指定多个参数，例如:/ip route print count-only interval=1 where interface="ether1"

循环和条件语句

循环

条件语句

例子:

{:本地myBool true;:if ($myBool = false) do={:put“值为假”}else={:put“值为真”}}

功能

脚本语言不允许直接创建函数，但是，您可以使用:parse命令作为解决方案。

从v6.2开始，添加了新的语法，以便更容易地定义这类函数，甚至传递参数。返回函数值也是可能的:返回命令。

请看下面的例子:

#定义函数并运行它:global myFunc do={:把“hello from function”}$myFunc输出:hello from function #传递参数给函数:global myFunc do={:把“arg a=$a”;$myFunc a="这是arg a值" "这是arg1值"输出:arg a=这是arg a值arg '1'=这是arg1值

注意，有两种传递参数的方式:

• 传递具有特定名称的参数(在我们的示例中为“a”)
• 传递没有arg名称的值，在这种情况下，arg "1"， "2" ..使用“n”。

返回示例

:global myFunc do={:return ($a + $b)}:put [$myFunc a=6 b=2] output: 8

您甚至可以从脚本环境中克隆一个现有的脚本，并将其作为函数使用。

#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 !

例如:

:全局my2 "123":全局myFunc做={:全局my2;:把my2美元;:设置my2“lala”;$myFunc $my2 =1234:put "全局值$my2"

输出将是:

1234 lala全局值

嵌套函数示例

注意:要调用另一个函数，需要声明其名称(与变量相同)。

:全局funcA ={:返回5};全局funcB ={:全局funcA;:return ([$funcA] + 4)}:put [$funcB] Output: 9

捕获运行时错误

从v6.2开始，脚本具有捕获运行时错误的能力。

例如，[code]: resolve [/code]命令如果失败，将抛出错误并中断脚本。

[admin@雷竞技网站MikroTik] > {:put [:resolve www.example.com];} failure: DNS名称不存在

现在我们想要捕获这个错误并继续我们的脚本:

:do {:put [:resolve www.example.com];} on-error={:put "解析失败"};:put "lala"输出:resolver failed lala

数组操作

警告:数组中的键名包含除小写字符以外的任何字符时，应将其加引号

例如:

[admin@ce0] > {:local a {"aX"=1;唉= 2};:put ($a->"aX")

循环遍历键和值

"foreach"命令可用于遍历键和元素:

[admin@ce0] >:foreach k,v in={2;“斧子”= 1;y = 2;5} do={:put ("$k=$v")} 0=2 1=5 aX=1 y=2

如果"foreach"命令只带一个参数，则返回元素值:

[admin@ce0] >:foreach in={2;“斧子”= 1;y = 2;5} do={:put ("$k")} 2 5 1 2

注意:如果数组元素有键，则这些元素按字母顺序排序，没有键的元素在有键的元素之前移动，并且它们的顺序不改变(参见上面的例子)。

更改单个数组元素的值

[admin@雷竞技网站MikroTik] >:global a {x=1;y=2} [admin@雷竞技网站MikroTik] >:set ($a->"x") 5 [admin@MikroTik] >:environment print a={x=5;y = 2}

脚本库

子菜单水平:/系统脚本

包含所有用户创建的脚本。脚本可以通过几种不同的方式执行:

• 在事件-脚本在一些设施事件中自动执行(调度器，netwatch，VRRP）
• 通过另一个脚本—允许在脚本内运行脚本
• 手动-从控制台执行一个运行命令或在winbox中

注意:只有具有同等或更高权限的脚本(包括调度器、netwatch等)才能执行其他脚本。

只读状态属性:

菜单特定命令

环境

子菜单水平:

• /system脚本环境
• /环境

包含所有用户定义的变量及其分配的值。

[admin@雷竞技网站MikroTik] >:全局示例;[admin@雷竞技网站MikroTik] >:set example 123 [admin@MikroTik] > /environment print "example"=123

只读状态属性:

工作

子菜单水平:/系统脚本作业

包含所有当前正在运行的脚本的列表。
只读状态属性:

另请参阅

• 脚本的例子
• 用户提交的脚本
• 手册:脚本提示和技巧