Template:Networking rut manual upnp: Difference between revisions

From Teltonika Networks Wiki
VisualWikitext
No edit summary
No edit summary
 
(32 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template: Networking_rutxxx_manual_fw_disclosure
| fw_version = {{#switch: {{{series}}}
  | RUT2XX = {{{series}}}_R_00.01.14.3
  | RUT9XX = {{{series}}}_R_00.06.08.2}}
}}
==Summary==
==Summary==


'''UPnP''' allows clients in the local network to automatically configure the router. This chapter is a summary of the UPnP function in RUT routers
<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.
 
This chapter of the user manual provides an overview of the UPnP page in {{{name}}} devices.


{{Template: Networking_rutxxx_manual_fw_disclosure
{{Template: Networking_rutos_manual_package_disclosure
| fw_version = {{{fw_version}}}
| name    = {{{name}}}
| series  = {{{series}}}
| package = UPnP
}}
}}


==Active UPnP Redirects==
==Active UPnP Redirects==


[[File:{{{file_redirects}}}|border|class=tlt-border]]
In this table you can see all currently active UPnP redirects.
123
 
[[File:Networking_rut2xx_manual_upnp_redirects_v2.png|border|class=tlt-border]]


==General Settings==
==General Settings==


[[File:{{{file_settings1}}}|border|class=tlt-border]]
[[File:Networking_rut2xx_manual_upnp_settings1_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>
      <td>Enabled</td>
      <td>yes | no; default: <b>no</b></td>
      <td>Toggles UPnP on or off.</td>
    </tr>
    <tr>
      <td>Enable secure mode</td>
      <td>yes | no; default: <b>yes</b></td>
      <td>Toggles secure mode on or off.</td>
    </tr>
    <tr>
      <td>Enable additional logging</td>
      <td>yes | no; default: <b>no</b></td>
      <td>Puts extra debugging information into the system log.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Enable</td>
       <td>Downlink</td>
       <td>yes {{!}} no; Default: '''no'''</td>
       <td>integer; default: <b>1024</b></td>
       <td>Toggles UPnP ON or OFF</td>
       <td>Bandwidth available for traffic coming in from the external interface in kbit/s. Note that this only information given to clients, it doesn't control the speed. In order to control the speed, you can try configuring [[{{{name}}}_QoS#QoS|QoS]].</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Use secure mode</td>
       <td>Uplink</td>
       <td>yes {{!}} no; Default: '''yes'''</td>
       <td>integer; default: <b>512</b></td>
       <td>Toggles Secure mode ON or OFF</td>
      <td>Bandwidth available for traffic out the external interface in kbit/s. Note that this only information given to clients, it doesn't control the speed. In order to control the speed, you can try configuring [[{{{name}}}_QoS#QoS|QoS]].</td>
    </tr>
    <tr>
      <td>Port</td>
      <td>integer [1..65535]; default: <b>5000</b></td>
       <td>Port to listen for requests.</td>
     </tr>
     </tr>
</table>
</table>
Line 36: Line 66:
==Advanced Settings==
==Advanced Settings==


[[File:{{{file_settings2}}}|border|class=tlt-border]]
[[File:Networking_rut2xx_manual_upnp_settings2_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>Use UPnP port mapping</td>
       <td>Report system instead of daemon uptime</td>
       <td>yes {{!}} no; Default: '''yes'''</td>
       <td>yes | no; default: <b>yes</b></td>
       <td>Toggles UPnP port napping ON or OFF</td>
       <td>Use system uptime as UPnP uptime.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Use NAT-PMP port mapping</td>
       <td>Device UUID</td>
       <td>yes {{!}} no; Default: '''yes'''</td>
       <td>string; default: <b>unique</b></td>
       <td>Toggles NAT-PMP port mapping ON or OFF</td>
       <td>The Device UUID attribute specifies and uniquely identifies a device that supports Universal Plug and Play (UPnP).</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Device UUID</td>
      <td>Announced serial number</td>
         <td>yes {{!}} no; Default: '''yes'''</td>
      <td>string; Default: <b>none</b></td>
         <td>Specify Universal unique ID of the device</td>
      <td>Specifies serial number for XML Root Desc.</td>
    </tr>
    <tr>
     <td>Announced model number</td>
         <td>string; Default: <b>none</b></td>
         <td>Specifies model number for XML Root Desc.</td>
    </tr>
    <tr>
    <td>Notify interval</td>
        <td>integer; Default: <b>none</b></td>
        <td>Interval in which UPnP capable devices send a message to announce their services.</td>
    </tr>
    <tr>
    <td>Clean ruler threshold</td>
        <td>integer; Default: <b>none</b></td>
        <td>Minimum number of redirections before clearing rules table of old (active) redirections.</td>
    </tr>
    <tr>
    <td>Clean ruler interval</td>
        <td>integer; Default: <b>none</b></td>
        <td>Number of seconds before cleaning redirections.</td>
    </tr>
    <tr>
    <td>Presentation URL</td>
        <td>string; Default: <b>none</b></td>
        <td>Presentation url used for the Root Desc.</td>
    </tr>
    <tr>
    <td>UPnP lease file</td>
        <td>string; default: <b>/var/upnp.leases</b></td>
        <td>Stores active UPnP redirects in a lease file (specified), like DHCP leases.</td>
     </tr>
     </tr>
</table>
</table>


==UPnP ACLs==
==UPnP ACLs==


ACLs specify which external ports may be redirected to which internal addresses and ports
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 press add button


[[File:{{{file_ACLs}}}|border|class=tlt-border]]
[[File:Networking_rut2xx_manual_upnp_acls_v2.png|border|class=tlt-border]]


<table class="nd-mantable">
<table class="nd-mantable">
     <tr>
     <tr>
         <th>field name</th>
         <th>Field name</th>
       <th>value</th>
       <th>Value</th>
       <th>description</th>
       <th>Description</th>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>Comment</td>
       <td>Comment</td>
       <td>string; Default: '''Allow high ports'''</td>
       <td>string; default: <b>none</b></td>
       <td>Adds a comment to this rule</td>
       <td>Adds a comment to this rule.</td>
     </tr>
     </tr>
     <tr>
     <tr>
       <td>External ports</td>
       <td>External ports</td>
       <td>integer [0..65535]] {{!}} range of integers [0-65535]; Default: '''1024-65535'''</td>
       <td>integer [0..65535] | range of integers [0-65535]; default: <b>none</b></td>
       <td>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</td>
       <td>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.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Internal Addresses</td>
     <td>Internal Addresses</td>
         <td>ip/integer [0..32]; Default: '''0.0.0.0/0'''</td>
         <td>ip/integer [0..32]; default: <b>none</b></td>
         <td>Internal address to be redirect to</td>
         <td>Internal address to redirect to.</td>
     </tr>
     </tr>
     <tr>
     <tr>
     <td>Internal ports</td>
     <td>Internal ports</td>
         <td>integer [0..65535]] {{!}} range of integers [0-655355]; Default: '''1024-65535'''</td>
         <td>integer [0..65535] | range of integers [0-655355]; default: <b>none</b></td>
         <td>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</td>
         <td>Internal port(s) to 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.</td>
     </tr>
     </tr>
     <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>
</table>
</table>
[[Category:{{{name}}} Services section]]

Latest revision as of 13:43, 19 August 2021

The information in this page is updated in accordance with the [[Media:_WEBUI.bin|]] firmware version.

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.

UPnP is additional software that can be installed from the System → [[{{{name}}} Package Manager|Package Manager]] page.

Active UPnP Redirects

In this table you can see all currently active UPnP redirects.

General Settings

Field Value Description
Enabled yes | no; default: no Toggles UPnP on or off.
Enable secure mode yes | no; default: yes Toggles secure mode on or off.
Enable additional logging yes | no; default: no Puts extra debugging information into the system log.
Downlink integer; default: 1024 Bandwidth available for traffic coming in from the external interface in kbit/s. Note that this only information given to clients, it doesn't control the speed. In order to control the speed, you can try configuring [[{{{name}}}_QoS#QoS|QoS]].
Uplink integer; default: 512 Bandwidth available for traffic out the external interface in kbit/s. Note that this only information given to clients, it doesn't control the speed. In order to control the speed, you can try configuring [[{{{name}}}_QoS#QoS|QoS]].
Port integer [1..65535]; default: 5000 Port to listen for requests.

Advanced Settings

Field Value Description
Report system instead of daemon uptime yes | no; default: yes Use system uptime as UPnP uptime.
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/upnp.leases Stores active UPnP redirects in a lease file (specified), like DHCP leases.

UPnP 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 press add button

Field name 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 redirect to.
Internal ports integer [0..65535] | range of integers [0-655355]; default: none Internal port(s) to 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]]

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