Jump to content
  • EN

Template:Networking rutos manual troubleshoot: Difference between revisions

From Teltonika Networks Wiki
← Older edit
VisualWikitext
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
===Logging Settings===
===Troubleshoot Logs===
----
----
The <b>Logging Settings</b> section is used to configure how and where the device 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 device.
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the device. Refer to the figure and table below for information on the Troubleshoot page.


[[File:Networking_rutos_manual_administration_troubleshoot_logging_settings_v3.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_troubleshoot_troubleshoot_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 12: Line 12:
     </tr>
     </tr>
     <tr>
     <tr>
      <td>System log buffer size</td>
        <td>System logs</td>
      <td>integer; default: <b>128</b></td>
        <td>- (interactive button)</td>
      <td>System log buffer size in kibibytes (KiB).</td>
        <td>Displays the contents of the device'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>
     <tr>
     <tr>
      <td>External system log server Hostname</td>
        <td>Kernel logs</td>
      <td>host:port; default: <b>none</b></td>
        <td>- (interactive button)</td>
      <td>IP address/host and port of an external server that will be used to store device logs.</td>
        <td>Displays the contents of the device's kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS).</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>External system log server Protocol</td>
        <td>Encrypt</td>
      <td>UDP | TCP; default: <b>UDP</b></td>
        <td>off {{!}} <span style="color:blue">on</span>; default: <b>off</b></td>
      <td>Communication protocol used by the external log server.</td>
        <td>Turn on AES 256 encryption and archive Troubleshoot file using zip format.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td>Save log in</td>
        <td><span style="color:blue">Password</span></td>
      <td>RAM memory | <span style="color:blue">Flash memory</span>; default: <b>RAM memory</b></td>
        <td>string; default: <b>none</b></td>
      <td>Specifies which type of memory to use for storing system logs.</td>
        <td>Password that will be used to encrypt Troubleshoot file. It will have to be provided when extracting formatted zip archive to gain access to a tar file.</td>
     </tr>
     </tr>
     <tr>
     <tr>
      <td><span style="color:blue">System log file size</span></td>
        <td>Troubleshoot file</td>
      <td>integer [10..500]; default: <b>200</b></td>
        <td>- (interactive button)</td>
      <td>Maximum size (in kilobytes) of a log file. When threshold is reached, log rotation is performed. Can be set to value from 10kB to 500kB. Smaller the file, larger amount of old logs is saved.</td>
        <td>Downloads the device Troubleshoot file. It contains the device configuration information, logs and some other files. When requesting support, it is recommended to always provide the device Troubleshoot file to Teltonika engineers for analysis.</td>
     </tr>
     </tr>
</table>   
===Logging Settings===
----
The <b>Logging Settings</b> section is used to configure how and where the device 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 device.
[[File:Networking_rutos_manual_administration_troubleshoot_logging_settings_v4.png|border|class=tlt-border]]
<table class="nd-mantable">
     <tr>
     <tr>
      <td><span style="color:blue">Compress</span></td>
        <th>Field</th>
       <td>off | on; default: <b>off</b></td>
       <th>Value</th>
       <td>Compress old rotated logs using GZ format.</td>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Delete</td>
       <td>Save log in</td>
       <td>- (interactive button)</td>
       <td>RAM memory {{!}} <span style="color:blue">Flash memory</span>; default: <b>RAM memory</b></td>
       <td>Deletes log file from router.</td>
       <td>Specifies which type of memory to use for storing system logs.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Show hostname</td>
       <td>Show hostname</td>
       <td>off | on; default: <b>off</b></td>
       <td>off {{!}} on; default: <b>off</b></td>
       <td>Show hostname instead of IP address in syslog.</td>
       <td>Show hostname instead of IP address in syslog.</td>
     </tr>
     </tr>
</table>
===Troubleshoot===
----
The <b>Troubleshoot</b> section is used to download various files that contain information used for troubleshooting the device. Refer to the figure and table below for information on the Troubleshoot page.
{{#switch:{{{series}}}
|TAP100|TAP200 = [[File:Networking_rutos_manual_administration_troubleshoot_troubleshoot_tap100.png|border|class=tlt-border]]
|#default = [[File:Networking_rutos_manual_administration_troubleshoot_troubleshoot.png|border|class=tlt-border]]}}
<table class="nd-mantable">
     <tr>
     <tr>
        <th>Field</th>
      <td>System log file size</td>
       <th>Value</th>
       <td>integer [1..65535]; default: <b>128</b></td>
       <th>Description</th>
       <td>Maximum size (in kilobytes) of a log file. When threshold is reached, log rotation is performed.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>System log</td>
      <td>External system log server Hostname</td>
        <td>- (interactive button)</td>
      <td>host:port; default: <b>none</b></td>
        <td>Displays the contents of the device system log file. The system log contains records of various system related events, such as starts/stops of various services, errors, reboots, etc.</td>
      <td>IP address/host and port of an external server that will be used to store device logs.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Kernel log</td>
      <td><span style="color:blue">Compress</span></td>
        <td>- (interactive button)</td>
      <td>off {{!}} on; default: <b>off</b></td>
        <td>Displays the contents of the device kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS).</td>
      <td>Compress previously rotated log files using gzip (.gz) format.</td>
     </tr>
     </tr>
     <tr>
     <tr>
        <td>Troubleshoot file</td>
      <td>External system log server Protocol</td>
        <td>- (interactive button)</td>
      <td>UDP {{!}} TCP; default: <b>UDP</b></td>
        <td>Downloads the device Troubleshoot file. It contains the device configuration information, logs and some other files. When requesting support, it is recommended to always provide the device Troubleshoot file to Teltonika engineers for analysis.</td>
      <td>External system log server hostname and port in host:port format (i.e. 127.0.0.1:6001).</td>
     </tr>{{#switch:{{{series}}}|TAP100|TAP200=|#default=
     </tr>
     <tr>
     <tr>
        <td>TCP dump file{{#ifeq:{{{series}}}|RUTX||<span class="asterisk">*</span>}}</td>
      <td>Delete log file</td>
        <td>- (interactive button)</td>
      <td>- (interactive button)</td>
        <td>Downloads the device TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.</td>
      <td>Deletes log file from device.</td>
     </tr>
     </tr>
    <tr>
        <td>Enable TCP dump{{#ifeq:{{{series}}}|RUTX||<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>
</table>
{{#switch:{{{series}}}|TAP100|TAP200|RUT2M|RUT9M|TCR1=
| #default={{#switch:{{{series}}}|RUTX|RUTM=|#default=<font size="-1"><span class="asterisk">*</span> As of {{{series}}}_R_00.07.00, TCPdump is not part of core functionality anymore. To see these options, the TCPdump package must be downloaded from [[{{{name}}}_Package_Manager|Package Manager]].</font>}}
}}


{{#switch:{{{series}}}|TAP100|TAP200=|#default= ====TCP dump====
{{#switch:{{{series}}}|TAP100|TAP200=|#default=
===TCP dump===
----
----
<b>TCP dump</b> is {{#switch:{{{series}}}|RUTX|RUTM=|#default=an <i>optional</i> downloadable functionality<span class="asterisk">*</span>}} used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.
{{#switch:{{{series}}}|TAP100|TAP200|RUT2M|RUT9M|TCR1=
 
| #default={{#switch:{{{series}}}|RUTX|RUTM=|#default=<font size="-1"><span class="asterisk">*</span> As of {{{series}}}_R_00.07.00, TCPdump is not part of core functionality anymore. To see these options, the TCPdump package must be downloaded from [[{{{name}}}_Package_Manager|Package Manager]].</font>}}}}
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
 
{{#switch:{{{series}}}|RUTX|RUTM=|#default=<font size="-1"><span class="asterisk">*</span> You can download the TCPdump package from [[{{{name}}}_Package_Manager|Package Manager]].</font>}}


[[File:Networking_rutos_manual_administration_troubleshoot_tcp_dump.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_troubleshoot_tcpdump.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>Field</th>
         <td>Enable TCP dump{{#ifeq:{{{series}}}|RUTX||<span class="asterisk">*</span>}}</td>
      <th>Value</th>
      <th>Description</th>
    </tr>
    <tr>
        <td>Enable TCP dump</td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>off {{!}} on; default: <b>off</b></td>
         <td>Turns TCP dump packet capture on or off.</td>
         <td>Turns TCP dump packets capture on or off.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Select interface</td>
         <td>Select interface</td>
         <td>network interface; default: '''br-lan'''</td>
         <td>Any {{!}} LAN {{!}} WAN {{!}} WLAN; default: <b>Any</b></td>
         <td>Only captures packets that move through the specified network interface.</td>
         <td>Only captures packets that move through the specified network interface.</td>
     </tr>
     </tr>
Line 126: Line 110:
         <td>All {{!}} ICMP {{!}} TCP {{!}} UDP {{!}} ARP; default: <b>All</b></td>
         <td>All {{!}} ICMP {{!}} TCP {{!}} UDP {{!}} ARP; default: <b>All</b></td>
         <td>Only captures packets that match the specified protocol.</td>
         <td>Only captures packets that match the specified protocol.</td>
    </tr>
    <tr>
        <td>Select packets direction</td>
        <td>Incoming/Outgoing {{!}} Incoming {{!}} Outgoing; default: <b>Incoming/Outgoing</b></td>
        <td>Only captures packets coming from the specified direction.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Host</td>
         <td>Host</td>
         <td>ip {{!}} host; default: <b>none</b></td>
         <td>Domain names or IP; default: <b>none</b></td>
         <td>Only captures packets related to the specified host.</td>
         <td>Only captures packets related to the specified host.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Port</td>
         <td>Port</td>
         <td>integer [0..65335]; default: <b>none</b></td>
         <td>integer [1..65535]; default: <b>none</b></td>
         <td>Only captures packets related to the specified communication port.</td>
         <td>Only captures packets related to the specified port.</td>
    </tr>
    <tr>
        <td>Select packets direction</td>
        <td>Incoming/Outgoing {{!}} Incoming {{!}} Outgoing; default: <b>Incoming/Outgoing</b></td>
        <td>Only captures packets coming from the specified direction.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Select storage</td>
         <td>Select storage</td>
         <td>RAM memory; default: <b>RAM memory</b></td>
         <td>RAM memory {{!}} ; default: <b>RAM memory</b></td>
         <td>Specifies where the TCP dump file will be stored.</td>
         <td>Specifies where the TCP dump file will be stored.</td>
    </tr>
    <tr>
        <td>TCP dump file{{#ifeq:{{{series}}}|RUTX||<span class="asterisk">*</span>}}</td>
        <td>- (interactive button)</td>
        <td>Downloads the device TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.</td>
     </tr>
     </tr>
</table>}}
</table>}}
Line 153: Line 142:
The <b>Diagnostics</b> section is used to execute simple network diagnostic tests, including <i>ping</i>, <i>traceroute</i> and <i>nslookup</i>.
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:Networking_rutos_manual_administration_troubleshoot_diagnostics.png|border|class=tlt-border]]
[[File:Networking_rutos_manual_administration_troubleshoot_diagnostics_v1.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 163: Line 152:
     <tr>
     <tr>
       <td>Method</td>
       <td>Method</td>
       <td>Ping | Traceroute | Nslookup; default: <b>Ping</b></td>
       <td>Ping {{!}} Traceroute {{!}} Nslookup; default: <b>Ping</b></td>
       <td>Selects diagnostic method.
       <td>Selects diagnostic method.
             <ul>
             <ul>
Line 174: Line 163:
     <tr>
     <tr>
       <td>Protocol</td>
       <td>Protocol</td>
       <td>IPv4 | IPv6; default: <b>IPv4</b></td>
       <td>IPv4 {{!}} IPv6; default: <b>IPv4</b></td>
       <td>Selects IP address family for diagnostic test.</td>
       <td>Selects IP address family for diagnostic test.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Address</td>
       <td>Address</td>
       <td>ip | host; default: <b>none</b></td>
       <td>ip {{!}} host; default: <b>none</b></td>
       <td>IP address or hostname on which the diagnostic test will be performed.</td>
       <td>IP address or hostname on which the diagnostic test will be performed.</td>
     </tr>
     </tr>
Line 194: Line 183:
The <b>Modem Debug</b> section is used to send AT commands to the modem.
The <b>Modem Debug</b> section is used to send AT commands to the modem.


{{#ifeq: {{{name}}} | RUTX12 | [[File:Networking_rutos_manual_administration_troubleshoot_modemdebug_v1_RUTX12.png|border|class=tlt-border]] | [[File:Networking_rutos_manual_administration_troubleshoot_modemdebug_v1.png|border|class=tlt-border]]}}
[[File:Networking_rutos_manual_administration_troubleshoot_modemdebug_v3.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
Line 211: Line 200:
       <td>AT command</td>
       <td>AT command</td>
       <td>AT command; default: <b>none</b></td>
       <td>AT command; default: <b>none</b></td>
       <td>AT command to send to the modem</td>
       <td>Field for the AT command.</td>
    </tr>
    <tr>
        <td>Send</td>
      <td>-(interactive button)</td>
      <td>Sends at command to modem.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Response message</td>
       <td>Response message</td>
       <td>- (read only text box)</td>
       <td>- (read only text box)</td>
       <td>The response message of the sent at command.</td>
       <td>Response received from the sent AT command.</td>
     </tr>
     </tr>
     <tr>
     <tr>
         <td>Send</td>
         <td>Clear</td>
       <td>-(interactive button)</td>
       <td>-(interactive button)</td>
       <td>Sends at command to modem.</td>
       <td>Clears response messages.</td>
     </tr>
     </tr>
</table>
====AT Commands History====
This section shows the sent AT commands.
[[File:Networking_rutos_manual_administration_troubleshoot_athistory_v2.png|border|class=tlt-border]]
<table class="nd-othertables">
     <tr>
     <tr>
         <th width="250">field name</th>
         <td>Export</td>
        <th width="900">description</th>
      <td>-(interactive button)</td>
      <td>Exports response messages to <b>.csv</b> file.</td>
     </tr>
     </tr>
    <tr>
        <td>Date</td>
        <td>Time when the AT command was sent </td>
    </tr>
    <tr>
        <td>Command</td>
        <td>The command that was sent </td>
    </tr>
    <tr>
        <td>Response</td>
        <td>The response received from the modem </td>
    </tr>
</table>|}}
</table>|}}

Latest revision as of 15:03, 4 June 2025

Troubleshoot Logs

The Troubleshoot section is used to download various files that contain information used for troubleshooting the device. Refer to the figure and table below for information on the Troubleshoot page.

Field Value Description
System logs - (interactive button) Displays the contents of the device's system log file. The system log contains records of various system related events, such as starts/stops of various services, errors, reboots, etc.
Kernel logs - (interactive button) Displays the contents of the device's kernel log file. The kernel log contains records of various events related to the processes of the operating system (OS).
Encrypt off | on; default: off Turn on AES 256 encryption and archive Troubleshoot file using zip format.
Password string; default: none Password that will be used to encrypt Troubleshoot file. It will have to be provided when extracting formatted zip archive to gain access to a tar file.
Troubleshoot file - (interactive button) Downloads the device Troubleshoot file. It contains the device configuration information, logs and some other files. When requesting support, it is recommended to always provide the device Troubleshoot file to Teltonika engineers for analysis.

Logging Settings

The Logging Settings section is used to configure how and where the device 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 device.

Field Value Description
Save log in RAM memory | Flash memory; default: RAM memory Specifies which type of memory to use for storing system logs.
Show hostname off | on; default: off Show hostname instead of IP address in syslog.
System log file size integer [1..65535]; default: 128 Maximum size (in kilobytes) of a log file. When threshold is reached, log rotation is performed.
External system log server Hostname host:port; default: none IP address/host and port of an external server that will be used to store device logs.
Compress off | on; default: off Compress previously rotated log files using gzip (.gz) format.
External system log server Protocol UDP | TCP; default: UDP External system log server hostname and port in host:port format (i.e. 127.0.0.1:6001).
Delete log file - (interactive button) Deletes log file from device.

TCP dump

* As of {{{series}}}_R_00.07.00, TCPdump is not part of core functionality anymore. To see these options, the TCPdump package must be downloaded from [[{{{name}}}_Package_Manager|Package Manager]].

Enable TCP dump* off | on; default: off Turns TCP dump packets capture on or off.
Select interface Any | LAN | WAN | WLAN; default: Any Only captures packets that move through the specified network interface.
Select protocol filter All | ICMP | TCP | UDP | ARP; default: All Only captures packets that match the specified protocol.
Host Domain names or IP; default: none Only captures packets related to the specified host.
Port integer [1..65535]; default: none Only captures packets related to the specified port.
Select packets direction Incoming/Outgoing | Incoming | Outgoing; default: Incoming/Outgoing Only captures packets coming from the specified direction.
Select storage RAM memory | ; default: RAM memory Specifies where the TCP dump file will be stored.
TCP dump file* - (interactive button) Downloads the device TCP dump file. TCP dump is a program used to capture packets moving through network interfaces. By default, the device does not store TCP dump information. You must enable TCP dump and save the changes before you can download the file.

Diagnostics

The Diagnostics section is used to execute simple network diagnostic tests, including ping, traceroute and nslookup.

Field Value Description
Method Ping | Traceroute | Nslookup; default: Ping Selects diagnostic method.
  • Ping - sends ICMP requests to the specified address.
  • Traceroute - displays the path that packets have to take in order to reach the specified address.
  • Nslookup - obtains domain name address and IP address mapping information.
Protocol IPv4 | IPv6; default: IPv4 Selects IP address family for diagnostic test.
Address ip | host; default: none IP address or hostname on which the diagnostic test will be performed.
Perform -(interactive button) Performs diagnostic test when clicked.


Retrieved from "https://wiki.teltonika-networks.com/index.php?title=Template:Networking_rutos_manual_troubleshoot&oldid=150474"