Page tree

/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

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

  • No labels