Changes

Template:Networking rutos manual administration (view source)

Revision as of 15:02, 5 March 2021

1,690 bytes added ,  15:02, 5 March 2021
no edit summary
Line 1: Line 1:  
<!--- {{{series}}}, {{{name}}} --->
 
<!--- {{{series}}}, {{{name}}} --->
−
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
−
| fw_version = {{{series}}}_R_00.02.04.1
+
| fw_version = {{{series}}}_R_00.02.06.1
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 12: Line 12:     
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.
 
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.
−
{{#switch:{{{series}}}
  −
| RUTX  = [[File:Networking_rutx_manual_administration_general_v2.png|border|class=tlt-border]]
  −
| TRB2XX = [[File:Networking_trb2_manual_administration_general_v2.png|border|class=tlt-border]]
  −
| TRB14X = [[File:Networking_trb1_manual_administration_general_v2.png|border|class=tlt-border]]
  −
|
  −
}}
      +
{{#ifeq:{{{series}}}|RUTX|[[File:Networking_{{lc:{{{name}}}}}_manual_administration_general_v2.png|border|class=tlt-border]]
 +
|[[File:Networking_{{lc:{{{name}}}}}_manual_administration_general.png|border|class=tlt-border]]}}
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 60: Line 56:  
         <td>-(interactive button)</td>
 
         <td>-(interactive button)</td>
 
         <td>Restores device to custom configuration set by the user.</td>
 
         <td>Restores device to custom configuration set by the user.</td>
−
    </tr>
  −
</table>
  −
  −
==Users & recipients==
  −
  −
The <b>Users & recipients</b> section is used to configure phone groups and email users.
  −
  −
===Phone groups===
  −
----
  −
The <b>Phone groups</b> section is used to manage groups of phone numbers.
  −
  −
Refer to the figure below for information on device Phone groups page.
  −
  −
[[File:Networking_rutx_manual_administration_phone_groups_v1.png]]
  −
  −
You can create a group by writing its name and clicking <b>Add</b> button. To configure group, choose group you want to configure from the list and click [[File:Networking rutx manual edit button v1.png]] <b>Edit</b> button, located at the right side of it.
  −
  −
===Modify phone group===
  −
----
  −
  −
[[File:Networking_rutx_manual_administration_phone_groups_setup_v1.png]]
  −
  −
<table class="nd-mantable">
  −
    <tr>
  −
        <th>Field</th>
  −
      <th>Value</th>
  −
      <th>Description</th>
  −
    </tr>
  −
    <tr>
  −
      <td>Group name</td>
  −
      <td>string; default: <b>none</b></td>
  −
      <td>Name of this phone numbers group.</td>
  −
    </tr>
  −
    <tr>
  −
      <td>Phone number</td>
  −
      <td>string; default: <b>none</b></td>
  −
      <td>A phone number entry for this group. A phone number containing 0-9*+# characters is accepted.</td>
  −
    </tr>
  −
</table>
  −
  −
===Email users===
  −
----
  −
The <b>Email users</b> section is used to manage email configurations.
  −
  −
Refer to the figure below for information on device Email users page.
  −
  −
[[File:Networking_rutx_manual_administration_email_users_v1.png]]
  −
  −
You can create user by writing its name and clicking <b>Add</b> button. To configure email user, choose user you want to configure from the list and click [[File:Networking rutx manual edit button v1.png]] <b>Edit</b> button, located at the right side of it.
  −
  −
===Modify email user===
  −
----
  −
  −
[[File:Networking_rutx_manual_administration_email_users_setup_v1.png]]
  −
  −
<table class="nd-mantable">
  −
    <tr>
  −
        <th>Field</th>
  −
      <th>Value</th>
  −
      <th>Description</th>
  −
    </tr>
  −
    <tr>
  −
      <td>Secure connection</td>
  −
      <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
  −
      <td>Use if your SMTP server supports TLS or SSL encryption.</td>
  −
    </tr>
  −
    <tr>
  −
      <td>SMTP server</td>
  −
      <td>string; default: <b>none</b></td>
  −
      <td>SMTP server name.</td>
  −
    </tr>
  −
    <tr>
  −
      <td>SMTP server port</td>
  −
      <td>integer [0..65535]; default: <b>none</b></td>
  −
      <td>SMTP server port.</td>
  −
    </tr>
  −
    <tr>
  −
      <td>User name</td>
  −
      <td>string; default: <b>none</b></td>
  −
      <td>Username used in authentication to SMTP server.</td>
  −
    </tr>
  −
    <tr>
  −
      <td>Password</td>
  −
      <td>string; default: <b>none</b></td>
  −
      <td>Password used in authentication to SMTP server.</td>
  −
    </tr>
  −
    <tr>
  −
      <td>Sender's email address</td>
  −
      <td>string; default: <b>none</b></td>
  −
      <td>Configured SMTP server's user's email address.</td>
   
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 155: Line 61:  
==Access Control==
 
==Access Control==
 
===General===
 
===General===
−
 
+
----
 
The <b>Access Control</b> page is used to manage remote and local access to device.
 
The <b>Access Control</b> page is used to manage remote and local access to device.
   Line 162: Line 68:  
<b>SSH</b>
 
<b>SSH</b>
 
----
 
----
−
[[File:Networking_rutx_manual_administration_access_control_general_ssh_v1.png]]
+
[[File:Networking_rutos_manual_administration_access_control_general_ssh.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 189: Line 95:  
<b>WebUI</b>
 
<b>WebUI</b>
 
----
 
----
−
[[File:Networking_rutx_manual_administration_access_control_general_webui_v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administration_access_control_general_webui.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 231: Line 137:  
<b>CLI</b>
 
<b>CLI</b>
 
----
 
----
−
[[File:Networking_rutx_manual_administration_access_control_general_cli_v1.png]]
+
[[File:Networking_rutos_manual_administration_access_control_general_cli.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 263: Line 169:  
===Security===
 
===Security===
 
----
 
----
−
[[File:Networking_rutx_manual_administration_access_control_security_v1.png]]
+
[[File:Networking_rutos_manual_administration_access_control_security.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 287: Line 193:  
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 +
===Root CA===
 +
----
 +
The <b>Root CA</b> section is used to add a root CA certificate file to the device. 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:Networking_rutos_manual_administration_access_control_root_ca.png|border|class=tlt-border]]
    
==Troubleshoot==
 
==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_rutos_manual_administration_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 | Flash memory; default: <b>RAM memory</b></td>
 +
      <td>Specifies which type of memory to use for storing system logs.</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.
 
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_rutx_manual_administration_troubleshoot_v1.png]]
+
[[File:Networking_rutos_manual_administration_troubleshoot_troubleshoot.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 329: Line 282:  
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
 
<font size="-1"><span class="asterisk">*</span> More on TCP dump in the [[#TCP_dump|next section]].</font>
   −
===TCP dump===
+
====TCP dump====
 
----
 
----
 
<b>TCP dump</b> 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.  
 
<b>TCP dump</b> 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.  
Line 335: Line 288:  
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
 
If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.
   −
[[File:Networking_rutx_manual_administration_troubleshoot_tcp_dump_v3.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administration_troubleshoot_tcp_dump.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 384: Line 337:  
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_rutx_manual_administration_diagnostics_v3.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administration_troubleshoot_diagnostics.png|border|class=tlt-border]]
    
<table class="nd-mantable">
 
<table class="nd-mantable">
Line 417: Line 370:  
       <td>-(interactive button)</td>
 
       <td>-(interactive button)</td>
 
       <td>Performs diagnostic test when clicked.</td>
 
       <td>Performs diagnostic test when clicked.</td>
 +
    </tr>
 +
</table>
 +
 +
==Recipients==
 +
 +
The <b>Recipients</b> section is used to configure{{#ifeq:{{{mobile}}}|0|&nbsp;|&nbsp;phone groups and&nbsp;}}email
 +
users, which can later be used along with{{#ifeq:{{{mobile}}}|0|&nbsp;|&nbsp;SMS or&nbsp;}}email related
 +
services{{#ifeq:{{{events_reporting}}}|0|.|, such as [[{{{name}}} Events Reporting|Events Reporting]].}}
 +
 +
{{#ifeq:{{{mobile}}}|0||
 +
 +
===Phone Groups===
 +
----
 +
A <b>Phone Group</b> is a collection of phone numbers that can be used as the recipient in SMS & call related services instead of specifying every number individually. The phone group list is empty by default thus, you must first add at least one new group before you can add phone numbers to it. To create and begin editing a phone group, follow these steps:
 +
 +
<ol>
 +
    <li>Enter a custom name for the phone group into the 'Name' field.</li>
 +
    <li>Click the 'Add' button.</li>
 +
    <li>Click the 'Edit' button next to the newly added phone group.</li>
 +
</ol>
 +
 +
[[File:Networking_rutos_manual_administration_recipients_phone_groups_add_button_edit_button.png|border|class=tlt-border]]
 +
 +
After clicking 'Edit' you should be redirected to that phone group's configuration page where you can start adding phone numbers to it.
 +
 +
[[File:Networking_rutos_manual_administration_recipients_phone_groups_modify_phone_group.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>Group name</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Name of this phone numbers group.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Phone number</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>A phone number entry for this group. Numbers that consist of <i>0-9*+#</i> characters are accepted. Click the plus symbol to add more entries.</td>
 +
    </tr>
 +
</table>
 +
}}
 +
 +
===Email Accounts===
 +
----
 +
When email related services{{#ifeq:{{{events_reporting}}}|0|&nbsp;|&nbsp;(such as [[{{{name}}} Events Reporting|Events Reporting]])&nbsp;}}are used, the device logs in to the specified email account and reads the inbox (e.g., Email to SMS) or sends out a message (e.g., SMS to Email) depending on the configured service. In this context, an <b>Email Account</b> is an configuration instance that contains the necessary data required in order to log into an email account.
 +
 +
The email accounts list is empty by default thus, you must first add at least one new account before you can configure it. To create and begin editing an email account, follow these steps:
 +
 +
<ol>
 +
    <li>Enter a custom name for the email account into the 'Name' field.</li>
 +
    <li>Click the 'Add' button.</li>
 +
    <li>Click the 'Edit' button next to the newly added email account.</li>
 +
</ol>
 +
 +
[[File:Networking_rutos_manual_administration_recipients_email_accounts_groups_add_button_edit_button.png|border|class=tlt-border]]
 +
 +
After clicking 'Edit' you should be redirected to that email account's settings page where you can start configuring the account.
 +
 +
[[File:Networking_rutos_manual_administration_recipients_email_accounts_modify_email_account.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
      <th>Value</th>
 +
      <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
      <td>Secure connection</td>
 +
      <td>off <nowiki>|</nowiki> on; default: <b>off</b></td>
 +
      <td>Use if your SMTP server supports TLS or SSL encryption.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>SMTP server</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Name of the email service provider's SMTP server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>SMTP server port</td>
 +
      <td>integer [0..65535]; default: <b>none</b></td>
 +
      <td>Port of the email service provider's SMTP server.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>User name</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Username used to authenticate to the email service.</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Password</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Password used to authenticate to the email service..</td>
 +
    </tr>
 +
    <tr>
 +
      <td>Sender's email address</td>
 +
      <td>string; default: <b>none</b></td>
 +
      <td>Configured SMTP server user's email address.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 422: Line 474:  
==Overview setup==
 
==Overview setup==
   −
The <b>Overview setup</b> section is used to select which widgets will be shown in the [[{{{name}}}_Overview]] window.
+
The <b>Overview setup</b> section is used to select which widgets will be shown in the [[{{{name}}}_Overview|Overview]] window.
 
{{#switch:{{{series}}}
 
{{#switch:{{{series}}}
 
| RUTX = {{#switch:{{{name}}}
 
| RUTX = {{#switch:{{{name}}}
Line 429: Line 481:  
         | [[File:Networking_rutx11_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
         | [[File:Networking_rutx11_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
         }}  
 
         }}  
−
| TRB2XX = [[File:Networking_trb2_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
+
| TRB2 = [[File:Networking_trb2_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
−
| TRB14X = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
+
| TRB1 = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
−
|  
+
| RUT36X = [[File:Networking_trb1_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 +
| RUT30X = [[File:Networking_rut30x_manual_administration_overview_setup_v1.png|border|class=tlt-border]]
 
}}
 
}}
    
==Certificates==
 
==Certificates==
   −
The <b>Certificates</b> page is used for convenient TLS certificate and key generation and management. Generated files can be exported and used on other machines or locally on this device with functions that use TLS/SSL, such as [[{{{name}}} MQTT|MQTT]], [[{{{name}}} VPN#OpenVPN|OpenVPN]], [[{{{name}}} VPN#IPsec|IPsec]] and others.
+
The <b>Certificates</b> page is used for convenient TLS certificate and key generation and management. Generated files can be exported and used on other machines or locally on this device with functions that use TLS/SSL, such as {{#ifeq:{{{mqtt}}}|0||[[{{{name}}} MQTT|MQTT]],&nbsp;}}[[{{{name}}} VPN#OpenVPN|OpenVPN]], [[{{{name}}} VPN#IPsec|IPsec]] and others.
    
===Certificate Generation===
 
===Certificate Generation===
Line 598: Line 651:     
The 'Export' buttons are used to download the files from the device onto your local machine. The 'X' buttons located to the right of each entry are used to delete related files.
 
The 'Export' buttons are used to download the files from the device onto your local machine. The 'X' buttons located to the right of each entry are used to delete related files.
−
  −
==Root CA==
  −
  −
The <b>Root CA</b> section is used to add a root CA certificate file to the device. 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:Networking_rutx_manual_administration_root_ca_v2.png|border|class=tlt-border]]
  −
  −
==Logging==
  −
  −
The <b>Logging</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.
  −
  −
Refer to the figure and table below for information on the device Logging page.
  −
  −
[[File:Networking_rutx_manual_administration_logging_v2.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 | Flash memory; default: <b>RAM memory</b></td>
  −
      <td>Specifies which type of memory to use for storing system logs.</td>
  −
    </tr></table>
      
==Unsaved changes==
 
==Unsaved changes==
Line 649: Line 656:  
The <b>Unsaved changes</b> section is used to see and apply or revert all unsaved changes.
 
The <b>Unsaved changes</b> section is used to see and apply or revert all unsaved changes.
   −
[[File:Networking_rutx_manual_administration_unsaved_changes_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_administration_unsaved_changes.png|border|class=tlt-border]]
    
[[Category:{{{name}}} System section]]
 
[[Category:{{{name}}} System section]]
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/66453...78274"

Navigation menu