Page tree

beep

Creates a beep using built-in speaker (works only for devices with built-in speakers)
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

frequency num [20000 .. 20000000]
Frequency (Hz) in which sound is produced

length time [-9223372036854775808 .. 9223372036854775807] unit: 1000000
Duration of time for how long the beep command is executed

delay

does nothing for a while
ParameterTypeDescriptionAdditional Notes
delay-timetime [-9223372036854775808 .. 9223372036854775807] unit: 10000000
time interval (default 1 second)

do

executes command
ParameterTypeDescriptionAdditional Notes
commandarg_node
command that should be executed repeatedly

ifarg_node
condition that must be true to execute script

on-errorarg_node
command that should be executed if there is error during the execution

whilearg_node
condition for repeated execution

error

make error value
ParameterTypeDescriptionAdditional Notes
message
Type: value
error message

execute

run script as separate console job
ParameterTypeDescriptionAdditional Notes
file
Type: string
write script output to file

script
Type: string
mode: SOURCE
source of script to execute in background

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
from
Type: value
List of item numbers

in
Type: value
array or string value to search

key
Type: value
value of key to find

for

executes command for a range of integer values
ParameterTypeDescriptionAdditional Notes
counter
Type: varName
name of counter variable

doarg_node
command to execute for each counter value

from
Type: value
starting value of counter

step
Type: value
increment of counter value. default is 1 or -1

to
Type: value
final value of counter

foreach

executes command for every element in a list
ParameterTypeDescriptionAdditional Notes
counter
Type: varName
name of variable that will hold list element

doarg_node
command to execute for each list element

in
Type: value
list of elements

global

set value global variable
ParameterTypeDescriptionAdditional Notes
doarg_node
command that should be assigned to variable

name
Type: varName
name of the new global variable

value
Type: value
new value of variable

if

executes command if condition is true
ParameterTypeDescriptionAdditional Notes
conditionarg_node
expression that returns truth value

doarg_node
command to execute if contidion is true

elsearg_node
command to execute if condition is false

import

Import fuctiong for RouterOS configurations
ParameterTypeDescriptionAdditional Notes
file-name
The name of the file you want to import

from-linenum [0 .. 4294967295]
Marks from which line to start the import

verbosebool
Executes one line at a time while providing full output in terminal

len

return number of elements in value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

local

set value of local variable
ParameterTypeDescriptionAdditional Notes
doarg_node
command that should be assigned to variable

name
Type: varName
name of the new local variable

value
Type: value
new value of variable

nothing

do nothing and return nothing

parse

build command from text
ParameterTypeDescriptionAdditional Notes
value
Type: value
command source

password

Change password
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

confirm-new-password
Type: string
sensitive: True
Confirmation of the new password

new-password
Type: string
sensitive: True
The new password for currently logged in user account

old-password
Type: string
sensitive: True
The old password for currently logged in user account (can be blank if no password is set)

pick

return range of string characters or array values
ParameterTypeDescriptionAdditional Notes
begin
Type: value
index of the first returned element

counter
Type: value
array or string value

end
Type: value
index of the first element that should not be returned

ping

Send ICMP Echo packets
ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip-address: ip_arg
ipv6: super_arg
mac-address: mac_arg
IP address

arp-pingbool
Tool that checks Layer2 reachability

countnum [0 .. 4294967295]
Number of packets
Total number of packets to send (defult is to send forever until interrupted)

do-not-fragment
Type: switch
value: True
Do not fragment ping packets

dscpnum [0 .. 63]
Sets DSCP header value for ping packets

interface
Which interface to use (required when pinging IPv6 address)

intervaltime [10000000 .. 5000000000] unit: 1000000
Delay between messages
Delay between messages in seconds (default value is 1).

routing-table
Which routing table to use to resolve destination. Used in VRF setups.

sizenum [28 .. 65535]
Packet size
Packet size in bytes (10..1500, default 64).

src-address
Type: alt
ip-src-address: ip_arg
ip6-src-address: ip6_arg
Source IP address to use when pinging

ttlnum [1 .. 255]
Time to live

put

prints argument on the screen
ParameterTypeDescriptionAdditional Notes
message
Type: value
string or any expression

quit

Quit console

redo

Redo previously undone action

resolve

perform a dns lookup of domain name
ParameterTypeDescriptionAdditional Notes
domain-name
Type: alt
domain-name: string_arg
ip-address: ip_arg
ipv6-address: ip6_arg
Target domain name

server
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
DNS Server address

server-portnum [1 .. 65535]
DNS Server port

return

return value from function
ParameterTypeDescriptionAdditional Notes
value
Type: value
return value

set

Change item properties
ParameterTypeDescriptionAdditional Notes
doarg_node
command that should be assigned to variable

name
Type: varName
name of variable

value
Type: value
new value of variable

time

returns time taken by command to execute
ParameterTypeDescriptionAdditional Notes
commandarg_node
commad to time and execute

toarray

convert argument to array value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

tobool

convert argument to truth value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

toid

convert argument to internal number value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

toip

convert argument to IP address value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

toip6

convert argument to IPv6 address value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

tonum

convert argument to integer number value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

tostr

convert argument to string value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

totime

convert argument to time interval value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

typeof

return type of value
ParameterTypeDescriptionAdditional Notes
value
Type: value
any value

undo

Undo previous action

while

executes command while condition is true
ParameterTypeDescriptionAdditional Notes
conditionarg_node
expression that returns truth value

doarg_node
command that should be executed repeatedly

/root/certificate

Certificate management

add

Create a new item
ParameterTypeDescriptionAdditional Notes
common-name
Type: string
Certificates common name

copy-fromarg_node
ID of item to make a copy from

country
Type: string
Certificates country of origin

days-validnum [0 .. 4294967295]
Number of days certificate is valid

key-size
enum [1024 | 1536 | 2048 | 4096 | 8192 | prime256v1 | secp384r1 | secp521r1]
Size of the certificates key

key-usage
Type: ubit_arg
bitspec: {'producer': '', 'sub': [{'key': 'code-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 536870912}, {'key': 'ormask', 'value': 536870912}]}}, {'key': 'content-commitment', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2}, {'key': 'ormask', 'value': 2}]}}, {'key': 'crl-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 64}, {'key': 'ormask', 'value': 64}]}}, {'key': 'data-encipherment', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8}, {'key': 'ormask', 'value': 8}]}}, {'key': 'decipher-only', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 256}, {'key': 'ormask', 'value': 256}]}}, {'key': 'digital-signature', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'dvcs', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2097152}, {'key': 'ormask', 'value': 2097152}]}}, {'key': 'email-protect', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 268435456}, {'key': 'ormask', 'value': 268435456}]}}, {'key': 'encipher-only', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 128}, {'key': 'ormask', 'value': 128}]}}, {'key': 'ipsec-end-system', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 134217728}, {'key': 'ormask', 'value': 134217728}]}}, {'key': 'ipsec-tunnel', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 67108864}, {'key': 'ormask', 'value': 67108864}]}}, {'key': 'ipsec-user', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 33554432}, {'key': 'ormask', 'value': 33554432}]}}, {'key': 'key-agreement', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16}, {'key': 'ormask', 'value': 16}]}}, {'key': 'key-cert-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 32}, {'key': 'ormask', 'value': 32}]}}, {'key': 'key-encipherment', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4}, {'key': 'ormask', 'value': 4}]}}, {'key': 'ocsp-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8388608}, {'key': 'ormask', 'value': 8388608}]}}, {'key': 'server-gated-crypto', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4194304}, {'key': 'ormask', 'value': 4194304}]}}, {'key': 'timestamp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16777216}, {'key': 'ormask', 'value': 16777216}]}}, {'key': 'tls-client', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1073741824}, {'key': 'ormask', 'value': 1073741824}]}}, {'key': 'tls-server', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2147483648}, {'key': 'ormask', 'value': 2147483648}]}}]}
Processes allowed to use key (detailed descriptions can be found in RFC 5280)

locality
Type: string


name
Type: string
Reference name

organization
Type: string
Organization certificate is generated for

state
Type: string


subject-alt-name
Type: obj_arg
+arg: {'producer': 'super_arg', 'sub': [{'key': '#sub', 'value': {'producer': '', 'sub': [{'key': 1, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'DNS', 'value': 2}, {'key': 'IP', 'value': 1}, {'key': 'email', 'value': 3}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"u7f"', 'sub': []}}, {'key': 'constant', 'value': True}]}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'name', 'value': 'type'}]}}, {'key': 2, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"be u7d"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'ip6_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"a7e"', 'sub': []}}, {'key': 'sysc', 'value': 0}]}}]}}]}}, {'key': 'string', 'value': {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s7c"', 'sub': []}}]}}]}}]}}, {'key': 'name', 'value': 'value'}, {'key': 'prefix', 'value': ':'}]}}]}}]}


trustedbool
Whether or not to include certificate in "trusted certificate chain"

unit
Type: string


add-scep

Add SCEP client
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

ca-identity
Type: string
SCEP CA identity

challenge-password
Type: string
sensitive: True
SCEP servers challange password

name
Type: string
Display name of SCEP client

on-smart-cardbool
stores private key on smart card if hardware supports it

refreshbool
check certificate expiry and refresh it if expired

scep-url
Type: string
URL to the server, must contain both CGI-PATH and CGI-PROG if used on the server

template
Template to use from template list

card-reinstall

ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

pin
Type: string
maxLen: 20
sensitive: True


card-verify

ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

pin
Type: string
maxLen: 20
sensitive: True


create-certificate-request

Create a new certificate request
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

challenge-passphrase
Type: string
sensitive: True


key-passphrase
Type: string
sensitive: True


key-sizenum [1024 .. 8192]

template


unstructured-address
Type: string


edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [common-name | country | days-valid | key-size | key-usage | locality | name | organization | state | subject-alt-name | trusted | unit]
Name of editable property
Enum parameters:
  • common-name - Certificates common name

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

export-certificate

Certificate export tool
ParameterTypeDescriptionAdditional Notes
export-passphrase
Type: string
sensitive: True
Passphrase to be assigned to certificate

numbersarg_node
List of item numbers

typebool
Certificate type

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [authority | ca | ca-crl-host | ca-fingerprint | challenge-password | common-name | country | crl | days-valid | digest-algorithm | expired | expires-after | fingerprint | invalid-after | invalid-before | issued | issuer | key-size | key-type | key-usage | locality | name | organization | private-key | req-fingerprint | revoked | scep-url | serial-number | smart-card-key | state | status | subject-alt-name | trusted | unit]
Name of the value you want to get

import

Import existing certificate
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

file-name
Name of the certificate file

passphrase
Type: string
sensitive: True
Certificates passphrase

issued-revoke

ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'authority', 'value': 39}, {'key': 'ca', 'value': 16}, {'key': 'ca-crl-host', 'value': 15}, {'key': 'ca-fingerprint', 'value': 21}, {'key': 'challenge-password', 'value': 25}, {'key': 'common-name', 'value': 9}, {'key': 'country', 'value': 4}, {'key': 'crl', 'value': 37}, {'key': 'days-valid', 'value': 12}, {'key': 'digest-algorithm', 'value': 2}, {'key': 'expired', 'value': 42}, {'key': 'expires-after', 'value': 24}, {'key': 'fingerprint', 'value': 19}, {'key': 'invalid-after', 'value': 23}, {'key': 'invalid-before', 'value': 22}, {'key': 'issued', 'value': 40}, {'key': 'issuer', 'value': 1}, {'key': 'key-size', 'value': 10}, {'key': 'key-type', 'value': 3}, {'key': 'key-usage', 'value': 14}, {'key': 'locality', 'value': 6}, {'key': 'name', 'value': 0}, {'key': 'organization', 'value': 7}, {'key': 'private-key', 'value': 36}, {'key': 'req-fingerprint', 'value': 20}, {'key': 'revoked', 'value': 26}, {'key': 'scep-url', 'value': 17}, {'key': 'serial-number', 'value': 18}, {'key': 'smart-card-key', 'value': 38}, {'key': 'state', 'value': 5}, {'key': 'status', 'value': 27}, {'key': 'subject-alt-name', 'value': 11}, {'key': 'trusted', 'value': 43}, {'key': 'unit', 'value': 8}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Reference name'}, {'key': 1, 'value': 'Issuer of the certificate'}, {'key': 4, 'value': 'Certificates country of origin'}, {'key': 7, 'value': 'Organization certificate is generated for'}, {'key': 9, 'value': 'Certificates common name'}, {'key': 10, 'value': 'Size of the certificates key'}, {'key': 12, 'value': 'Number of days certificate is valid'}, {'key': 13, 'value': 'Whether or not to include certificate in "trusted certificate chain"'}, {'key': 14, 'value': 'Processes allowed to use key (detailed descriptions can be found in RFC 5280)'}, {'key': 16, 'value': 'Whether the key is used for building or verifying certificate chains'}, {'key': 18, 'value': 'Serial number of the certificate'}, {'key': 22, 'value': 'Date the certificate is valid from'}, {'key': 23, 'value': 'Date the certificate is valid until'}, {'key': 36, 'value': 'The private key of the certificate'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

scep-renew

ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

ParameterTypeDescriptionAdditional Notes
common-name
Type: string
Certificates common name

country
Type: string
Certificates country of origin

days-validnum [0 .. 4294967295]
Number of days certificate is valid

key-size
enum [1024 | 1536 | 2048 | 4096 | 8192 | prime256v1 | secp384r1 | secp521r1]
Size of the certificates key

key-usage
Type: ubit_arg
bitspec: {'producer': '', 'sub': [{'key': 'code-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 536870912}, {'key': 'ormask', 'value': 536870912}]}}, {'key': 'content-commitment', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2}, {'key': 'ormask', 'value': 2}]}}, {'key': 'crl-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 64}, {'key': 'ormask', 'value': 64}]}}, {'key': 'data-encipherment', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8}, {'key': 'ormask', 'value': 8}]}}, {'key': 'decipher-only', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 256}, {'key': 'ormask', 'value': 256}]}}, {'key': 'digital-signature', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'dvcs', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2097152}, {'key': 'ormask', 'value': 2097152}]}}, {'key': 'email-protect', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 268435456}, {'key': 'ormask', 'value': 268435456}]}}, {'key': 'encipher-only', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 128}, {'key': 'ormask', 'value': 128}]}}, {'key': 'ipsec-end-system', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 134217728}, {'key': 'ormask', 'value': 134217728}]}}, {'key': 'ipsec-tunnel', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 67108864}, {'key': 'ormask', 'value': 67108864}]}}, {'key': 'ipsec-user', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 33554432}, {'key': 'ormask', 'value': 33554432}]}}, {'key': 'key-agreement', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16}, {'key': 'ormask', 'value': 16}]}}, {'key': 'key-cert-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 32}, {'key': 'ormask', 'value': 32}]}}, {'key': 'key-encipherment', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4}, {'key': 'ormask', 'value': 4}]}}, {'key': 'ocsp-sign', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8388608}, {'key': 'ormask', 'value': 8388608}]}}, {'key': 'server-gated-crypto', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4194304}, {'key': 'ormask', 'value': 4194304}]}}, {'key': 'timestamp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16777216}, {'key': 'ormask', 'value': 16777216}]}}, {'key': 'tls-client', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1073741824}, {'key': 'ormask', 'value': 1073741824}]}}, {'key': 'tls-server', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 2147483648}, {'key': 'ormask', 'value': 2147483648}]}}]}
Processes allowed to use key (detailed descriptions can be found in RFC 5280)

locality
Type: string


name
Type: string
Reference name

numbersarg_node
List of item numbers

organization
Type: string
Organization certificate is generated for

state
Type: string


subject-alt-name
Type: obj_arg
+arg: {'producer': 'super_arg', 'sub': [{'key': '#sub', 'value': {'producer': '', 'sub': [{'key': 1, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'DNS', 'value': 2}, {'key': 'IP', 'value': 1}, {'key': 'email', 'value': 3}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"u7f"', 'sub': []}}, {'key': 'constant', 'value': True}]}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'name', 'value': 'type'}]}}, {'key': 2, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"be u7d"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'ip6_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"a7e"', 'sub': []}}, {'key': 'sysc', 'value': 0}]}}]}}]}}, {'key': 'string', 'value': {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s7c"', 'sub': []}}]}}]}}]}}, {'key': 'name', 'value': 'value'}, {'key': 'prefix', 'value': ':'}]}}]}}]}


trustedbool
Whether or not to include certificate in "trusted certificate chain"

unit
Type: string


sign

ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

ca
issuer CA

ca-crl-host
Type: multi_arg
+arg: {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s0"', 'sub': []}}]}
switchIds: {4294967295}
adds CRL URL to issued CA

ca-on-smart-cardbool
stores CA's private key on smart card

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

name
Type: string


numberarg_node
Item number

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

sign-certificate-request

ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

ca


days-validnum [0 .. 4294967295]

file-name


/root/console

clear-history

clear command history for all users

/root/disk

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [name]
Name of editable property
Enum parameters:
  • name - Disk identifier

eject-drive

ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

format-drive

ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

file-system
enum [ext3 | fat32]
Converts disk into chosen file system

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

label
Type: string
Sets disk label

numberarg_node
Item number

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [disk | free | label | name | size | type]
Name of the value you want to get

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

oid
Type: switch
value: True
print object IDs for SNMP protocol

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'disk', 'value': 3}, {'key': 'free', 'value': 4}, {'key': 'label', 'value': 1}, {'key': 'name', 'value': 0}, {'key': 'size', 'value': 5}, {'key': 'type', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Disk identifier'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

set

ParameterTypeDescriptionAdditional Notes
name
Type: string
Disk identifier

numbersarg_node
List of item numbers

/root/environment

list of all variables

print

Print values of item properties

/root/file

Local router file storage.

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [contents]
Name of editable property
Enum parameters:
  • contents - Content of the file

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [contents | creation-time | name | package-architecture | package-build-time | package-name | package-version | size | type]
Name of the value you want to get
Enum parameters:
  • contents - Content of the file

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'contents', 'value': 8}, {'key': 'creation-time', 'value': 3}, {'key': 'name', 'value': 0}, {'key': 'package-architecture', 'value': 7}, {'key': 'package-build-time', 'value': 6}, {'key': 'package-name', 'value': 4}, {'key': 'package-version', 'value': 5}, {'key': 'size', 'value': 2}, {'key': 'type', 'value': 1}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'The name of the file'}, {'key': 1, 'value': 'Detected type of file'}, {'key': 2, 'value': 'Size of the file in bytes'}, {'key': 3, 'value': 'Date of creation'}, {'key': 4, 'value': 'Name of the software package'}, {'key': 5, 'value': 'Software package version'}, {'key': 6, 'value': 'Software package build time'}, {'key': 8, 'value': 'Content of the file'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
contents
Type: string
mode: SCRIPT
pfilter: 65536
Content of the file

numbersarg_node
List of item numbers

/root/interface

Interface configuration
Blinks activity LEDs on specified interfaces
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

numbersarg_node
List of item numbers

disable

Disable interface
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [comment | l2mtu | mtu | name | vrf]
Name of editable property
Enum parameters:
  • comment - Short description of the item

enable

Enable interface
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [actual-mtu | bindstr | bindstr2 | caps | comment | default-name | disabled | dynamic | flags | fp-rx-byte | fp-rx-packet | fp-tx-byte | fp-tx-packet | id | ifindex | ifname | l2mtu | last-link-down-time | last-link-up-time | link-downs | mac-address | max-l2mtu | mtu | name | running | rx-byte | rx-drop | rx-error | rx-packet | slave | status | tx-byte | tx-drop | tx-error | tx-packet | tx-queue-drop | type | vrf]
Name of the value you want to get

monitor-traffic

Monitor traffic
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

interface
Type: multi_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,0}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}
maxlen: 100
switchIds: {4294967295}
Interface name

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

print

Print interface summary
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Interface name or number obtained from print command
Interface name or number obtained from print

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

oid
Type: switch
value: True
print object IDs for SNMP protocol

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'actual-mtu', 'value': 4}, {'key': 'bindstr', 'value': 15}, {'key': 'bindstr2', 'value': 16}, {'key': 'caps', 'value': 10}, {'key': 'comment', 'value': 45}, {'key': 'default-name', 'value': 1}, {'key': 'disabled', 'value': 44}, {'key': 'dynamic', 'value': 41}, {'key': 'flags', 'value': 13}, {'key': 'fp-rx-byte', 'value': 29}, {'key': 'fp-rx-packet', 'value': 31}, {'key': 'fp-tx-byte', 'value': 30}, {'key': 'fp-tx-packet', 'value': 32}, {'key': 'id', 'value': 14}, {'key': 'ifindex', 'value': 12}, {'key': 'ifname', 'value': 11}, {'key': 'l2mtu', 'value': 5}, {'key': 'last-link-down-time', 'value': 17}, {'key': 'last-link-up-time', 'value': 18}, {'key': 'link-downs', 'value': 19}, {'key': 'mac-address', 'value': 8}, {'key': 'max-l2mtu', 'value': 6}, {'key': 'mtu', 'value': 3}, {'key': 'name', 'value': 0}, {'key': 'running', 'value': 42}, {'key': 'rx-byte', 'value': 20}, {'key': 'rx-drop', 'value': 24}, {'key': 'rx-error', 'value': 27}, {'key': 'rx-packet', 'value': 22}, {'key': 'slave', 'value': 43}, {'key': 'status', 'value': 9}, {'key': 'tx-byte', 'value': 21}, {'key': 'tx-drop', 'value': 25}, {'key': 'tx-error', 'value': 28}, {'key': 'tx-packet', 'value': 23}, {'key': 'tx-queue-drop', 'value': 26}, {'key': 'type', 'value': 2}, {'key': 'vrf', 'value': 7}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Interface name'}, {'key': 2, 'value': 'Type of the interface'}, {'key': 3, 'value': 'Maximum Transmit Unit'}, {'key': 5, 'value': 'Layer2 Maximum transmission unit'}, {'key': 7, 'value': 'Defines which routing table should be used'}, {'key': 44, 'value': 'Defines whether item is ignored or used'}, {'key': 45, 'value': 'Short description of the item'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

stats
Type: switch
value: True
Show subset of properties as a table

stats-detail
Type: switch
value: True
Show subset of properties in detailed form

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

reset-counters

Resets counters for specified submenu object
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

disabledbool
Defines whether item is ignored or used

l2mtunum [0 .. 65536]
Layer2 Maximum transmission unit

mtunum [0 .. 65536]
Maximum Transmit Unit

name
Type: string
Interface name

numbersarg_node
List of item numbers

vrf
Defines which routing table should be used

/root/ip

IP options

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

/root/lcd

backlight

ParameterTypeDescriptionAdditional Notes
statebool

edit

Edit items
ParameterTypeDescriptionAdditional Notes
value-name
enum [backlight-timeout | color-scheme | default-screen | enabled | flip-screen | read-only-mode | time-interval | touch-screen]
Name of editable property

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
value-name
enum [backlight-timeout | color-scheme | default-screen | enabled | flip-screen | read-only-mode | time-interval | touch-screen]
Name of the value you want to get

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
value: True
Prints out output as value (used in scripting)

default-config
Type: switch
sysc: 3
value: True


file
Type: string
Print the content of the submenu into specific file

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

without-paging
Type: switch
value: True
Displays information in one piece

recalibrate

set

Change item properties
ParameterTypeDescriptionAdditional Notes
backlight-timeout
Type: alt
backlight-timeout: time_arg
never: enum_arg


color-scheme
enum [dark | light]


default-screen
enum [informative-slideshow | interfaces | log | main-menu | stat-slideshow | stats | stats-all | wireless-info]


enabledbool

flip-screenbool

read-only-modebool

time-interval
enum [daily | hour | min | weekly]


touch-screenbool

show

ParameterTypeDescriptionAdditional Notes
screen
enum [informative-slideshow | interfaces | log | main-menu | stat-slideshow | stats | stats-all | wireless-info]


take-screenshot

ParameterTypeDescriptionAdditional Notes
file-name
Type: string


/root/log

System logs

debug

ParameterTypeDescriptionAdditional Notes
message
Type: string
Message that should be printed into log

error

ParameterTypeDescriptionAdditional Notes
message
Type: string
Message that should be printed into log

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [buffer | message | time | topics]
Name of the value you want to get

info

ParameterTypeDescriptionAdditional Notes
message
Type: string
Message that should be printed into log

print

Show local logging information
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'buffer', 'value': 0}, {'key': 'message', 'value': 3}, {'key': 'time', 'value': 1}, {'key': 'topics', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 3, 'value': 'Message that should be printed into log'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

warning

ParameterTypeDescriptionAdditional Notes
message
Type: string
Message that should be printed into log

/root/metarouter

add

Create a new item
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

copy-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

disk-sizenum [0 .. 4294967295]

memory-sizenum [1 .. 4294967295]

name
Type: string


comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

numbersarg_node
List of item numbers

console

ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [comment | disk-size | memory-size | name]
Name of editable property
Enum parameters:
  • comment - Short description of the item

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [comment | disabled | disk-reads | disk-size | disk-writes | memory-size | name | state | used-disk]
Name of the value you want to get
Enum parameters:
  • comment - Short description of the item

import-image

ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

enabledbool

file
Type: string
interesting: False
File name where to print output

file-name


intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

memory-sizenum [4 .. 4294967295]

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

oid
Type: switch
value: True
print object IDs for SNMP protocol

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'comment', 'value': 16}, {'key': 'disabled', 'value': 15}, {'key': 'disk-reads', 'value': 4}, {'key': 'disk-size', 'value': 2}, {'key': 'disk-writes', 'value': 5}, {'key': 'memory-size', 'value': 1}, {'key': 'name', 'value': 0}, {'key': 'state', 'value': 6}, {'key': 'used-disk', 'value': 3}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 15, 'value': 'Defines whether item is ignored or used'}, {'key': 16, 'value': 'Short description of the item'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

reboot

ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

disabledbool
Defines whether item is ignored or used

disk-sizenum [0 .. 4294967295]

memory-sizenum [1 .. 4294967295]

name
Type: string


numbersarg_node
List of item numbers

shut-down

ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

start

ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

/root/port

Serial ports

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [baud-rate | data-bits | flow-control | name | parity | stop-bits]
Name of editable property
Enum parameters:
  • baud-rate - Baud rate (bits/s)

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [baud-rate | channels | data-bits | device | flow-control | inactive | line-state | name | parity | stop-bits | used-by]
Name of the value you want to get
Enum parameters:
  • baud-rate - Baud rate (bits/s)

print

ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'baud-rate', 'value': 4}, {'key': 'channels', 'value': 3}, {'key': 'data-bits', 'value': 5}, {'key': 'device', 'value': 2}, {'key': 'flow-control', 'value': 8}, {'key': 'inactive', 'value': 20}, {'key': 'line-state', 'value': 11}, {'key': 'name', 'value': 0}, {'key': 'parity', 'value': 6}, {'key': 'stop-bits', 'value': 7}, {'key': 'used-by', 'value': 1}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'New port name'}, {'key': 1, 'value': 'Shows the user of the port'}, {'key': 4, 'value': 'Baud rate (bits/s)'}, {'key': 5, 'value': 'Number of bits for data'}, {'key': 6, 'value': 'Parity'}, {'key': 7, 'value': 'Number of bits for control'}, {'key': 8, 'value': 'Type of flow control'}, {'key': 11, 'value': 'The name of signal'}, {'key': 20, 'value': 'Inactive port'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

stats
Type: switch
value: True
Shows statistics on ports

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
baud-rate
enum [1000000 | 110 | 115200 | 1152000 | 1200 | 134 | 150 | 1500000 | 1800 | 19200 | 200 | 2000000 | 230400 | 2400 | 2500000 | 300 | 3000000 | 3500000 | 38400 | 4000000 | 460800 | 4800 | 50 | 500000 | 57600 | 576000 | 600 | 75 | 921600 | 9600]
Baud rate (bits/s)

data-bits
enum [7 | 8]
Number of bits for data

dtrbool

flow-control
enum [hardware | none | xon-xoff]
Type of flow control

name
Type: string
New port name

numbersarg_node
List of item numbers

parity
enum [even | none | odd]
Parity

rtsbool

stop-bits
enum [1 | 2]
Number of bits for control

/root/queue

Bandwidth management

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

monitor

Monitor queue packets and bytes
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

/root/quickset

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

print

ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

/root/radius

Radius client settings

add

Create a new item
ParameterTypeDescriptionAdditional Notes
accounting-backupbool
Radius accounting backup

accounting-portnum [1 .. 65535]
Radius accounting port

address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
The address of radius

authentication-portnum [1 .. 65535]
Default port 1645 to RFC

called-id
Type: string
Called identity

certificate
Certificate file to use for communicating with RADIUS Server with RadSec enabled

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

copy-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

domain
Type: string
The domain of the radius

place-beforearg_node
Item number

protocol
enum [radsec | udp]
Specifies the protocol to use when communicating with RADIUS Server

realm
Type: string
Explicitly stated realm (user domain)
The users do not have to provide proper ISP domain name in user name if this is specified

secret
Type: string
sensitive: True
PPP secret name

service
Type: ubit_arg
bitspec: {'producer': '', 'sub': [{'key': 'dhcp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4096}, {'key': 'ormask', 'value': 4096}]}}, {'key': 'dot1x', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16384}, {'key': 'ormask', 'value': 16384}]}}, {'key': 'hotspot', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 512}, {'key': 'ormask', 'value': 512}]}}, {'key': 'ipsec', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8192}, {'key': 'ormask', 'value': 8192}]}}, {'key': 'login', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 256}, {'key': 'ormask', 'value': 256}]}}, {'key': 'ppp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'wireless', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1024}, {'key': 'ormask', 'value': 1024}]}}]}
Name of the service

src-address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
Source IP/IPv6 address of the packets sent to RADIUS server

timeouttime [10000000 .. 60000000000] unit: 1000000
Time limit how long the radius client will try to connect to the radius server

comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

numbersarg_node
List of item numbers

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [accounting-backup | accounting-port | address | authentication-port | called-id | certificate | comment | domain | protocol | realm | secret | service | src-address | timeout]
Name of editable property
Enum parameters:
  • accounting-backup - Radius accounting backup

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [accounting-backup | accounting-port | address | authentication-port | called-id | certificate | comment | disabled | domain | protocol | realm | secret | service | src-address | timeout]
Name of the value you want to get
Enum parameters:
  • accounting-backup - Radius accounting backup

monitor

Radius monitoring
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

numbersarg_node
List of item numbers

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

move

Change order of items
ParameterTypeDescriptionAdditional Notes
destinationarg_node
Target to where the file should be moved

numbersarg_node
List of item numbers

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'accounting-backup', 'value': 8}, {'key': 'accounting-port', 'value': 6}, {'key': 'address', 'value': 3}, {'key': 'authentication-port', 'value': 5}, {'key': 'called-id', 'value': 1}, {'key': 'certificate', 'value': 12}, {'key': 'comment', 'value': 23}, {'key': 'disabled', 'value': 22}, {'key': 'domain', 'value': 2}, {'key': 'protocol', 'value': 11}, {'key': 'realm', 'value': 9}, {'key': 'secret', 'value': 4}, {'key': 'service', 'value': 0}, {'key': 'src-address', 'value': 10}, {'key': 'timeout', 'value': 7}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Name of the service'}, {'key': 1, 'value': 'Called identity'}, {'key': 2, 'value': 'The domain of the radius'}, {'key': 3, 'value': 'The address of radius'}, {'key': 4, 'value': 'PPP secret name'}, {'key': 5, 'value': 'Default port 1645 to RFC'}, {'key': 6, 'value': 'Radius accounting port'}, {'key': 7, 'value': 'Time limit how long the radius client will try to connect to the radius server'}, {'key': 8, 'value': 'Radius accounting backup'}, {'key': 9, 'value': 'Explicitly stated realm (user domain)'}, {'key': 10, 'value': 'Source IP/IPv6 address of the packets sent to RADIUS server'}, {'key': 11, 'value': 'Specifies the protocol to use when communicating with RADIUS Server'}, {'key': 12, 'value': 'Certificate file to use for communicating with RADIUS Server with RadSec enabled'}, {'key': 22, 'value': 'Defines whether item is ignored or used'}, {'key': 23, 'value': 'Short description of the item'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

reset-counters

Reset all counters

set

Change item properties
ParameterTypeDescriptionAdditional Notes
accounting-backupbool
Radius accounting backup

accounting-portnum [1 .. 65535]
Radius accounting port

address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
The address of radius

authentication-portnum [1 .. 65535]
Default port 1645 to RFC

called-id
Type: string
Called identity

certificate
Certificate file to use for communicating with RADIUS Server with RadSec enabled

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

disabledbool
Defines whether item is ignored or used

domain
Type: string
The domain of the radius

numbersarg_node
List of item numbers

protocol
enum [radsec | udp]
Specifies the protocol to use when communicating with RADIUS Server

realm
Type: string
Explicitly stated realm (user domain)
The users do not have to provide proper ISP domain name in user name if this is specified

secret
Type: string
sensitive: True
PPP secret name

service
Type: ubit_arg
bitspec: {'producer': '', 'sub': [{'key': 'dhcp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 4096}, {'key': 'ormask', 'value': 4096}]}}, {'key': 'dot1x', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 16384}, {'key': 'ormask', 'value': 16384}]}}, {'key': 'hotspot', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 512}, {'key': 'ormask', 'value': 512}]}}, {'key': 'ipsec', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 8192}, {'key': 'ormask', 'value': 8192}]}}, {'key': 'login', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 256}, {'key': 'ormask', 'value': 256}]}}, {'key': 'ppp', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1}, {'key': 'ormask', 'value': 1}]}}, {'key': 'wireless', 'value': {'producer': '', 'sub': [{'key': 'andmask', 'value': 1024}, {'key': 'ormask', 'value': 1024}]}}]}
Name of the service

src-address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
Source IP/IPv6 address of the packets sent to RADIUS server

timeouttime [10000000 .. 60000000000] unit: 1000000
Time limit how long the radius client will try to connect to the radius server

/root/snmp

SNMP settings

edit

Edit items
ParameterTypeDescriptionAdditional Notes
value-name
enum [contact | enabled | engine-id | location | src-address | trap-community | trap-generators | trap-interfaces | trap-target | trap-version]
Name of editable property

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
value-name
enum [contact | enabled | engine-id | location | src-address | trap-community | trap-generators | trap-interfaces | trap-target | trap-version]
Name of the value you want to get

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
as-value
Type: switch
value: True
Prints out output as value (used in scripting)

default-config
Type: switch
sysc: 3
value: True


file
Type: string
Print the content of the submenu into specific file

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

without-paging
Type: switch
value: True
Displays information in one piece

send-trap

ParameterTypeDescriptionAdditional Notes
oid
Type: string


type
enum [counter32 | integer | ip-address | nullobj | obj-id | string | timeticks | unsigned]


value
Type: string


set

Change item properties
ParameterTypeDescriptionAdditional Notes
contact
Type: string
Informative only settings for the NMS

enabledbool
Defines whether SNMP service is enabled or not
SNMP service is disabled by default

engine-id
Type: string


location
Type: string
Informative only settings for the NMS

src-address
Type: alt
ip: ip_arg
ip6: ip6_arg


trap-community


trap-generators
Type: multi_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{34,2}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}
switchIds: {4294967295}


trap-interfaces
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{20,0}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u19"', 'sub': []}}]}


trap-target
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'ip', 'value': {'producer': 'ip_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"be u10"', 'sub': []}}]}}, {'key': 'ipv6', 'value': {'producer': 'ip6_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"ae"', 'sub': []}}, {'key': 'sysc', 'value': 0}]}}]}}]}


trap-version
enum [1 | 2 | 3]


/root/special-login

Special login users

add

Create a new item
ParameterTypeDescriptionAdditional Notes
channelnum [0 .. 4294967295]
Sets what channel is used

copy-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

port
Name of the port the user will be forwarded to

user
Name of the user will be forwarded

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [channel | port | user]
Name of editable property
Enum parameters:
  • channel - Sets what channel is used

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [channel | disabled | port | user]
Name of the value you want to get
Enum parameters:
  • channel - Sets what channel is used

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'channel', 'value': 2}, {'key': 'disabled', 'value': 11}, {'key': 'port', 'value': 1}, {'key': 'user', 'value': 0}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'Name of the user will be forwarded'}, {'key': 1, 'value': 'Name of the port the user will be forwarded to'}, {'key': 2, 'value': 'Sets what channel is used'}, {'key': 11, 'value': 'Defines whether item is ignored or used'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
channelnum [0 .. 4294967295]
Sets what channel is used

disabledbool
Defines whether item is ignored or used

numbersarg_node
List of item numbers

port
Name of the port the user will be forwarded to

user
Name of the user will be forwarded

/root/system

System information and utilities

check-disk

Check disk for errors

check-installation

Check installed packages
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

reboot

Restart the router

reset-configuration

ParameterTypeDescriptionAdditional Notes
caps-modebool

keep-usersbool

no-defaultsbool

run-after-reset


skip-backupbool

wps-sync-modebool

serial-terminal

Serial Terminal
ParameterTypeDescriptionAdditional Notes
channelnum [0 .. 4294967295]

port
Port name

shell

ParameterTypeDescriptionAdditional Notes
cmd
Type: string


shutdown

Shut the router down

sup-output

Create support output file
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

name
Type: string


once
Type: switch
value: True
Execute and print commands output just once

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

telnet

Run Telnet
ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip-address: ip_arg
ipv6-address: super_arg
IP address of host

portnum [1 .. 65535]
Port number

routing-table


/root/terminal

commands related to terminal handling

cuu

move cursor up
ParameterTypeDescriptionAdditional Notes
countnum [0 .. 4294967295]

el

erase line

inkey

read key
ParameterTypeDescriptionAdditional Notes
timeouttime [-9223372036854775808 .. 9223372036854775807] unit: 10000000

style

set output text style
ParameterTypeDescriptionAdditional Notes
style
enum [ambiguous | comment | error | escaped | none | syntax-meta | syntax-noterm | syntax-old | syntax-val | varname | varname-global | varname-local]


/root/tool

Diagnostics tools

bandwidth-test

Run bandwidth test to remote router
ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip: ip_arg
ipv6: super_arg
IP address of host

append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

connection-countnum [1 .. 255]

direction
enum [both | receive | transmit]
Direction of data flow
Enum parameters:
  • both - Monitor both received and transmitted data

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000000
Duration of the test

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

local-tx-speednum [0 .. -1]
Transfer test maximum speed

local-udp-tx-size
Type: range_arg
~TODO: True


once
Type: switch
value: True
Execute and print commands output just once

password
Type: string
maxLen: 32
Password for remote user

protocol
enum [tcp | udp]
Protocol to use for test
Enum parameters:
  • tcp - transmission control protocol

random-databool
Whether to use random data sending method or not
If it's enabled the speeds will be lower)

remote-tx-speednum [0 .. -1]
Receive test maximum speed

remote-udp-tx-size
Type: range_arg
~TODO: True


user
Type: string
maxLen: 32
Remote user

without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

fetch

ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip: ip_arg
ipv6: ip6_arg


as-value
Type: switch
value: True
Prints out output as value (used in scripting)

asciibool
ftp transfer type

check-certificate
enum [no | yes | yes-without-crl]
https certificate validation

dst-path
Type: string


durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

host
Type: string


http-data
Type: string
POST or PUT request body data

http-header-field
Type: multi_arg
+arg: {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s0"', 'sub': []}}]}
switchIds: {4294967295}
add http header fields

http-method
enum [delete | get | post | put]


keep-resultbool
depracated, use 'output' argument

mode
enum [ftp | http | https | tftp]


once
Type: switch
value: True
Execute and print commands output just once

output
enum [file | none | user]
where to output data, works for all protocols
Enum parameters:
  • file - store to file

password
Type: string


portnum [0 .. 65535]

src-address
Type: alt
ip: ip_arg
ip6: ip6_arg
source address for HTTP, HTTPS only

src-path
Type: string


uploadbool
ftp and tftp transfer direction

url
Type: string


user
Type: string


without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

mac-telnet

MAC Telnet Client
ParameterTypeDescriptionAdditional Notes
host
Host MAC address

ping

profile

ParameterTypeDescriptionAdditional Notes
cpu
enum [all | total]


durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file-name
Type: string
sysc: 3


freeze-frame-intervaltime [20000000 .. 30000000000] unit: 1000000

snmp-get

ParameterTypeDescriptionAdditional Notes
address
Type: ipAddr


authentication-password
Type: string


authentication-protocol
enum [MD5 | SHA1]


community
Type: string


encryption-password
Type: string


encryption-protocol
enum [AES | DES]


nextbool

oid
Type: obj_arg
+arg: {'producer': 'string_arg', 'sub': [{'key': 'acc', 'value': {'producer': '"s8"', 'sub': []}}]}


portnum [0 .. 65535]

security
enum [authorized | none | private]


triesnum [1 .. 4294967295]

try-timeouttime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

version
enum [1 | 2c | 3]


snmp-walk

ParameterTypeDescriptionAdditional Notes
address
Type: ipAddr


authentication-password
Type: string


authentication-protocol
enum [MD5 | SHA1]


community
Type: string


encryption-password
Type: string


encryption-protocol
enum [AES | DES]


oid
Type: string


portnum [0 .. 65535]

security
enum [authorized | none | private]


triesnum [1 .. 4294967295]

try-timeouttime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

version
enum [1 | 2c | 3]


speed-test

ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip: ip_arg
ipv6: super_arg


append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
value: True
Prints out output as value (used in scripting)

connection-countnum [1 .. 255]

doarg_node
Execute given script after each time it prints stats on the screen

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

file
Type: string
interesting: False
File name where to print output

intervaltime [20000000 .. 5000000000] unit: 1000000
Delay between messages in seconds

once
Type: switch
value: True
Execute and print commands output just once

password
Type: string
maxLen: 32


test-durationtime [5000000000 .. 9223372036854775807] unit: 1000000000

user
Type: string
maxLen: 32


without-paging
Type: switch
value: True
Prints out each update as new output instead of overwriting previous one on each update

torch

Realtime traffic monitor
ParameterTypeDescriptionAdditional Notes
cpunum [0 .. 999]

dscpnum [0 .. 63]

dst-address
Type: super
Destination address and network mask

dst-address6
Type: super


durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

freeze-frame-intervaltime [20000000 .. 30000000000] unit: 1000000
Time in seconds for which the screen output is paused

interface
The name of the interface to monitor

ip-protocol
enum [any | dccp | ddp | egp | encap | etherip | ggp | gre | hmp | icmp | icmpv6 | idpr-cmtp | igmp | ipencap | ipip | ipsec-ah | ipsec-esp | ipv6-encap | ipv6-frag | ipv6-nonxt | ipv6-opts | ipv6-route | iso-tp4 | l2tp | ospf | pim | pup | rdp | rspf | rsvp | sctp | st | tcp | udp | udp-lite | vmtp | vrrp | xns-idp | xtp]


mac-protocol
enum [any | 802.2 | arp | homeplug-av | ip | ipv6 | ipx | lldp | loop-protect | mpls-multicast | mpls-unicast | packing-compr | packing-simple | pppoe | pppoe-discovery | rarp | service-vlan | vlan]


port
enum [any | acap | activision | afpovertcp | agentx | aol | apple-licman | appleqtc | appleqtcsrvr | appleugcontrol | arcp | asia | asip-webadmin | asipregistry | aurp | auth | avt-profile-1 | avt-profile-2 | bdp | bftp | bgp | biff | bootpc | bootps | btserv | buddyphone | ccmail | cfdptkt | chargen | cops | cpq-wbem | csnet-ns | daytime | dict | discard | discovery | distributed-net | dixie | dlsrap | dlsrpn | dlswpn | dns | dns2go | doom | dsp | dtspcd | echo | epmap | eppc | esro-emsdp | esro-gen | etftp | fcp-addr-srvr1 | fcp-addr-srvr2 | fcp-cics-gw1 | fcp-srvr-inst1 | fcp-srvr-inst2 | finger | ftp | ftp-data | glimpse | gopher | h323gatestat | h323hostcall | half-life | hbci | hostname | hotsync-1 | hotsync-2 | hsrp | htcp | http | http-alt | https | ica | icabrowser | icpv2 | icq | imail-www | imap3 | imaps | ipp | irc | ircu | isakmp | iso-tsap | kerberos | klogin | l2tp | ldap | ldaps | link | linuxconf | liquidaudio | lotusnote | lpr | mac-srvr-admin | madcap | matip-type-a | matip-type-b | mc-ftp | mgcp-callagent | mgcp-gateway | microcom-sbp | mobileip | mountd | mpp | ms-rpc | ms-sql-m | ms-sql-s | ms-streaming | ms-wbt-server | msbd | msg-auth | msg-icp | msql | mtp | mysql | mzap | name | napster | napster-2 | napster-3 | net-assistant | netbios-dgm | netbios-ns | netbios-ssn | netrek | netstat | nextstep | nfile | nfs | nicname | nntp | nntps | ntp | odette-ftp | odmr | oracle-sql | pcanywheredata | pcanywherestat | pdap-np | pgp5-key | photuris | pop2 | pop3 | pop3s | poppassd | pptp | prospero-np | pwdgen | qotd | quake | quake-world | quake3 | radius | radius-acct | rap | re-mail-ck | realsecure | reftek | rip | ripng | rje | rlogin | rlp | rrp | rsvp-tunnel | rtp | rtsp | rwhois | rwp | secureid | sftp | sgmp | sift-uft | sip | slmail | smb | smtp | smux | snmp | snpp | socks | sql*net | sql-net | squid | ssh | statsrv | sunrpc | supdup | swat | syslog | systat | t.120 | tacacs | talk | tcp-id-port | tcpmux | telnet | tftp | tftp-mcast | timbuktu | timbuktu-srv1 | timbuktu-srv2 | timbuktu-srv3 | timbuktu-srv4 | time | tinc | tlisrv | uls | unreal | uucp-path | vemmi | veracity | virtualuser | vmnet | vnc-1 | vnc-2 | webobjects | whois++ | winbox | winbox-old | winbox-old-tls | wingate | wlbs | x11 | xdmcp | yahoo | z39.50]
The name of the port

src-address
Type: super
Source address and network mask
If source address will be 0.0.0.0/0 then automatically only IP protocols will be filtered

src-address6
Type: super


vlan-id
Type: alt
enum: enum_arg
number: num_arg


traceroute

Trace route to host
ParameterTypeDescriptionAdditional Notes
address
Type: alt
ip-address: ip_arg
ipv6: super_arg
IP address of host

countnum [1 .. 4294967295]

dscpnum [0 .. 63]

durationtime [-9223372036854775808 .. 9223372036854775807] unit: 1000000

freeze-frame-intervaltime [20000000 .. 30000000000] unit: 1000000

interface


max-hopsnum [1 .. 4294967295]
Maximum hops

portnum [0 .. 65535]
UDP port number
Set the base UDP port number used in probes (default is 33434). Traceroute hopes that nothing is listening on UDP ports base to base+nhops*nqueries-1 at the destination host (so an ICMP PORT_UNREACHABLE message will be returned to terminate the route tracing). If something is listening on a port in the default range, this option can be used to pick an unused port range.

protocol
enum [icmp | udp]
Protocol of sent packets
Use either UDP or ICMP protocol. If one fails (for example, it is blocked by a firewall) try the other.
Enum parameters:
  • icmp - internet control message protocol

routing-table


sizenum [28 .. 1500]
Packet size in bytes

src-address
Type: alt
ip-address: ip_arg
ipv6-address: ip6_arg
Source IP address to make traceroute with

timeouttime [10000000 .. 3000000000] unit: 1000000
Response wait timeout

use-dnsbool
Specifies whether to use DNS server

/root/user

User management

add

Create a new item
ParameterTypeDescriptionAdditional Notes
address
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}]}}]}
Network address part of addresses user is allowed to use

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

copy-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

group
Group management
Manage user groups. Set up groups for accessing separate services and rebooting router.

name
Type: string
User name

password
Type: string
User password

comment

Set comment for items
ParameterTypeDescriptionAdditional Notes
comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

numbersarg_node
List of item numbers

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [address | comment | group | name | password]
Name of editable property
Enum parameters:
  • address - Network address part of addresses user is allowed to use

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

export

Print or save an export script that can be used to restore configuration
ParameterTypeDescriptionAdditional Notes
compact
Type: switch
value: True
Only exports user-changed settings without defaults

file
Type: string
File name
Name of the file that will be stored in FTP access area.

hide-sensitive
Type: switch
value: True
Hides sensitive information like passwords from beeing printed

terse
Type: switch
value: True
Creates export with output without line wraps

verbose
Type: switch
value: True
Creates output with all RouterOS settings (including the default ones)

find

Find items by value
ParameterTypeDescriptionAdditional Notes
where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

get

Gets value of item's property
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [address | comment | disabled | group | last-logged-in | name | password]
Name of the value you want to get
Enum parameters:
  • address - Network address part of addresses user is allowed to use

print

Print values of item properties
ParameterTypeDescriptionAdditional Notes
append
Type: switch
value: True
Controls if print to file overwrites or appends to content of an existing file

as-value
Type: switch
interesting: False
value: True
Prints out output as value (used in scripting)

brief
Type: switch
value: True
Displays brief description

count-only
Type: switch
value: True
Shows only the count of special login users

default-config
Type: switch
sysc: 3
value: True


detail
Type: switch
value: True
Displays detailed information

file
Type: string
Print the content of the submenu into specific file

follow
Type: switch
value: True
Updates output in real-time

follow-only
Type: switch
value: True
Will output changes that have occured after invoking command

follow-strict
Type: switch
value: True


fromarg_node
Print parameters only from specified item

intervaltime [200000000 .. 9223372036854775807] unit: 1000000
Displays information and refreshes it in selected time interval

proplist
Type: obj_arg
+arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': 3}, {'key': 'comment', 'value': 14}, {'key': 'disabled', 'value': 13}, {'key': 'group', 'value': 1}, {'key': 'last-logged-in', 'value': 4}, {'key': 'name', 'value': 0}, {'key': 'password', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'User name'}, {'key': 1, 'value': 'Group management'}, {'key': 2, 'value': 'User password'}, {'key': 3, 'value': 'Network address part of addresses user is allowed to use'}, {'key': 13, 'value': 'Defines whether item is ignored or used'}, {'key': 14, 'value': 'Short description of the item'}]}}]}}]}}, {'key': 'acc', 'value': {'producer': '"ufd0007"', 'sub': []}}, {'key': 'hint', 'value': 'Name of the value you want to get'}, {'key': 'setUnsetAcc', 'value': {'producer': '"bfd0008"', 'sub': []}}]}
Names of properties

show-ids
Type: switch
value: True
Prints static IDs for selected submenu (Requires: Option.npk)

terse
Type: switch
interesting: False
value: True
Show details in compact and machine friendly format

value-list
Type: switch
interesting: False
value: True
Show properties one per line

where
Type: query_arg
query: True
Generates output depending on values supplied (used mainly for scripting)

without-paging
Type: switch
value: True
Displays information in one piece

remove

Remove item
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
address
Type: obj_arg
+arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}]}}]}
Network address part of addresses user is allowed to use

comment
Type: string
noprint: True
Short description of the item
Adds short description to one or several specified items.

disabledbool
Defines whether item is ignored or used

group
Group management
Manage user groups. Set up groups for accessing separate services and rebooting router.

name
Type: string
User name

numbersarg_node
List of item numbers

password
Type: string
User password

  • No labels