Page tree

/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

  • No labels