Page tree

/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
¯_(ツ)_/¯ (Requires: Option.npk)
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

/metarouter/interface

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
dynamic-bridge
dynamic-mac-address
Type: macAddr
+presence: {'producer': '', 'sub': [{'key': 'id', 'value': 'invert b2'}]}
static-interface
type
enum [dynamic | static]
virtual-machine
vm-mac-address
Type: macAddr

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 [comment | dynamic-bridge | dynamic-mac-address | static-interface | type | virtual-machine | vm-mac-address]
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 [active | comment | disabled | dynamic-bridge | dynamic-mac-address | static-interface | type | virtual-machine | vm-mac-address]
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
¯_(ツ)_/¯ (Requires: Option.npk)
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': 'active', 'value': 14}, {'key': 'comment', 'value': 16}, {'key': 'disabled', 'value': 15}, {'key': 'dynamic-bridge', 'value': 5}, {'key': 'dynamic-mac-address', 'value': 4}, {'key': 'static-interface', 'value': 3}, {'key': 'type', 'value': 1}, {'key': 'virtual-machine', 'value': 0}, {'key': 'vm-mac-address', 'value': 2}]}}, {'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

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
dynamic-bridge
dynamic-mac-address
Type: macAddr
+presence: {'producer': '', 'sub': [{'key': 'id', 'value': 'invert b2'}]}
numbersarg_node
List of item numbers
static-interface
type
enum [dynamic | static]
virtual-machine
vm-mac-address
Type: macAddr
  • No labels