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

From Teltonika Networks Wiki
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<!-- Template uses {{{name}}}, {{{series}}} -->
+
{{Template: Networking_rutos_manual_fw_disclosure
{{Template:Networking_rutos_manual_fw_disclosure
+
| fw_version ={{Template: Networking_rutos_manual_latest_fw
| fw_version = {{{series}}}_R_00.02.04.1
+
| series = {{{series}}}
| series    = {{{series}}}
+
| name  = {{{name}}}
 +
}}
 
}}
 
}}
 +
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} UPNP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT9XX}} and earlier) user manual page.</i>|}}
 +
{{#ifeq: {{{series}}} | RUT2 |<br><i><b>Note</b>: <b>[[{{{name}}} UPNP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version {{Template: Networking_rutos_manual_latest_fw | series = RUT2XX}} and earlier) user manual page.</i>|}}
 +
__TOC__
 +
==Summary==
  
__TOC__
+
<b>UPnP</b> (<b>Universal Plug and Play</b>) is a service that allows clients in the local network to automatically configure some devices and services.
  
==Summary==
+
This chapter of the user manual provides an overview of the UPnP page in {{{name}}} devices.
 +
{{#switch: {{{series}}}
 +
  | RUTX =
 +
  | #default =  
 +
<u><b>
  
'''UPnP''' allows clients in the local network to automatically configure the router. This chapter is a summary of the UPnP function in {{{name}}} routers.
+
Note:</b> UPNP is additional software that can be installed from the <b>Services → [[{{{name}}} Package Manager|Package Manager]]</b> page.
  
 +
</u>
 +
}}
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
| series = {{{series}}}
 
| series = {{{series}}}
Line 17: Line 28:
 
==Active UPnP Redirects==
 
==Active UPnP Redirects==
  
<b>Active UPnP Redirects</b> sections allows you to manage currently active UPnP redirects.
+
The <b>Active UPnP Redirects</b> sections allows you to manage currently active UPnP redirects.
  
[[File:Network_rutx_manual_upnp_redirects_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_upnp_active_upnp_redirects.png|border|class=tlt-border]]
  
 
==MiniUPnP Settings==
 
==MiniUPnP Settings==
Line 25: Line 36:
 
===General Settings===
 
===General Settings===
 
----
 
----
 
+
[[File:Networking_rutos_manual_upnp_miniupnp_settings_general_settings.png|border|class=tlt-border]]
[[File:Network_rutx_manual_upnp_general_settings_v1.png|border|class=tlt-border]]
 
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <th>field name</th>
+
         <th>Field</th>
       <th>value</th>
+
       <th>Value</th>
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Enable</td>
 
       <td>Enable</td>
       <td>off | on; default: '''off'''</td>
+
       <td>off | on; default: <b>off</b></td>
       <td>Toggles UPnP ON or OFF.</td>
+
       <td>Turns UPnP on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Use secure mode</td>
 
       <td>Use secure mode</td>
       <td>off | on; default: '''on'''</td>
+
       <td>off | on; default: <b>on</b></td>
       <td>Toggles Secure mode ON or OFF.</td>
+
       <td>Turns secure mode on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Enable additional logging</td>
 
       <td>Enable additional logging</td>
       <td>off | on; default: '''off'''</td>
+
       <td>off | on; default: <b>off</b></td>
 
       <td>Puts extra debugging information into the system log when enabled.</td>
 
       <td>Puts extra debugging information into the system log when enabled.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Downlink</td>
 
       <td>Downlink</td>
       <td>integer; default: '''1024'''</td>
+
       <td>integer; default: <b>1024</b></td>
 
       <td>Bandwidth available for traffic coming in from the external interface in kilobytes per second. Note that this only information given to clients, it doesn't control the speed.</td>
 
       <td>Bandwidth available for traffic coming in from the external interface in kilobytes per second. Note that this only information given to clients, it doesn't control the speed.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Uplink</td>
 
       <td>Uplink</td>
       <td>integer; default: '''512'''</td>
+
       <td>integer; default: <b>512</b></td>
 
       <td>Bandwidth available for traffic out the external interface in kilobytes per second. Note that this only information given to clients, it doesn't control the speed.</td>
 
       <td>Bandwidth available for traffic out the external interface in kilobytes per second. Note that this only information given to clients, it doesn't control the speed.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Port</td>
 
       <td>Port</td>
       <td>integer [1..65535]; default: '''5000'''</td>
+
       <td>integer [1..65535]; default: <b>5000</b></td>
       <td>Toggles Secure mode ON or OFF.</td>
+
       <td>Port to listen for incomming requests.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
Line 68: Line 78:
 
===Advanced Settings===
 
===Advanced Settings===
 
----
 
----
 
+
[[File:Networking_rutos_manual_upnp_miniupnp_settings_advanced_settings.png|border|class=tlt-border]]
[[File:Network_rutx_manual_upnp_advanced_settings_v2.png|border|class=tlt-border]]
 
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <th>field name</th>
+
         <th>Field</th>
       <th>value</th>
+
       <th>Value</th>
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Report system instead of daemon uptime</td>
 
       <td>Report system instead of daemon uptime</td>
       <td>off | on; default: '''on'''</td>
+
       <td>off | on; default: <b>on</b></td>
 
       <td>If enabled, system service uptime is reported.</td>
 
       <td>If enabled, system service uptime is reported.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
       <td>Device UUID</td>
 
       <td>Device UUID</td>
       <td>string; default: '''unique'''</td>
+
       <td>string; default: <b>unique</b></td>
 
       <td>The Device UUID attribute specifies and uniquely identifies a device that supports Universal Plug and Play (UPnP).</td>
 
       <td>The Device UUID attribute specifies and uniquely identifies a device that supports Universal Plug and Play (UPnP).</td>
 
     </tr>
 
     </tr>
Line 119: Line 128:
 
     <tr>
 
     <tr>
 
     <td>UPnP lease file</td>
 
     <td>UPnP lease file</td>
         <td>string; default: '''/var/run/miniupnpd.leases'''</td>
+
         <td>string; default: <b>/var/run/miniupnpd.leases</b></td>
 
         <td>Stores active UPnP redirects in a lease file (specified), like DHCP leases.</td>
 
         <td>Stores active UPnP redirects in a lease file (specified), like DHCP leases.</td>
 
     </tr>
 
     </tr>
Line 126: Line 135:
 
==MiniUPnP ACLs==
 
==MiniUPnP ACLs==
  
ACLs specify which external ports may be redirected to which internal addresses and ports.  
+
<b>ACLs</b> specify which external ports may be redirected to which internal addresses and ports.
There are two preconfigured rules, one to allow high ports, and another to deny the rest.  
+
 
Highest priority is at the top of a list and goes down. To add another specific rule press 'Add' button.
+
There are two preconfigured rules, one to allow high ports, and another to deny the rest. Highest priority is at the top of a list and goes down. To add another specific rule, click the 'Add' button.
  
[[File:Network_rutx_manual_upnp_upnp_acls_v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_upnp_miniupnp_acls.png|border|class=tlt-border]]
  
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
         <th>field name</th>
+
         <th>Field</th>
       <th>value</th>
+
       <th>Value</th>
       <th>description</th>
+
       <th>Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 160: Line 169:
 
     <tr>
 
     <tr>
 
     <td>Action</td>
 
     <td>Action</td>
         <td>allow | deny; default: '''allow'''</td>
+
         <td>allow | deny; default: <b>allow</b></td>
 
         <td>Allows or forbids the UPnP service to open the specified port.</td>
 
         <td>Allows or forbids the UPnP service to open the specified port.</td>
 
     </tr>
 
     </tr>

Latest revision as of 10:59, 19 May 2022

The information in this page is updated in accordance with firmware version [[Media:{{{series}}}_R_00.07.02.7_WEBUI.bin|{{{series}}}_R_00.07.02.7]].


Summary

UPnP (Universal Plug and Play) is a service that allows clients in the local network to automatically configure some devices and services.

This chapter of the user manual provides an overview of the UPnP page in {{{name}}} devices.

Note: UPNP is additional software that can be installed from the Services → [[{{{name}}} Package Manager|Package Manager]] page.

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Basic" button under "Mode", which is located at the top-right corner of the WebUI.

[[File:Networking_{{{series}}}_manual_webui_basic_advanced_mode.gif|border|class=tlt-border]]

Active UPnP Redirects

The Active UPnP Redirects sections allows you to manage currently active UPnP redirects.

Networking rutos manual upnp active upnp redirects.png

MiniUPnP Settings

General Settings


Networking rutos manual upnp miniupnp settings general settings.png

Field Value Description
Enable off | on; default: off Turns UPnP on or off.
Use secure mode off | on; default: on Turns secure mode on or off.
Enable additional logging off | on; default: off Puts extra debugging information into the system log when enabled.
Downlink integer; default: 1024 Bandwidth available for traffic coming in from the external interface in kilobytes per second. Note that this only information given to clients, it doesn't control the speed.
Uplink integer; default: 512 Bandwidth available for traffic out the external interface in kilobytes per second. Note that this only information given to clients, it doesn't control the speed.
Port integer [1..65535]; default: 5000 Port to listen for incomming requests.

Advanced Settings


Networking rutos manual upnp miniupnp settings advanced settings.png

Field Value Description
Report system instead of daemon uptime off | on; default: on If enabled, system service uptime is reported.
Device UUID string; default: unique The Device UUID attribute specifies and uniquely identifies a device that supports Universal Plug and Play (UPnP).
Announced serial number string; default: none Specifies serial number for XML Root Desc.
Announced model number string; default: none Specifies model number for XML Root Desc.
Notify interval integer; default: none Interval in which UPnP capable devices send a message to announce their services.
Clean ruler threshold integer; default: none Minimum number of redirections before clearing rules table of old (active) redirections.
Clean ruler interval integer; default: none Number of seconds before cleaning redirections.
Presentation URL string; default: none Presentation url used for the Root Desc.
UPnP lease file string; default: /var/run/miniupnpd.leases Stores active UPnP redirects in a lease file (specified), like DHCP leases.

MiniUPnP ACLs

ACLs specify which external ports may be redirected to which internal addresses and ports.

There are two preconfigured rules, one to allow high ports, and another to deny the rest. Highest priority is at the top of a list and goes down. To add another specific rule, click the 'Add' button.

Networking rutos manual upnp miniupnp acls.png

Field Value Description
Comment string; default: none Adds a comment to this rule.
External ports integer [0..65535] | range of integers [0-65535]; default: none External port(s) which may be redirected. May be specified as a single port or a range of ports. To specify a range use a dash ('-') symbol between two integer numbers.
Internal Addresses ip/integer [0..32]; default: none Internal address to be redirect to.
Internal ports integer [0..65535] | range of integers [0-65535]; default: none Internal port(s) to be redirect to May be specified as a single port or a range of ports. To specify a range use a dash ('-') symbol between two integer numbers.
Action allow | deny; default: allow Allows or forbids the UPnP service to open the specified port.

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