Teltonika Networks Wiki

Changes

Template:Networking tswos manual maintenance (view source)

Revision as of 12:23, 24 April 2024

13,003 bytes added ,  24 April
no edit summary
Line 1: Line 1: −
{{Template: Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_device_manual_fw_disclosure
−
| fw_version ={{Template: Networking_rutos_manual_latest_fw
+
| series = {{{series}}}
 +
| name  = {{{name}}}
 +
| fw_version ={{Template: Networking_device_manual_latest_fw
 
  | series = {{{series}}}
 
  | series = {{{series}}}
 
  | name  = {{{name}}}
 
  | name  = {{{name}}}
Line 42: Line 44:  
     <tr>
 
     <tr>
 
         <td>Type</td>
 
         <td>Type</td>
−
         <td>Ping {{!}} Wget; default: <b>Ping</b></td>
+
         <td>Ping {{!}} <span style="color:olive">Wget</span>{{#switch:{{{name}}}|TSW202= {{!}} <span style="color:blue">Port</span>|#default=}}; default: <b>Ping</b></td>
 
         <td>Method used for health checking.
 
         <td>Method used for health checking.
 
             <ul>
 
             <ul>
Line 52: Line 54:  
     <tr>
 
     <tr>
 
         <td>Action if no echo is received</td>
 
         <td>Action if no echo is received</td>
−
         <td>Device reboot {{!}} None; default: <b>Device reboot</b></td>
+
         <td>Device reboot {{!}} None{{#switch:{{{name}}}|TSW202 = {{!}} <span style="color:blue">Restart port</span>|#default=}}; default: <b>Device reboot</b></td>
 
         <td>Action that will be executed if there is no response after the specified amount of retries. If <b>None</b> is selected, only a message to syslog will be logged.</td>
 
         <td>Action that will be executed if there is no response after the specified amount of retries. If <b>None</b> is selected, only a message to syslog will be logged.</td>
 
     </tr>
 
     </tr>
Line 69: Line 71:  
         <td>integer [1..9999]; default: <b>5</b></td>
 
         <td>integer [1..9999]; default: <b>5</b></td>
 
         <td>Maximum response time. If no echo is received after the amount of time specified in this field has passed, the ping/wget request is considered to have failed.</td>
 
         <td>Maximum response time. If no echo is received after the amount of time specified in this field has passed, the ping/wget request is considered to have failed.</td>
 +
    </tr>
 +
    <tr>
 +
        <td><span style="color:olive">URL</span></td>
 +
        <td>url; default: <b>none</b></td>
 +
        <td>URL to which the wget requests will be sent. E.g. http://www.host.com</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 89: Line 96:  
         <td>host {{!}} ip; default: <b>8.8.8.8</b></td>
 
         <td>host {{!}} ip; default: <b>8.8.8.8</b></td>
 
         <td>Hostname or IP address to which the Ping/Wget requests will be sent.</td>
 
         <td>Hostname or IP address to which the Ping/Wget requests will be sent.</td>
 +
    </tr>{{#switch:{{{name}}}|TSW202=
 +
    <tr>
 +
        <td><span style="color:blue">Ping by</span></td>
 +
        <td><span style="color:green">Port</span> {{!}} IP; default: <b>8.8.8.8</b></td>
 +
        <td>Ping IP's by Port or by IP.</td>
 
     </tr>
 
     </tr>
 +
    <tr>
 +
        <td><span style="color:green">Port to ping</span></td>
 +
        <td>port number and number of devices (unsigned integer); default: <b>Port1:1</b></td>
 +
        <td>Port number and number of devices addresses to be pinged. (Number of devices connected must be less or equal to the actual number of connected devices to the port).</td>
 +
    </tr>|#default=}}
 
</table>
 
</table>
   Line 146: Line 163:  
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 +
==Backup==
 +
===Summary===
 +
----
 +
The <b>Backup</b> page is used to generate configuration backup files or upload existing ones to the device. This chapter is an overview of the Backup page in {{{name}}} devices.
 +
 +
===Create default configuration===
 +
----
 +
The <b>Create default configuration</b> section is used to create or delete a file which stores current device configuration. The default configuration can later be loaded in [[{{{name}}}_Maintenance#Backup|Backup]] page or via reset button.
 +
 +
Click the 'Create' button to generate default configuration file from your current device configuration.
 +
 +
[[File:Networking_tswos_manual_maintenance_backup_create_default_configuration.png|border|class=tlt-border]]
 +
 +
===Backup configuration===
 +
----
 +
The <b>Backup configuration</b> section is used to generate and download a file which stores the current device configuration. The backup file can later be uploaded to the same device or another device of the same type (product codes must match).
 +
 +
This section contains MD5, SHA256 checksum fields generated from latest downloaded backup file, 'Download' button to generate and download the device configuration backup file.
 +
 +
[[File:Networking_tswos_manual_maintenance_backup_backup_configuration.png|border|class=tlt-border]]
 +
 +
===Restore configuration===
 +
----
 +
The <b>Restore configuration</b> section is used to upload a configuration file that was taken from this device or another device of the same type.
 +
 +
Click the 'Browse' button to select a backup file from your computer and click the 'Upload archive' button to apply the selected configuration on to this device.
 +
 +
[[File:Networking_tswos_manual_maintenance_backup_restore_configuration.png|border|class=tlt-border]]
 +
 +
<b>Important notes</b>:
 +
<ul>
 +
    <li>Backup files can be uploaded only if they are taken from an identical device (identical Product code (can be checked in the Status → [[{{{name}}} System|System]] page)) with identical or older firmware.</li>
 +
    <li>It is important to remember that the backup file not only changes the device configuration, but also the password. If you are unsure of the backup file's password, you may want to reconsider uploading it because you may lose access to device.</li>
 +
</ul>
 +
 +
====Backup Security Check====
 +
----
 +
After uploading a backup file your device will calculate checksums for uploaded file and display them. If this backup file was the latest downloaded in your device then you can compare these checksums with the ones in your [[#Backup configuration|Backup configuration]] section to verify backup's integrity.
 +
 +
If everything is in order click <b>Proceed</b> to restore configuration to backup.
 +
 +
[[File:Networking_rutos_manual_backup_backup_security_check.png|border|class=tlt-border]]
 +
 +
===Restore default settings===
 +
----
 +
The <b>Restore default settings</b> section is used for restoring device's configuration.
 +
 +
[[File:Networking_tswos_manual_maintenance_backup_restore_default_settings.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </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<span class="asterisk">*</span></td>
 +
        <td>-(interactive button)</td>
 +
        <td>Restores device to custom configuration set by the user.</td>
 +
    </tr>
 +
</table>
 +
 +
<span class="asterisk">*</span> You will not see this button until you have created a <b>[[{{{name}}}_Maintenance#Create_default_configuration|User's default configuration]]</b>.
 +
 +
==Troubleshoot==
 +
===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_tswos_manual_maintenance_troubleshoot_logging_settings.png|border|class=tlt-border]]
 +
 +
<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>128</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 device 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 {{!}} <span style="color:blue">Flash memory</span>; default: <b>RAM memory</b></td>
 +
      <td>Specifies which type of memory to use for storing system logs.</td>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:blue">System log file size</span></td>
 +
      <td>integer [10..500]; default: <b>200</b></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>
 +
    </tr>
 +
    <tr>
 +
      <td><span style="color:blue">Compress</span></td>
 +
      <td>off {{!}} on; default: <b>off</b></td>
 +
      <td>Compress old rotated logs using GZ format.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Delete</td>
 +
      <td>- (interactive button)</td>
 +
      <td>Deletes log file from router.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Show hostname</td>
 +
      <td>off {{!}} on; default: <b>off</b></td>
 +
      <td>Show hostname instead of IP address in syslog.</td>
 +
    </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.
 +
 +
[[File:Networking_tswos_manual_maintenance_troubleshoot_troubleshoot.png|border|class=tlt-border]]
 +
 +
<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 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>
 +
    </tr>
 +
    <tr>
 +
        <td>Kernel log</td>
 +
        <td>- (interactive button)</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>
 +
    </tr>
 +
    <tr>
 +
        <td>Troubleshoot file</td>
 +
        <td>- (interactive button)</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>
 +
        <td>TCP dump file</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>
 +
        <td>Enable TCP dump</td>
 +
        <td>off {{!}} on; default: <b>off</b></td>
 +
        <td>Turns TCP dump packets capture on or off.</td>
 +
    </tr>
 +
</table>
 +
 +
====TCP dump====
 +
----
 +
<b>TCP dump</b> is 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.
 +
 +
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
 +
 +
[[File:Networking_tswos_manual_maintenance_troubleshoot_tcp_dump.png|border|class=tlt-border]]
 +
 +
<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: '''Any'''</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>Incoming/Outgoing {{!}} Incoming {{!}} Outgoing; default: <b>Incoming/Outgoing</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>RAM memory; default: <b>RAM memory</b></td>
 +
        <td>Specifies where the TCP dump file will be stored.</td>
 +
    </tr>
 +
</table>
 +
 +
==Events Log==
 +
===Summary===
 +
----
 +
The <b>Events Log</b> page contains information on various device related events. This article is an overview of the Events Log page for {{{name}}} routers.
 +
 +
===All Events===
 +
----
 +
The <b>All Events</b> page contains a chronological list of various events related to the device. The figure below is an example of the Events Log section:
 +
 +
[[File:Networking_tswos_manual_maintenance_evens_log_all_events.png]]
 +
 +
===General Events===
 +
----
 +
The <b>General Events</b> page contains a chronological list of general events related to the device. The figure below is an example of the Events Log section:
 +
 +
[[File:Networking_tswos_manual_maintenance_evens_log_general_events.png]]
 +
 +
===System Events===
 +
----
 +
The <b>System Events</b> page contains a chronological list of system events related to the device. The figure below is an example of the Events Log section:
 +
 +
[[File:Networking_tswos_manual_maintenace_evens_log_system_events.png]]
 +
 +
===Network Events===
 +
----
 +
The <b>Netwrok Events</b> page contains a chronological list of network events related to the device. The figure below is an example of the Events Log section:
 +
 +
[[File:Networking_tswos_manual_maintenance_evens_log_network_events.png]]
 +
 +
===Connections Events===
 +
----
 +
The <b>Connections Events</b> page contains a chronological list of connections events related to the device. The figure below is an example of the Events Log section:
 +
 +
[[File:Networking_tswos_manual_maintenance_evens_log_connections_events.png]]
 +
 +
==CLI==
 +
===Summary===
 +
----
 +
The <b>CLI</b> or <b>Command-line interface</b> functionality allows you to enter and execute Linux commands within the device. This manual page provides an overview of the CLI page in {{{name}}} devices.
 +
 +
===CLI===
 +
----
 +
The RutOS <b>CLI</b> is a console interface similar to the Linux Terminal program. Use the following credentials to log in:
 +
 +
<ul>
 +
    <li>Username: root</li>
 +
    <li>Password: device's password</li>
 +
</ul>
 +
 +
If the login was successful, you should be greeted with a window similar to this:
 +
 +
[[File:Networking_tswos_manual_maintenance_cli.png]]
    
[[Category:{{{name}}} System section]]
 
[[Category:{{{name}}} System section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/113568...124328"