/user
User management
add
Create a new item
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| address | Type: obj_arg +arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}]}}]} | Network address part of addresses user is allowed to use /td | |
| comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
| copy-from | Type: arg_node noexport: True | ID of item to make a copy from /td | |
| disabled | Type: bool | Defines whether item is ignored or used /td | |
| group | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}] | Group management Manage user groups. Set up groups for accessing separate services and rebooting router. /td | |
| name | Type: string | User name /td | |
| password | Type: string | User password /td |
comment
Set comment for items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
| numbers | Type: arg_node | List of item numbers /td |
disable
Disable items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | Type: arg_node | List of item numbers /td |
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | Type: arg_node | Item number /td | |
| value-name | Type: enum const_mapping: address | comment | group | name | password Type: enum mapping: [{'type': 'const', 'name': 'address', 'help': 'Network address part of addresses user is allowed to use'}, {'type': 'const', 'name': 'comment', 'help': 'Short description of the item'}, {'type': 'const', 'name': 'group', 'help': 'Group management'}, {'type': 'const', 'name': 'name', 'help': 'User name'}, {'type': 'const', 'name': 'password', 'help': 'User password'}] | Name of editable property Enum parameters: /td
|
enable
Enable items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | Type: arg_node | List of item numbers /td |
export
Print or save an export script that can be used to restore configuration
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| compact | Type: switch value: True | Only exports user-changed settings without defaults /td | |
| file | Type: string | File name Name of the file that will be stored in FTP access area. /td | |
| hide-sensitive | Type: switch value: True | Hides sensitive information like passwords from beeing printed /td | |
| terse | Type: switch value: True | Creates export with output without line wraps /td | |
| verbose | Type: switch value: True | Creates output with all RouterOS settings (including the default ones) /td |
find
Find items by value
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | Type: arg_node | Item number /td | |
| value-name | Type: enum const_mapping: address | comment | disabled | group | last-logged-in | name | password Type: enum mapping: [{'type': 'const', 'name': 'address', 'help': 'Network address part of addresses user is allowed to use'}, {'type': 'const', 'name': 'comment', 'help': 'Short description of the item'}, {'type': 'const', 'name': 'disabled', 'help': 'Defines whether item is ignored or used'}, {'type': 'const', 'name': 'group', 'help': 'Group management'}, {'type': 'const', 'name': 'last-logged-in'}, {'type': 'const', 'name': 'name', 'help': 'User name'}, {'type': 'const', 'name': 'password', 'help': 'User password'}] | Name of the value you want to get Enum parameters: /td
|
Print values of item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| append | Type: switch value: True | Controls if print to file overwrites or appends to content of an existing file /td | |
| as-value | Type: switch interesting: False value: True | Prints out output as value (used in scripting) /td | |
| brief | Type: switch value: True | Displays brief description /td | |
| count-only | Type: switch value: True | Shows only the count of special login users /td | |
| default-config | Type: switch sysc: 3 value: True | /td | |
| detail | Type: switch value: True | Displays detailed information /td | |
| file | Type: string | Print the content of the submenu into specific file /td | |
| follow | Type: switch value: True | Updates output in real-time /td | |
| follow-only | Type: switch value: True | Will output changes that have occured after invoking command /td | |
| follow-strict | Type: switch value: True | ¯_(ツ)_/¯ (Requires: Option.npk) /td | |
| from | Type: arg_node noexport: True | Print parameters only from specified item /td | |
| interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval /td | |
| 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': 'address', 'value': 3}, {'key': 'comment', 'value': 14}, {'key': 'disabled', 'value': 13}, {'key': 'group', 'value': 1}, {'key': 'last-logged-in', 'value': 4}, {'key': 'name', 'value': 0}, {'key': 'password', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'User name'}, {'key': 1, 'value': 'Group management'}, {'key': 2, 'value': 'User password'}, {'key': 3, 'value': 'Network address part of addresses user is allowed to use'}, {'key': 13, 'value': 'Defines whether item is ignored or used'}, {'key': 14, '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 /td | |
| show-ids | Type: switch value: True | Prints static IDs for selected submenu (Requires: Option.npk) /td | |
| terse | Type: switch interesting: False value: True | Show details in compact and machine friendly format /td | |
| value-list | Type: switch interesting: False value: True | Show properties one per line /td | |
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td | |
| without-paging | Type: switch value: True | Displays information in one piece /td |
remove
Remove item
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | Type: arg_node | List of item numbers /td |
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| address | Type: obj_arg +arg: {'producer': 'alt_arg', 'sub': [{'key': '#arg', 'value': {'producer': '', 'sub': [{'key': 'address', 'value': {'producer': 'ip_prefix_arg', 'sub': [{'key': 'acc1', 'value': {'producer': '"be u1"', 'sub': []}}, {'key': 'acc2', 'value': {'producer': '"be u2"', 'sub': []}}]}}]}}]} | Network address part of addresses user is allowed to use /td | |
| comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
| disabled | Type: bool | Defines whether item is ignored or used /td | |
| group | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}] | Group management Manage user groups. Set up groups for accessing separate services and rebooting router. /td | |
| name | Type: string | User name /td | |
| numbers | Type: arg_node | List of item numbers /td | |
| password | Type: string | User password /td |
/user/aaa
Authentication Authorization and Accounting
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| value-name | Type: enum const_mapping: accounting | default-group | exclude-groups | interim-update | use-radius Type: enum mapping: [{'type': 'const', 'name': 'accounting'}, {'type': 'const', 'name': 'default-group'}, {'type': 'const', 'name': 'exclude-groups'}, {'type': 'const', 'name': 'interim-update'}, {'type': 'const', 'name': 'use-radius'}] | Name of editable property /td |
export
Print or save an export script that can be used to restore configuration
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| compact | Type: switch value: True | Only exports user-changed settings without defaults /td | |
| file | Type: string | File name Name of the file that will be stored in FTP access area. /td | |
| hide-sensitive | Type: switch value: True | Hides sensitive information like passwords from beeing printed /td | |
| terse | Type: switch value: True | Creates export with output without line wraps /td | |
| verbose | Type: switch value: True | Creates output with all RouterOS settings (including the default ones) /td |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| value-name | Type: enum const_mapping: accounting | default-group | exclude-groups | interim-update | use-radius Type: enum mapping: [{'type': 'const', 'name': 'accounting'}, {'type': 'const', 'name': 'default-group'}, {'type': 'const', 'name': 'exclude-groups'}, {'type': 'const', 'name': 'interim-update'}, {'type': 'const', 'name': 'use-radius'}] | Name of the value you want to get /td |
Print values of item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| as-value | Type: switch value: True | Prints out output as value (used in scripting) /td | |
| default-config | Type: switch sysc: 3 value: True | /td | |
| file | Type: string | Print the content of the submenu into specific file /td | |
| interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval /td | |
| without-paging | Type: switch value: True | Displays information in one piece /td |
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| accounting | Type: bool | Status of aaa (yes/no) /td | |
| default-group | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}] | Set type of the default group /td | |
| exclude-groups | Type: multi_arg +arg: {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,2}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]} switchIds: {4294967295} | List of groups to exclude /td | |
| interim-update | time [-9223372036854775808 .. 9223372036854775807] unit: 1000000000 | Defines time interval between communications with the router /td | |
| use-radius | Type: bool | Use or not radius /td |
/user/active
Active users
find
Find items by value
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | Type: arg_node | Item number /td | |
| value-name | Type: enum const_mapping: address | by-romon | group | name | radius | via | when Type: enum mapping: [{'type': 'const', 'name': 'address'}, {'type': 'const', 'name': 'by-romon'}, {'type': 'const', 'name': 'group'}, {'type': 'const', 'name': 'name'}, {'type': 'const', 'name': 'radius'}, {'type': 'const', 'name': 'via'}, {'type': 'const', 'name': 'when'}] | Name of the value you want to get /td |
Print values of item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| append | Type: switch value: True | Controls if print to file overwrites or appends to content of an existing file /td | |
| as-value | Type: switch interesting: False value: True | Prints out output as value (used in scripting) /td | |
| brief | Type: switch value: True | Displays brief description /td | |
| count-only | Type: switch value: True | Shows only the count of special login users /td | |
| default-config | Type: switch sysc: 3 value: True | /td | |
| detail | Type: switch value: True | Displays detailed information /td | |
| file | Type: string | Print the content of the submenu into specific file /td | |
| follow | Type: switch value: True | Updates output in real-time /td | |
| follow-only | Type: switch value: True | Will output changes that have occured after invoking command /td | |
| follow-strict | Type: switch value: True | ¯_(ツ)_/¯ (Requires: Option.npk) /td | |
| from | Type: arg_node noexport: True | Print parameters only from specified item /td | |
| interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval /td | |
| 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': 'address', 'value': 2}, {'key': 'by-romon', 'value': 3}, {'key': 'group', 'value': 5}, {'key': 'name', 'value': 1}, {'key': 'radius', 'value': 14}, {'key': 'via', 'value': 4}, {'key': 'when', 'value': 0}]}}]}}]}}, {'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 /td | |
| show-ids | Type: switch value: True | Prints static IDs for selected submenu (Requires: Option.npk) /td | |
| terse | Type: switch interesting: False value: True | Show details in compact and machine friendly format /td | |
| value-list | Type: switch interesting: False value: True | Show properties one per line /td | |
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td | |
| without-paging | Type: switch value: True | Displays information in one piece /td |
/user/group
Group management
add
Create a new item
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
| copy-from | Type: arg_node noexport: True | ID of item to make a copy from /td | |
| name | Type: string | New group name /td | |
| policy | Type: multi_arg +arg: {'producer': 'super_arg', 'sub': [{'key': '#sub', 'value': {'producer': '', 'sub': [{'key': 1, 'value': {'producer': '', 'sub': [{'key': 'acc_present', 'value': {'producer': '"b2709"', 'sub': []}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'optional', 'value': True}, {'key': 'prefix', 'value': '!'}]}}, {'key': 2, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,3}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'name', 'value': 'policy'}]}}]}}]} switchIds: {4294967295,9993} | Group policy /td | |
| skin | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,8}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,8}'}]}] | Default Webfig skin for group /td |
comment
Set comment for items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
| numbers | Type: arg_node | List of item numbers /td |
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | Type: arg_node | Item number /td | |
| value-name | Type: enum const_mapping: comment | name | policy | skin Type: enum mapping: [{'type': 'const', 'name': 'comment', 'help': 'Short description of the item'}, {'type': 'const', 'name': 'name', 'help': 'New group name'}, {'type': 'const', 'name': 'policy', 'help': 'Group policy'}, {'type': 'const', 'name': 'skin', 'help': 'Default Webfig skin for group'}] | Name of editable property Enum parameters: /td
|
export
Print or save an export script that can be used to restore configuration
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| compact | Type: switch value: True | Only exports user-changed settings without defaults /td | |
| file | Type: string | File name Name of the file that will be stored in FTP access area. /td | |
| hide-sensitive | Type: switch value: True | Hides sensitive information like passwords from beeing printed /td | |
| terse | Type: switch value: True | Creates export with output without line wraps /td | |
| verbose | Type: switch value: True | Creates output with all RouterOS settings (including the default ones) /td |
find
Find items by value
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | Type: arg_node | Item number /td | |
| value-name | Type: enum const_mapping: comment | name | policy | skin Type: enum mapping: [{'type': 'const', 'name': 'comment', 'help': 'Short description of the item'}, {'type': 'const', 'name': 'name', 'help': 'New group name'}, {'type': 'const', 'name': 'policy', 'help': 'Group policy'}, {'type': 'const', 'name': 'skin', 'help': 'Default Webfig skin for group'}] | Name of the value you want to get Enum parameters: /td
|
Print values of item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| append | Type: switch value: True | Controls if print to file overwrites or appends to content of an existing file /td | |
| as-value | Type: switch interesting: False value: True | Prints out output as value (used in scripting) /td | |
| brief | Type: switch value: True | Displays brief description /td | |
| count-only | Type: switch value: True | Shows only the count of special login users /td | |
| default-config | Type: switch sysc: 3 value: True | /td | |
| detail | Type: switch value: True | Displays detailed information /td | |
| file | Type: string | Print the content of the submenu into specific file /td | |
| follow | Type: switch value: True | Updates output in real-time /td | |
| follow-only | Type: switch value: True | Will output changes that have occured after invoking command /td | |
| follow-strict | Type: switch value: True | ¯_(ツ)_/¯ (Requires: Option.npk) /td | |
| from | Type: arg_node noexport: True | Print parameters only from specified item /td | |
| interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval /td | |
| 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': 11}, {'key': 'name', 'value': 0}, {'key': 'policy', 'value': 1}, {'key': 'skin', 'value': 2}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 0, 'value': 'New group name'}, {'key': 1, 'value': 'Group policy'}, {'key': 2, 'value': 'Default Webfig skin for group'}, {'key': 11, '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 /td | |
| show-ids | Type: switch value: True | Prints static IDs for selected submenu (Requires: Option.npk) /td | |
| terse | Type: switch interesting: False value: True | Show details in compact and machine friendly format /td | |
| value-list | Type: switch interesting: False value: True | Show properties one per line /td | |
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) /td | |
| without-paging | Type: switch value: True | Displays information in one piece /td |
remove
Remove item
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | Type: arg_node | List of item numbers /td |
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| comment | Type: string noprint: True | Short description of the item Adds short description to one or several specified items. /td | |
| name | Type: string | New group name /td | |
| numbers | Type: arg_node | List of item numbers /td | |
| policy | Type: multi_arg +arg: {'producer': 'super_arg', 'sub': [{'key': '#sub', 'value': {'producer': '', 'sub': [{'key': 1, 'value': {'producer': '', 'sub': [{'key': 'acc_present', 'value': {'producer': '"b2709"', 'sub': []}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'optional', 'value': True}, {'key': 'prefix', 'value': '!'}]}}, {'key': 2, 'value': {'producer': '', 'sub': [{'key': '+arg', 'value': {'producer': 'enum_arg', 'sub': [{'key': '#mapping', 'value': {'producer': '', 'sub': [{'key': '', 'value': {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,3}'}]}}]}}, {'key': 'acc', 'value': {'producer': '"u0"', 'sub': []}}]}}, {'key': 'chars', 'value': {'producer': '\x06?', 'sub': []}}, {'key': 'name', 'value': 'policy'}]}}]}}]} switchIds: {4294967295,9993} | Group policy /td | |
| skin | Type: enum other_mapping: {'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,8}'}]} Type: enum mapping: [{'producer': 'remote_mapping', 'sub': [{'key': 'path', 'value': '{13,8}'}]}] | Default Webfig skin for group /td |