Page tree

/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

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

/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-fromarg_node
ID of item to make a copy from

disabledbool
Defines whether item is ignored or used

local-address
Type: ipAddr


log-file
Type: string


port


protocol
enum [raw | rfc2217]


tcp-portnum [1 .. 65535]

disable

Disable items
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

edit

Edit items
ParameterTypeDescriptionAdditional Notes
numberarg_node
Item number

value-name
enum [allowed-addresses | channel | local-address | log-file | port | protocol | tcp-port]
Name of editable property

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 | allowed-addresses | busy | channel | disabled | inactive | local-address | log-file | logging-active | port | protocol | remote-address | tcp-port]
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

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

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
allowed-addresses
Type: ip_range_arg
acc1: {'producer': '"be u3"', 'sub': []}
acc2: {'producer': '"be u4"', 'sub': []}


channelnum [0 .. 4294967295]

disabledbool
Defines whether item is ignored or used

local-address
Type: ipAddr


log-file
Type: string


numbersarg_node
List of item numbers

port


protocol
enum [raw | rfc2217]


tcp-portnum [1 .. 65535]

unset

Unsets and removes user-set value to specified submenu object
ParameterTypeDescriptionAdditional Notes
numbersarg_node
List of item numbers

value-name
enum [local-address]
Name of property that can be unset

  • No labels