0
edits
Changes
Template:Networking rutos manual administration (view source)
Revision as of 08:47, 5 May 2020
, 08:47, 5 May 2020add admin page with general tab
==Summary==
This page is an overview of the <b>Administration</b> section of {{{name}}} devices.
{{Template: Networking_rutx_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.01.06
}}
==General==
The <b>General</b> section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below.
[[File:Networking_rutx_manual_administration_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Device name</td>
<td>string; default: <b>{{{name}}}</b></td>
<td>Device model name.</td>
</tr>
<tr>
<td>Hostname</td>
<td>string; default: <b>Teltonika-{{{name}}}.com</b></td>
<td>Device hostname. This can be used for communication with other LAN hosts.</td>
</tr>
<tr>
<td>Min time</td>
<td>integer [0..60]; default: <b>none</b></td>
<td>Minimum time (in seconds) the button needs to be held to perform an action.</td>
</tr>
<tr>
<td>Max time</td>
<td>integer [1..60]; default: <b>none</b></td>
<td>Maximum time (in seconds) the button can be held to perform an action, after which no action will be performed.</td>
</tr>
<tr>
<td>Restore to factory defaults</td>
<td>-(interactive button)</td>
<td>Restores device to manufacturer's default settings.</td>
</tr>
<tr>
<td>Restore to user's defaults</td>
<td>-(interactive button)</td>
<td>Restores device to custom configuration set by the user.</td>
</tr>
</table>
==Logging==
The <b>Logging</b> section is used to configure how and where the router stores system log data. The system log is a file that contains information on various system related events and is useful to engineers for troubleshooting the router.
Refer to the figure and table below for information on the router's Logging page.
[[File:{{{file_logging}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>System log buffer size</td>
<td>integer; default: <b>64</b></td>
<td>System log buffer size in kibibytes (KiB).</td>
</tr>
<tr>
<td>External system log server</td>
<td>ip; default: <b>none</b></td>
<td>IP address of an external server that will be used to store router logs.</td>
</tr>
<tr>
<td>External system log server port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>TCP/UDP port number of the external log server.</td>
</tr>
<tr>
<td>External system log server protocol</td>
<td>UDP | TCP; default: <b>UDP</b></td>
<td>Communication protocol used by the external log server.</td>
</tr>
<tr>
<td>Save log in</td>
<td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
<td>Specifies which type of memory to use for storing system logs.</td>
</tr></table>
==Diagnostics==
The <b>Diagnostics</b> section is used to execute simple network diagnostic tests, including <i>ping</i>, <i>traceroute</i> and <i>nslookup</i>.
[[File:{{{file_diagnostics}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Method</td>
<td>Ping | Traceroute | Nslookup; default: <b>Ping</b></td>
<td>Selects diagnostic method.
<ul>
<li><b>Ping</b> - sends ICMP requests to the specified address.</li>
<li><b>Traceroute</b> - displays the path that packets have to take in order to reach the specified address.</li>
<li><b>Nslookup</b> - obtains domain name address and IP address mapping information.</li>
</ul>
</td>
</tr>
<tr>
<td>Protocol</td>
<td>IPv4 | IPv6; default: <b>IPv4</b></td>
<td>Selects IP address family for diagnostic test.</td>
</tr>
<tr>
<td>Address</td>
<td>ip | host; default: <b>none</b></td>
<td>IP address or hostname on which the diagnostic test will be performed.</td>
</tr>
</table>
==Troubleshoot==
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the router. Refer to the figure and table below for information on the Troubleshoot page.
[[File:{{{file_troubleshoot}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>System log</td>
<td>- (interactive button)</td>
<td>Displays the contents of the router's system log file. The system log contains records of various system related events, such as starts/stops of various services, errors, reboots, etc.</td>
</tr>
<tr>
<td>Kernel log</td>
<td>- (interactive button)</td>
<td>Displays the contents of the router's kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS).</td>
</tr>
<tr>
<td>Troubleshoot file</td>
<td>- (interactive button)</td>
<td>Downloads the router's Troubleshoot file. It contains the router's configuration information, logs and some other files. When requesting support, it is recommended to always provide the router's Troubleshoot file to Teltonika engineers for analysis.</td>
</tr>
<tr>
<td>TCP dump file</td>
<td>- (interactive button)</td>
<td>Downloads the router's TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the router does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.</td>
</tr>
<tr>
<td>Enable TCP dump<span class="asterisk">*</span></td>
<td>off | on; default: <b>off</b></td>
<td>Turns TCP dump packets capture on or off.</td>
</tr>
</table>
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
===TCP dump===
----
<b>TCP dump</b> is a program used to capture packets moving through network interfaces. By default, the router does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
[[File:{{{file_tcpdump}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable TCP dump</td>
<td>off | on; default: <b>off</b></td>
<td>Turns TCP dump packet capture on or off.</td>
</tr>
<tr>
<td>Select interface</td>
<td>network interface; default: '''br-lan'''</td>
<td>Only captures packets that move through the specified network interface.</td>
</tr>
<tr>
<td>Select protocol filter</td>
<td>all | icmp | tcp | udp | arp; default: <b>All</b></td>
<td>Only captures packets that match the specified protocol.</td>
</tr>
<tr>
<td>Select packets direction</td>
<td>IN/OUT | Incoming | Outgoing; default: <b>IN/OUT</b></td>
<td>Only captures packets coming from the specified direction.</td>
</tr>
<tr>
<td>Host</td>
<td>ip | host; default: <b>none</b></td>
<td>Only captures packets related to the specified host.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65335]; default: <b>none</b></td>
<td>Only captures packets related to the specified communication port.</td>
</tr>
<tr>
<td>Select storage</td>
<td>Internal storage | / ; default: <b>Internal storage</b></td>
<td>Specifies where the TCP dump file will be stored.</td>
</tr>
</table>
==Access Control==
The <b>Access Control</b> page is used to manage remote and local access to the router.
<b>Important</b>: turning on remote access leaves the router vulnerable to external attackers. Make sure you use a strong password.
<br><br>
<b>SSH</b>
----
[[File:{{{file_access_ssh}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable SSH access</td>
<td>off | on; default: <b>on</b></td>
<td>Turns SSH access from the local network (LAN) on or off.</td>
</tr>
<tr>
<td>Remote SSH access</td>
<td>off | on; default: <b>off</b></td>
<td>Turns SSH access from remote networks (WAN) on or off.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>22</b></td>
<td>Selects which port to use for SSH access.</td>
</tr>
</table>
<br>
<b>WebUI</b>
----
[[File:{{{file_access_webui}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable HTTP access</td>
<td>off | on; default: <b>on</b></td>
<td>Turns HTTP access from the local network (LAN) to the router's WebUI on or off.</td>
</tr><tr><td>Enable HTTPS access
</td><td>off | on; default: <b>on</b></td><td>Turns HTTPS access from the local network (LAN) to the router's WebUI on or off.</td></tr><tr>
<td>Redirect to HTTPS</td>
<td>off | on; default: <b>off</b></td>
<td>Redirects connection attempts from HTTP to HTTPS.</td>
</tr>
<tr>
<td>Enable remote HTTP access</td>
<td>off | on; default: <b>off</b></td>
<td>Turns HTTP access from remote networks (WAN) to the router's WebUI on or off.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>80</b></td>
<td>Selects which port to use for HTTP access.</td>
</tr>
<tr>
<td>Enable remote HTTPS access</td>
<td>off | on; default: <b>off</b></td>
<td>Turns HTTPS access from remote networks (WAN) to the router's WebUI on or off.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>443</b></td>
<td>Selects which port to use for HTTPS access.</td>
</tr>
</table>
<br>
<b>CLI</b>
----
[[File:{{{file_access_cli}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable CLI</td>
<td>off | on; default: <b>on</b></td>
<td>Turns CLI access from the local network (LAN) on or off.</td>
</tr>
<tr>
<td>Enable remote CLI</td>
<td>off | on; default: <b>off</b></td>
<td>Turns CLI access from remote networks (WAN) on or off.</td>
</tr>
<tr>
<td>Port range</td>
<td>range of integers [0..65534]-[1..65535]; default: <b>4200-4220</b></td>
<td>Selects which ports to use for CLI access.</td>
</tr>
<tr>
<td>Shell limit</td>
<td>integer [1..10]; default: <b>5</b></td>
<td>Maximum number of active CLI connections.</td>
</tr>
</table>
==Root CA==
The <b>Root CA</b> section is used to add a root CA certificate file to the router. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.
[[File:{{{file_root_ca}}}]]
[[Category:{{{name}}} System section]]
This page is an overview of the <b>Administration</b> section of {{{name}}} devices.
{{Template: Networking_rutx_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.01.06
}}
==General==
The <b>General</b> section is used to set up some of device managerial parameters, such as changing device name. For more information on the General section, refer to figure and table below.
[[File:Networking_rutx_manual_administration_general_v1.png|border|class=tlt-border]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Device name</td>
<td>string; default: <b>{{{name}}}</b></td>
<td>Device model name.</td>
</tr>
<tr>
<td>Hostname</td>
<td>string; default: <b>Teltonika-{{{name}}}.com</b></td>
<td>Device hostname. This can be used for communication with other LAN hosts.</td>
</tr>
<tr>
<td>Min time</td>
<td>integer [0..60]; default: <b>none</b></td>
<td>Minimum time (in seconds) the button needs to be held to perform an action.</td>
</tr>
<tr>
<td>Max time</td>
<td>integer [1..60]; default: <b>none</b></td>
<td>Maximum time (in seconds) the button can be held to perform an action, after which no action will be performed.</td>
</tr>
<tr>
<td>Restore to factory defaults</td>
<td>-(interactive button)</td>
<td>Restores device to manufacturer's default settings.</td>
</tr>
<tr>
<td>Restore to user's defaults</td>
<td>-(interactive button)</td>
<td>Restores device to custom configuration set by the user.</td>
</tr>
</table>
==Logging==
The <b>Logging</b> section is used to configure how and where the router stores system log data. The system log is a file that contains information on various system related events and is useful to engineers for troubleshooting the router.
Refer to the figure and table below for information on the router's Logging page.
[[File:{{{file_logging}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>System log buffer size</td>
<td>integer; default: <b>64</b></td>
<td>System log buffer size in kibibytes (KiB).</td>
</tr>
<tr>
<td>External system log server</td>
<td>ip; default: <b>none</b></td>
<td>IP address of an external server that will be used to store router logs.</td>
</tr>
<tr>
<td>External system log server port</td>
<td>integer [0..65535]; default: <b>none</b></td>
<td>TCP/UDP port number of the external log server.</td>
</tr>
<tr>
<td>External system log server protocol</td>
<td>UDP | TCP; default: <b>UDP</b></td>
<td>Communication protocol used by the external log server.</td>
</tr>
<tr>
<td>Save log in</td>
<td>RAM memory | Flash memory; default: <b>RAM memory</b></td>
<td>Specifies which type of memory to use for storing system logs.</td>
</tr></table>
==Diagnostics==
The <b>Diagnostics</b> section is used to execute simple network diagnostic tests, including <i>ping</i>, <i>traceroute</i> and <i>nslookup</i>.
[[File:{{{file_diagnostics}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Method</td>
<td>Ping | Traceroute | Nslookup; default: <b>Ping</b></td>
<td>Selects diagnostic method.
<ul>
<li><b>Ping</b> - sends ICMP requests to the specified address.</li>
<li><b>Traceroute</b> - displays the path that packets have to take in order to reach the specified address.</li>
<li><b>Nslookup</b> - obtains domain name address and IP address mapping information.</li>
</ul>
</td>
</tr>
<tr>
<td>Protocol</td>
<td>IPv4 | IPv6; default: <b>IPv4</b></td>
<td>Selects IP address family for diagnostic test.</td>
</tr>
<tr>
<td>Address</td>
<td>ip | host; default: <b>none</b></td>
<td>IP address or hostname on which the diagnostic test will be performed.</td>
</tr>
</table>
==Troubleshoot==
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the router. Refer to the figure and table below for information on the Troubleshoot page.
[[File:{{{file_troubleshoot}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>System log</td>
<td>- (interactive button)</td>
<td>Displays the contents of the router's system log file. The system log contains records of various system related events, such as starts/stops of various services, errors, reboots, etc.</td>
</tr>
<tr>
<td>Kernel log</td>
<td>- (interactive button)</td>
<td>Displays the contents of the router's kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS).</td>
</tr>
<tr>
<td>Troubleshoot file</td>
<td>- (interactive button)</td>
<td>Downloads the router's Troubleshoot file. It contains the router's configuration information, logs and some other files. When requesting support, it is recommended to always provide the router's Troubleshoot file to Teltonika engineers for analysis.</td>
</tr>
<tr>
<td>TCP dump file</td>
<td>- (interactive button)</td>
<td>Downloads the router's TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the router does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.</td>
</tr>
<tr>
<td>Enable TCP dump<span class="asterisk">*</span></td>
<td>off | on; default: <b>off</b></td>
<td>Turns TCP dump packets capture on or off.</td>
</tr>
</table>
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
===TCP dump===
----
<b>TCP dump</b> is a program used to capture packets moving through network interfaces. By default, the router does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
[[File:{{{file_tcpdump}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable TCP dump</td>
<td>off | on; default: <b>off</b></td>
<td>Turns TCP dump packet capture on or off.</td>
</tr>
<tr>
<td>Select interface</td>
<td>network interface; default: '''br-lan'''</td>
<td>Only captures packets that move through the specified network interface.</td>
</tr>
<tr>
<td>Select protocol filter</td>
<td>all | icmp | tcp | udp | arp; default: <b>All</b></td>
<td>Only captures packets that match the specified protocol.</td>
</tr>
<tr>
<td>Select packets direction</td>
<td>IN/OUT | Incoming | Outgoing; default: <b>IN/OUT</b></td>
<td>Only captures packets coming from the specified direction.</td>
</tr>
<tr>
<td>Host</td>
<td>ip | host; default: <b>none</b></td>
<td>Only captures packets related to the specified host.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65335]; default: <b>none</b></td>
<td>Only captures packets related to the specified communication port.</td>
</tr>
<tr>
<td>Select storage</td>
<td>Internal storage | / ; default: <b>Internal storage</b></td>
<td>Specifies where the TCP dump file will be stored.</td>
</tr>
</table>
==Access Control==
The <b>Access Control</b> page is used to manage remote and local access to the router.
<b>Important</b>: turning on remote access leaves the router vulnerable to external attackers. Make sure you use a strong password.
<br><br>
<b>SSH</b>
----
[[File:{{{file_access_ssh}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable SSH access</td>
<td>off | on; default: <b>on</b></td>
<td>Turns SSH access from the local network (LAN) on or off.</td>
</tr>
<tr>
<td>Remote SSH access</td>
<td>off | on; default: <b>off</b></td>
<td>Turns SSH access from remote networks (WAN) on or off.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>22</b></td>
<td>Selects which port to use for SSH access.</td>
</tr>
</table>
<br>
<b>WebUI</b>
----
[[File:{{{file_access_webui}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable HTTP access</td>
<td>off | on; default: <b>on</b></td>
<td>Turns HTTP access from the local network (LAN) to the router's WebUI on or off.</td>
</tr><tr><td>Enable HTTPS access
</td><td>off | on; default: <b>on</b></td><td>Turns HTTPS access from the local network (LAN) to the router's WebUI on or off.</td></tr><tr>
<td>Redirect to HTTPS</td>
<td>off | on; default: <b>off</b></td>
<td>Redirects connection attempts from HTTP to HTTPS.</td>
</tr>
<tr>
<td>Enable remote HTTP access</td>
<td>off | on; default: <b>off</b></td>
<td>Turns HTTP access from remote networks (WAN) to the router's WebUI on or off.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>80</b></td>
<td>Selects which port to use for HTTP access.</td>
</tr>
<tr>
<td>Enable remote HTTPS access</td>
<td>off | on; default: <b>off</b></td>
<td>Turns HTTPS access from remote networks (WAN) to the router's WebUI on or off.</td>
</tr>
<tr>
<td>Port</td>
<td>integer [0..65535]; default: <b>443</b></td>
<td>Selects which port to use for HTTPS access.</td>
</tr>
</table>
<br>
<b>CLI</b>
----
[[File:{{{file_access_cli}}}]]
<table class="nd-mantable">
<tr>
<th>Field</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>Enable CLI</td>
<td>off | on; default: <b>on</b></td>
<td>Turns CLI access from the local network (LAN) on or off.</td>
</tr>
<tr>
<td>Enable remote CLI</td>
<td>off | on; default: <b>off</b></td>
<td>Turns CLI access from remote networks (WAN) on or off.</td>
</tr>
<tr>
<td>Port range</td>
<td>range of integers [0..65534]-[1..65535]; default: <b>4200-4220</b></td>
<td>Selects which ports to use for CLI access.</td>
</tr>
<tr>
<td>Shell limit</td>
<td>integer [1..10]; default: <b>5</b></td>
<td>Maximum number of active CLI connections.</td>
</tr>
</table>
==Root CA==
The <b>Root CA</b> section is used to add a root CA certificate file to the router. There is a default file already preloaded on the device which will be overwritten by any uploaded file. The certificates must be in .pem format, maximum file size is 300 KB. These certificates are only needed if you want to use HTTPS for your services and the default file should be sufficient in most cases.
[[File:{{{file_root_ca}}}]]
[[Category:{{{name}}} System section]]