RouterBOARD 2011U and CCR series devices are equipped with a resistive LCD touchscreen, for quick access to device stats and simple configuration options. Touchscreen requires pressure against the surface to register a touch, therefore light swipes and quick/short taps might not get registered (as opposed to a capacitive touchscreen commonly found on phones). If you find trouble operating the screen with your finger, you can also try a stylus or opposite end of a pen.
/lcd
backlight
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| state | bool |
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| value-name | enum [backlight-timeout | color-scheme | default-screen | enabled | flip-screen | read-only-mode | time-interval | touch-screen] | Name of editable property |
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 | |
| 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) |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| value-name | enum [backlight-timeout | color-scheme | default-screen | enabled | flip-screen | read-only-mode | time-interval | touch-screen] | Name of the value you want to get |
Print values of item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| as-value | Type: switch value: True | Prints out output as value (used in scripting) | |
| default-config | Type: switch sysc: 3 value: True | ||
| file | Type: string | Print the content of the submenu into specific file | |
| interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval | |
| without-paging | Type: switch value: True | Displays information in one piece |
recalibrate
Before the LCD touchscreen can be used, it needs to be calibrated at least once. After the first successful calibration, data is stored on the router. If no calibration values are present, the calibration process will start automatically.
During the calibration/recalibration you must touch 4 points drawn on the screen. Three of the points are used to calculate calibration variables and the 4th point is used to test whether the calibration was successful. If calibration is unsuccessful, calibration variables are not saved. At the end (after touching 4th point) a message is displayed with the calibration result.
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| backlight-timeout | Type: alt backlight-timeout: time_arg never: enum_arg | ||
| color-scheme | enum [dark | light] | ||
| default-screen | enum [informative-slideshow | interfaces | log | main-menu | stat-slideshow | stats | stats-all | wireless-info] | ||
| enabled | bool | ||
| flip-screen | bool | ||
| read-only-mode | bool | ||
| time-interval | enum [daily | hour | min | weekly] | ||
| touch-screen | bool |
show
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| screen | enum [informative-slideshow | interfaces | log | main-menu | stat-slideshow | stats | stats-all | wireless-info] |
take-screenshot
Take-screenshot function allows to create BMP image of currently displayed LCD screen and saves it in File List with the specified name. Screenshots without file names are not saved, screenshots with an existing file name are overwritten.
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| file-name | Type: string |
/lcd/interface
add
Create a new item
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| copy-from | arg_node | ID of item to make a copy from | |
| disabled | bool | Defines whether item is ignored or used | |
| interface | |||
| max-speed | num [0 .. 9223372036854775807] | ||
| timeout | time [1000000000 .. 60000000000] unit: 1000000000 |
default-wireless
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
disable
Disable items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
display
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | arg_node | Item number | |
| value-name | enum [interface | max-speed | timeout] | Name of editable property |
enable
Enable items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
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 | |
| 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
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | arg_node | Item number | |
| value-name | enum [default | default-wireless | disabled | displayed | inactive | interface | max-speed | timeout] | Name of the value you want to get |
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 | |
| 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 | arg_node | Print parameters only from specified item | |
| interval | time [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': 'default', 'value': 11}, {'key': 'default-wireless', 'value': 14}, {'key': 'disabled', 'value': 15}, {'key': 'displayed', 'value': 13}, {'key': 'inactive', 'value': 12}, {'key': 'interface', 'value': 0}, {'key': 'max-speed', 'value': 2}, {'key': 'timeout', 'value': 1}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'key': 15, '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
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| disabled | bool | Defines whether item is ignored or used | |
| max-speed | num [0 .. 9223372036854775807] | ||
| numbers | arg_node | List of item numbers | |
| timeout | time [1000000000 .. 60000000000] unit: 1000000000 |
/lcd/pin
PIN code number allows protecting of sensitive menus on the LCD screen. The PIN number will be asked if Read-Only mode is disabled and you add an IP address, reset or reboot the router. The default PIN is 1234
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| value-name | enum [hide-pin-number | pin-number] | Name of editable property |
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 | |
| 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) |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| value-name | enum [hide-pin-number | pin-number] | Name of the value you want to get |
Print values of item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| as-value | Type: switch value: True | Prints out output as value (used in scripting) | |
| default-config | Type: switch sysc: 3 value: True | ||
| file | Type: string | Print the content of the submenu into specific file | |
| interval | time [200000000 .. 9223372036854775807] unit: 1000000 | Displays information and refreshes it in selected time interval | |
| without-paging | Type: switch value: True | Displays information in one piece |
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| hide-pin-number | bool | ||
| pin-number | Type: string |
/lcd/screen
disable
Disable items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
edit
Edit items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | arg_node | Item number | |
| value-name | enum [timeout] | Name of editable property |
enable
Enable items
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| numbers | arg_node | List of item numbers |
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 | |
| 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
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| where | Type: query_arg query: True | Generates output depending on values supplied (used mainly for scripting) |
get
Gets value of item's property
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| number | arg_node | Item number | |
| value-name | enum [default | disabled | name | timeout] | Name of the value you want to get |
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 | |
| 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 | arg_node | Print parameters only from specified item | |
| interval | time [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': 'default', 'value': 10}, {'key': 'disabled', 'value': 11}, {'key': 'name', 'value': 0}, {'key': 'timeout', 'value': 1}]}}, {'key': 'help', 'value': {'producer': '', 'sub': [{'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 (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 |
set
Change item properties
| Parameter | Type | Description | Additional Notes |
|---|---|---|---|
| disabled | bool | Defines whether item is ignored or used | |
| numbers | arg_node | List of item numbers | |
| timeout | time [1000000000 .. 60000000000] unit: 1000000000 |
Overview
Content Tools