You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

/port

Serial ports

edit

Edit items
ParameterTypeDescriptionAdditional Notes
number
Type: arg_node
Item number
value-name
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'baud-rate', 'value': 4}, {'key': 'data-bits', 'value': 5}, {'key': 'flow-control', 'value': 8}, {'key': 'name', 'value': 0}, {'key': 'parity', 'value': 6}, {'key': 'stop-bits', 'value': 7}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'New port name'}, {'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'}]}}]}}]}
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)

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
number
Type: arg_node
Item number
value-name
Type: enum
#mapping: {'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'}]}}]}}]}
Name of the value you want to get

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
¯_(ツ)_/¯ (Requires: Option.npk)
from
Type: arg_node
noexport: True
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
numbers
Type: arg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
baud-rate
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': '1000000', 'value': 1000000}, {'key': '110', 'value': 110}, {'key': '115200', 'value': 115200}, {'key': '1152000', 'value': 1152000}, {'key': '1200', 'value': 1200}, {'key': '134', 'value': 134}, {'key': '150', 'value': 150}, {'key': '1500000', 'value': 1500000}, {'key': '1800', 'value': 1800}, {'key': '19200', 'value': 19200}, {'key': '200', 'value': 200}, {'key': '2000000', 'value': 2000000}, {'key': '230400', 'value': 230400}, {'key': '2400', 'value': 2400}, {'key': '2500000', 'value': 2500000}, {'key': '300', 'value': 300}, {'key': '3000000', 'value': 3000000}, {'key': '3500000', 'value': 3500000}, {'key': '38400', 'value': 38400}, {'key': '4000000', 'value': 4000000}, {'key': '460800', 'value': 460800}, {'key': '4800', 'value': 4800}, {'key': '50', 'value': 50}, {'key': '500000', 'value': 500000}, {'key': '57600', 'value': 57600}, {'key': '576000', 'value': 576000}, {'key': '600', 'value': 600}, {'key': '75', 'value': 75}, {'key': '921600', 'value': 921600}, {'key': '9600', 'value': 9600}]}}]}}]}
constant: True
Baud rate (bits/s)
data-bits
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': '7', 'value': 0}, {'key': '8', 'value': 1}]}}]}}]}
constant: True
Number of bits for data
dtr
Type: bool
falseStr: off
trueStr: on
flow-control
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'hardware', 'value': 1}, {'key': 'none', 'value': 2}, {'key': 'xon-xoff', 'value': 0}]}}]}}]}
constant: True
Type of flow control
name
Type: string
New port name
numbers
Type: arg_node
List of item numbers
parity
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'even', 'value': 2}, {'key': 'none', 'value': 0}, {'key': 'odd', 'value': 1}]}}]}}]}
constant: True
Parity
rts
Type: bool
falseStr: off
trueStr: on
stop-bits
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': '1', 'value': 1}, {'key': '2', 'value': 2}]}}]}}]}
constant: True
Number of bits for control

/port/remote-access

add

Create a new item
ParameterTypeDescriptionAdditional Notes
allowed-addresses
Type: ip_range_arg
acc1: {'producer': '"be u3"', 'sub': []}
acc2: {'producer': '"be u4"', 'sub': []}
channelnum [0 .. 4294967295]
copy-from
Type: arg_node
noexport: True
ID of item to make a copy from
disabled
Type: bool
Defines whether item is ignored or used
local-address
Type: ipAddr
log-file
Type: string
port
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{52,1}'}]}}]}
protocol
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'raw', 'value': 0}, {'key': 'rfc2217', 'value': 1}]}}]}}]}
constant: True
tcp-portnum [1 .. 65535]

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbers
Type: arg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
number
Type: arg_node
Item number
value-name
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'allowed-addresses', 'value': 2}, {'key': 'channel', 'value': 1}, {'key': 'local-address', 'value': 3}, {'key': 'log-file', 'value': 6}, {'key': 'port', 'value': 0}, {'key': 'protocol', 'value': 5}, {'key': 'tcp-port', 'value': 4}]}}]}}]}
Name of editable property

enable

Enable items
ParameterTypeDescriptionAdditional Notes
numbers
Type: arg_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
number
Type: arg_node
Item number
value-name
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'active', 'value': 17}, {'key': 'allowed-addresses', 'value': 2}, {'key': 'busy', 'value': 18}, {'key': 'channel', 'value': 1}, {'key': 'disabled', 'value': 20}, {'key': 'inactive', 'value': 16}, {'key': 'local-address', 'value': 3}, {'key': 'log-file', 'value': 6}, {'key': 'logging-active', 'value': 19}, {'key': 'port', 'value': 0}, {'key': 'protocol', 'value': 5}, {'key': 'remote-address', 'value': 7}, {'key': 'tcp-port', 'value': 4}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 20, 'value': 'Defines whether item is ignored or used'}]}}]}}]}
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)
from
Type: arg_node
noexport: True
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': 17}, {'key': 'allowed-addresses', 'value': 2}, {'key': 'busy', 'value': 18}, {'key': 'channel', 'value': 1}, {'key': 'disabled', 'value': 20}, {'key': 'inactive', 'value': 16}, {'key': 'local-address', 'value': 3}, {'key': 'log-file', 'value': 6}, {'key': 'logging-active', 'value': 19}, {'key': 'port', 'value': 0}, {'key': 'protocol', 'value': 5}, {'key': 'remote-address', 'value': 7}, {'key': 'tcp-port', 'value': 4}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 20, '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
numbers
Type: arg_node
List of item numbers

set

Change item properties
ParameterTypeDescriptionAdditional Notes
allowed-addresses
Type: ip_range_arg
acc1: {'producer': '"be u3"', 'sub': []}
acc2: {'producer': '"be u4"', 'sub': []}
channelnum [0 .. 4294967295]
disabled
Type: bool
Defines whether item is ignored or used
local-address
Type: ipAddr
log-file
Type: string
numbers
Type: arg_node
List of item numbers
port
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{52,1}'}]}}]}
protocol
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'raw', 'value': 0}, {'key': 'rfc2217', 'value': 1}]}}]}}]}
constant: True
tcp-portnum [1 .. 65535]

unset

Unsets and removes user-set value to specified submenu object
ParameterTypeDescriptionAdditional Notes
numbers
Type: arg_node
List of item numbers
value-name
Type: enum
#mapping: {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'const_mapping', 'sub': [{'key': 'data', 'value': {'producer': '', 'sub': [{'key': 'local-address', 'value': 3}]}}]}}]}
Name of property that can be unset
  • No labels