Difference between revisions of "Template:Networking rutos manual administration"

From Teltonika Networks Wiki
(2 intermediate revisions by 2 users not shown)
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.06
+
| fw_version = {{{series}}}_R_00.02.06.1
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 375: Line 375:
 
==Recipients==
 
==Recipients==
  
The <b>Recipients</b> section is used to configure phone groups and email users, which can later be used along with SMS or email related services, such as [[{{{name}}} Events Reporting|Events Reporting]].
+
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===
 
===Phone Groups===
Line 410: Line 414:
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
}}
  
 
===Email Accounts===
 
===Email Accounts===
 
----
 
----
When email related services (such as [[{{{name}}} Events Reporting|Events Reporting]]) 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.
+
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:
 
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:
Line 469: 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 484: Line 489:
 
==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===

Revision as of 14:02, 5 March 2021

Template:Networking rutos manual fw disclosure

Summary

This page is an overview of the Administration section of {{{name}}} devices.

General

The General 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_{{{name}}}_manual_administration_general.png|border|class=tlt-border]]

Field Value Description
Device name string; default: {{{name}}} Device model name.
Hostname string; default: Teltonika-{{{name}}}.com Device hostname. This can be used for communication with other LAN hosts.
Mode Basic | Advanced; default: Basic Mode determines what options and configurations are shown. In Basic mode only the essential configurations are shown. In Advanced mode there is greater freedom to configure and access more options.
Min time integer [0..60]; default: none Minimum time (in seconds) the button needs to be held to perform an action.
Max time integer [1..60]; default: none Maximum time (in seconds) the button can be held to perform an action, after which no action will be performed.
Restore to factory defaults -(interactive button) Restores device to manufacturer's default settings.
Restore to user's defaults -(interactive button) Restores device to custom configuration set by the user.

Access Control

General


The Access Control page is used to manage remote and local access to device.

Important: turning on remote access leaves your device vulnerable to external attackers. Make sure you use a strong password.

SSH


Networking rutos manual administration access control general ssh.png

Field Value Description
Enable SSH access off | on; default: on Turns SSH access from the local network (LAN) on or off.
Remote SSH access off | on; default: off Turns SSH access from remote networks (WAN) on or off.
Port integer [0..65535]; default: 22 Selects which port to use for SSH access.


WebUI


Networking rutos manual administration access control general webui.png

Field Value Description
Enable HTTP access off | on; default: on Turns HTTP access from the local network (LAN) to the device WebUI on or off.
Enable HTTPS access off | on; default: onTurns HTTPS access from the local network (LAN) to the device WebUI on or off.
Redirect to HTTPS off | on; default: off Redirects connection attempts from HTTP to HTTPS.
Enable remote HTTP access off | on; default: off Turns HTTP access from remote networks (WAN) to the device WebUI on or off.
Port integer [0..65535]; default: 80 Selects which port to use for HTTP access.
Enable remote HTTPS access off | on; default: off Turns HTTPS access from remote networks (WAN) to the device WebUI on or off.
Port integer [0..65535]; default: 443 Selects which port to use for HTTPS access.


CLI


Networking rutos manual administration access control general cli.png

Field Value Description
Enable CLI off | on; default: on Turns CLI access from the local network (LAN) on or off.
Enable remote CLI off | on; default: off Turns CLI access from remote networks (WAN) on or off.
Port range range of integers [0..65534]-[1..65535]; default: 4200-4220 Selects which ports to use for CLI access.
Shell limit integer [1..10]; default: 5 Maximum number of active CLI connections.

Security


Networking rutos manual administration access control security.png

Field Value Description
Fail count integer; default: 10 An amount of times IP address can try to access SSH or WebUI before being blocked.
Blocked address ip IP address which was blocked due to reaching fail count limit.
Failed attempts integer Amount of times IP address tried to access SSH or WebUI after getting blocked.

Root CA


The Root CA 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.

Networking rutos manual administration access control root ca.png

Troubleshoot

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.

Networking rutos manual administration troubleshoot logging settings.png

Field Value Description
System log buffer size integer; default: 128 System log buffer size in kibibytes (KiB).
External system log server ip; default: none IP address of an external server that will be used to store device logs.
External system log server port integer [0..65535]; default: none TCP/UDP port number of the external log server.
External system log server protocol UDP | TCP; default: UDP Communication protocol used by the external log server.
Save log in RAM memory | Flash memory; default: RAM memory Specifies which type of memory to use for storing system logs.

Troubleshoot


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.

Networking rutos manual administration troubleshoot troubleshoot.png

Field Value Description
System log - (interactive button) 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.
Kernel log - (interactive button) 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).
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.
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.
Enable TCP dump* off | on; default: off Turns TCP dump packets capture on or off.

* More on TCP dump in the next section.

TCP dump


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.

If you enable TCP dump, you will notice additional configuration fields appear. Refer to the figure and table below for realted information.

Networking rutos manual administration troubleshoot tcp dump.png

Field Value Description
Enable TCP dump off | on; default: off Turns TCP dump packet capture on or off.
Select interface network interface; default: br-lan 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.
Select packets direction Incoming/Outgoing | Incoming | Outgoing; default: Incoming/Outgoing Only captures packets coming from the specified direction.
Host ip | host; default: none Only captures packets related to the specified host.
Port integer [0..65335]; default: none Only captures packets related to the specified communication port.
Select storage Internal storage | / ; default: Internal storage Specifies where the TCP dump file will be stored.

Diagnostics


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

Networking rutos manual administration troubleshoot diagnostics.png

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.

Recipients

The Recipients section is used to configure phone groups and email users, which can later be used along with SMS or email related services, such as [[{{{name}}} Events Reporting|Events Reporting]].

Phone Groups


A Phone Group 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:

  1. Enter a custom name for the phone group into the 'Name' field.
  2. Click the 'Add' button.
  3. Click the 'Edit' button next to the newly added phone group.

Networking rutos manual administration recipients phone groups add button edit button.png

After clicking 'Edit' you should be redirected to that phone group's configuration page where you can start adding phone numbers to it.

Networking rutos manual administration recipients phone groups modify phone group.png

Field Value Description
Group name string; default: none Name of this phone numbers group.
Phone number string; default: none A phone number entry for this group. Numbers that consist of 0-9*+# characters are accepted. Click the plus symbol to add more entries.

Email Accounts


When email related services (such as [[{{{name}}} Events Reporting|Events Reporting]]) 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 Email Account 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:

  1. Enter a custom name for the email account into the 'Name' field.
  2. Click the 'Add' button.
  3. Click the 'Edit' button next to the newly added email account.

Networking rutos manual administration recipients email accounts groups add button edit button.png

After clicking 'Edit' you should be redirected to that email account's settings page where you can start configuring the account.

Networking rutos manual administration recipients email accounts modify email account.png

Field Value Description
Secure connection off | on; default: off Use if your SMTP server supports TLS or SSL encryption.
SMTP server string; default: none Name of the email service provider's SMTP server.
SMTP server port integer [0..65535]; default: none Port of the email service provider's SMTP server.
User name string; default: none Username used to authenticate to the email service.
Password string; default: none Password used to authenticate to the email service..
Sender's email address string; default: none Configured SMTP server user's email address.

Overview setup

The Overview setup section is used to select which widgets will be shown in the [[{{{name}}}_Overview|Overview]] window.


Certificates

The Certificates 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.

Certificate Generation


The Certificate Generation tab provides the possibility to generate TLS certificates required for secure authentication and communication encryption used by some of the devices services.

There are five distinct generation methods (denoted by the selected 'File Type').

  1. Simple - generates and signs a set of 2048 bit certificate and key files that include:
    • Certificate Authority (CA)
    • Server certificate & key
    • Client certificate & key
    • DH Parameters
    The CA file generated with this option automatically signs the certificates. In short, this option is used for convenience as it doesn't let the user set any additional parameters for the certificate files. Therefore, it should be used only when no other specific requirements are expected.
  2. CA - generates a Certificate Authority (CA) file. A CA is a type of certificate file that certifies the ownership of a public key by the named subject of the certificate. In other words, it assures clients that they are connecting to a trusted server and vice versa.
  3. Server - generates a server certificate and key. A server certificate validates a server's identity to connecting clients, while a key is responsible for encryption.
  4. Client - generates a client certificate and key. A client certificate validates a client's identity to the server that it's connecting to, while a key is responsible for encryption.
  5. DH Parameters - generates a Diffie-Hellman (DH) parameters file. DH parameters are used in symmetric encryption to protect and define how OpenSSL key exchange is performed.

Generation Parameters


Generating each type of file (excluding 'Simple') requires setting some parameters. This section provides an overview for parameters used in TLS certificate generation.


Core parameters or simply parameters that apply to each file type are the size and common name of the generated file(s).

Networking rutos manual administartion certificates certificates generation core parameters v1.png

Field Value Description
Key Size integer; default: 2048 Generated key size in bits. Larger keys provide more security but take longer to generate. A 2048 bit is the preferred option.
Name (CN) string; default: cert Common Name (CN), aka Fully Qualified Domain Name (FQDN) is a parameter that defines the name of the certificate. It should be chosen with care as it is not only used for easier management. For example, the Common Name should typically hostname of the server. It may also be used to differentiate clients in order to apply client-specific settings.

Subject information is not mandatory but can be used as user-friendly way to identify the ownership of certificate files by including such information as the owner's location and company name.

Networking rutos manual administartion certificates certificates generation subject information v1.png


The Sign the certificate slider control whether the certificate will be signed automatically or manually after the generation is complete.

Networking rutos manual administartion certificates certificates generation sign the certificate v1.png

Field Value Description
Days Valid integer; default: 3650 Length of the signature's validity.
CA File Name filename; default: none Selects which CA file will be used to sign the generated certificate.
CA key filename; default: none Selects which CA key file will be used to sign the generated certificate.
Delete Signing Request off | on; default: off Generation creates additional 'signing request' files (which appear under the Certificate Manager tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.

A Private Key Decryption Password is a parameter used to decrypt private keys protected by a password.

Networking rutos manual administartion certificates certificates generation private key decryption password v1.png

Certificate Signing


The Certificate Signing section is used to validate (sign) unsigned certificates.

Networking rutos manual administartion certificates certificates generation certificate signing v1.png

Field Value Description
Signed Certificate Name string; default: cert Name of the signed certificate.
Type of Certificate to Sign Certificate Authority | Client Certificate | Server Certificate; default: Certificate Authority Specifies what type of file will be signed.
Certificate Request File file; default: none Specifies the signing request file linked to the certificate.
Days Valid integer; default: 3650 Length of the signature's validity.
Certificate Authority File filename; default: none Selects which CA file will be used to sign the generated certificate.
Certificate Authority Key filename; default: none Selects which CA key file will be used to sign the generated certificate.
Delete Signing Request off | on; default: off Generation creates additional 'signing request' files (which appear under the Certificate Manager tab) that are later used to sign the generated certificates. When this option is set to 'on', the device deletes the signing request files after the signing process is complete.
Sign - (interactive button) Signs the certificate on click.

Certificate Manager


The Certificate Manager page displays information on all certificate and key files stored on the device and provides the possibility export these files for use on another machine or import files generated elsewhere.

Certificate Import


The Certificate Import section provides the possibility to import certificates and files generated on another machine. To upload such a file simply click 'Browse', locate the file on your computer and click 'Import'

Networking rutos manual administartion certificates certificates manager certificate import v1.png

Certificates, Keys & Requests


The Certificates, Keys and Requests section display files generated on or imported to the device along with the most important information related to them.

By default, the lists are empty. A set certificates generated using 'Simple' file type would look something like this:

Networking rutos manual administartion certificates certificates manager certificate list v1.png

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.

Unsaved changes

The Unsaved changes section is used to see and apply or revert all unsaved changes.

Networking rutos manual administration unsaved changes.png

[[Category:{{{name}}} System section]]