Changes

no edit summary
Line 1: Line 1: −
<!-- Template uses {{{name}}}, {{{series}}}, and if device doesnt have mobile then {{{mobile}}} = 0-->
+
<!-- Template uses {{{name}}}, {{{series}}}, and if device doesn't have mobile then {{{mobile}}} = 0-->
{{Template:Networking_rutos_manual_fw_disclosure
+
| fw_version = {{{series}}}{{#ifeq:{{{name}}}|RUT241|M|}}_R_00.07.01
| fw_version = {{{series}}}_R_00.02.05
   
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
 
+
{{#ifeq: {{{series}}} | RUT9 |<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT9XX_R_00.06.08.5 and earlier) user manual page.</i>|}}
 +
{{#ifeq: {{{series}}} | RUT2 |
 +
{{#switch: {{{name}}}
 +
  | RUT241 =
 +
  | #default =
 +
<br><i><b>Note</b>: <b>[[{{{name}}} SNMP (legacy WebUI)|click here]]</b> for the old style WebUI (FW version RUT2XX_R_00.01.14.4 and earlier) user manual page.</i>}}
 +
|}}
 
==Summary==
 
==Summary==
    
<b>Simple Network Management Protocol (SNMP)</b> is a network management protocol used for collecting information and configuring network devices. This page is an overview of the SNMP function in {{{name}}} devices.
 
<b>Simple Network Management Protocol (SNMP)</b> is a network management protocol used for collecting information and configuring network devices. This page is an overview of the SNMP function in {{{name}}} devices.
 +
{{#ifeq: {{{series}}} | RUTX | |
 +
<u><b>
    +
Note:</b> SNMP 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 38: Line 48:  
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
         <td>Protocol</td>
+
         <td>IP family</td>
         <td>UDP | TCP; default: '''UDP'''</td>
+
         <td>IPv4 | IPv6 | IPv4v6; default: '''IPv4'''</td>
         <td>SNMP service's protocol.</td>
+
         <td>IP family used by SNMP.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 207: Line 217:  
         <td>ip; default: <b>none</b></td>
 
         <td>ip; default: <b>none</b></td>
 
         <td>Netmask for IP of the community.</td>
 
         <td>Netmask for IP of the community.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Access Mode</td>
 +
        <td>Read-Only | Read-Write; default: <b>Read-Only</b></td>
 +
        <td>Access mode for current community.</td>
 +
    </tr>
 +
</table>
 +
 +
SNMPv6 community configuration page:
 +
 +
[[File:Networking_rutos_manual_snmp_communities_snmpv6_community_configuration.png|border|class=tlt-border]]
 +
 +
<table class="nd-mantable">
 +
    <tr>
 +
        <th>Field</th>
 +
        <th>Value</th>
 +
        <th>Description</th>
 +
    </tr>
 +
    <tr>
 +
        <td>Community name</td>
 +
        <td>string; default: <b>none</b></td>
 +
        <td>Name of the community.</td>
 +
    </tr>
 +
    <tr>
 +
        <td>Source</td>
 +
        <td>ip6 | domain name; default: <b>default</b></td>
 +
        <td>Source of the community.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 273: Line 310:     
[[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_add_button.png|border|class=tlt-border]]
 
[[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_add_button.png|border|class=tlt-border]]
  −
You can then edit the trap rule by clicking the 'Edit' button next to it.
  −
  −
[[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_edit_button.png|border|class=tlt-border]]
      
You should be redirected to the rule's configuration page which should look something like this:
 
You should be redirected to the rule's configuration page which should look something like this:
Line 359: Line 392:  
     <tr>
 
     <tr>
 
         <td>Input/Output name</td>
 
         <td>Input/Output name</td>
         <td>Input(3) {{!}} Output(4); default: <b>Input(3)</b></td>
+
         <td>Output(4) {{!}} Input(3); default: <b>Output(4)</b></td>
 
         <td>Which type of Inputs and Outputs to use in this rule.</td>
 
         <td>Which type of Inputs and Outputs to use in this rule.</td>
 
     </tr>
 
     </tr>
Line 465: Line 498:  
             <td>Active {{!}} Inactive {{!}} Both; default: <b>Active</b></td>
 
             <td>Active {{!}} Inactive {{!}} Both; default: <b>Active</b></td>
 
             <td>On which Input/Output state will this rule be triggered.</td>
 
             <td>On which Input/Output state will this rule be triggered.</td>
 +
        </tr>}}
 +
|RUT36X =
 +
        <tr>
 +
            <td>Input/Output type</td>
 +
            <td>Input/Output; default: <b>Input/Output</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td>Input/Output name</td>
 +
            <td>Input(3) {{!}} Output(4); default: <b>Input(3)</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td>State change</td>
 +
            <td>Active {{!}} Inactive {{!}} Both; default: <b>Active</b></td>
 +
            <td>On which Input/Output state will this rule be triggered.</td>
 +
        </tr>
 +
|RUT9 =
 +
    {{#ifeq:{{{name}}}|RUT955|
 +
        <tr>
 +
            <td>Input/Output type</td>
 +
            <td><span style="color:blue">Input/Output</span> {{!}} <span style="color:forestgreen"><b>Relay</b></span> {{!}} <span style="color:darkred"><b>4–20 mA Current Loop</b></span> {{!}} <span style="color:chocolate">ADC</span>; default: <b>Input/Output</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:blue">Input/Output:</span> Input/Output name</td>
 +
            <td>Input (3) {{!}} Input (1) {{!}} Output(4) {{!}} Isolated Output (3,4,8) {{!}} Isolate Input (2,7); default: <b>Input (3)</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:blue">Input/Output:</span> State change</td>
 +
            <td>Active {{!}} Inactive {{!}} Both; default: <b>Active</b></td>
 +
            <td>On which Input/Output state will this rule be triggered.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:forestgreen">Relay:</span> Input/Output name</td>
 +
            <td>Relay(5,10); default: <b>Relay(5,10)</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:forestgreen">Relay:</span> State change</td>
 +
            <td>Open {{!}} Closed {{!}} Both; default: <b>Open</b></td>
 +
            <td>On which Input/Output state will this rule be triggered.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:darkred">4–20 mA Current Loop:</span> Input/Output name</td>
 +
            <td>Analog Current Loop (6,9); default: <b>Analog Current Loop (6,9)</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:darkred">4–20 mA Current Loop:</span> Voltage</td>
 +
            <td>positive float [0..40]; default: <b>none</b></td>
 +
            <td>At which voltage value will this rule be triggered.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:chocolate">ADC:</span> Input/Output name</td>
 +
            <td>Analog Input (6,9); default: <b>Analog Input (6,9)</b></td>
 +
            <td>Which type of Inputs and Outputs to use in this rule.</td>
 +
        </tr>
 +
        <tr>
 +
            <td><span style="color:chocolate">ADC:</span> Voltage</td>
 +
            <td>positive float [0..40]; default: <b>none</b></td>
 +
            <td>At which voltage value will this rule be triggered.</td>
 
         </tr>
 
         </tr>
|RUT3 =
+
    |
 
         <tr>
 
         <tr>
 
             <td>Input/Output type</td>
 
             <td>Input/Output type</td>
Line 524: Line 620:  
         <td>.1.3.6.1.4.1.48690.1.5.0</td>
 
         <td>.1.3.6.1.4.1.48690.1.5.0</td>
 
         <td>Device hardware revision</td>
 
         <td>Device hardware revision</td>
     </tr>
+
     </tr>{{#ifeq: {{{mobile}}} | 1 |
 
     <tr>
 
     <tr>
 
         <th>Mobile</th>
 
         <th>Mobile</th>
 
         <th></th>
 
         <th></th>
 
         <th></th>
 
         <th></th>
 +
    </tr>
 +
    <tr>
 +
        <td>modemNum</td>
 +
        <td>.1.3.6.1.4.1.48690.2.1.0</td>
 +
        <td>The number of modems (regardless of their current state) present on this system</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mIndex</td>
 
         <td>mIndex</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.1</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.1.1</td>
 
         <td>Available modem indexes; used to index OIDs between when the device has multiple modems</td>
 
         <td>Available modem indexes; used to index OIDs between when the device has multiple modems</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mDescr</td>
 
         <td>mDescr</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.2</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.2.1</td>
 
         <td>Modem description</td>
 
         <td>Modem description</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mImei</td>
 
         <td>mImei</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.3</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.3.1</td>
 
         <td>Modem IMEI</td>
 
         <td>Modem IMEI</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mModel</td>
 
         <td>mModel</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.4</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.4.1</td>
 
         <td>Modem model</td>
 
         <td>Modem model</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mManufacturer</td>
 
         <td>mManufacturer</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.5</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.5.1</td>
 
         <td>Modem manufacturer</td>
 
         <td>Modem manufacturer</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mRevision</td>
 
         <td>mRevision</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.6</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.6.1</td>
 
         <td>Modem firmware version</td>
 
         <td>Modem firmware version</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mSerial</td>
 
         <td>mSerial</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.7</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.7.1</td>
 
         <td>Modem serial number</td>
 
         <td>Modem serial number</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mIMSI</td>
 
         <td>mIMSI</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.8</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.8.1</td>
 
         <td>Modem IMSI number</td>
 
         <td>Modem IMSI number</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mSimState</td>
 
         <td>mSimState</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.9</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.9.1</td>
 
         <td>SIM card status</td>
 
         <td>SIM card status</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mPinState</td>
 
         <td>mPinState</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.10</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.10.1</td>
 
         <td>PIN status</td>
 
         <td>PIN status</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mNetState</td>
 
         <td>mNetState</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.11</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.11.1</td>
 
         <td>Mobile network registration status</td>
 
         <td>Mobile network registration status</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mSignal</td>
 
         <td>mSignal</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.12</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.12.1</td>
 
         <td>Signal strength level</td>
 
         <td>Signal strength level</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mOperator</td>
 
         <td>mOperator</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.13</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.13.1</td>
 
         <td>Current mobile network operator</td>
 
         <td>Current mobile network operator</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mOperatorNumber</td>
 
         <td>mOperatorNumber</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.14</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.14.1</td>
 
         <td>Mobile operator number (MCC+MNC)</td>
 
         <td>Mobile operator number (MCC+MNC)</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mConnectionState</td>
 
         <td>mConnectionState</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.15</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.15.1</td>
 
         <td>Mobile data connection state</td>
 
         <td>Mobile data connection state</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mConnectionType</td>
 
         <td>mConnectionType</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.16</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.16.1</td>
 
         <td>Mobile data connection type</td>
 
         <td>Mobile data connection type</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mTemperature</td>
 
         <td>mTemperature</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.17</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.17.1</td>
 
         <td>Modem's temperature in 0.1 degrees Celsius</td>
 
         <td>Modem's temperature in 0.1 degrees Celsius</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mCellID</td>
 
         <td>mCellID</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.18</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.18.1</td>
 
         <td>Cell (Base transceiver station) ID</td>
 
         <td>Cell (Base transceiver station) ID</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mSINR</td>
 
         <td>mSINR</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.19</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.19.1</td>
 
         <td>SINR value in dB</td>
 
         <td>SINR value in dB</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mRSRP</td>
 
         <td>mRSRP</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.20</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.20.1</td>
 
         <td>RSRP value in dBm</td>
 
         <td>RSRP value in dBm</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>mRSRQ</td>
 
         <td>mRSRQ</td>
         <td>.1.3.6.1.4.1.48690.2.2.1.21</td>
+
         <td>.1.3.6.1.4.1.48690.2.2.1.21.1</td>
 
         <td>RSRQ value in dB</td>
 
         <td>RSRQ value in dB</td>
     </tr>
+
     </tr>|}}{{#ifeq: {{{gps}}} | 1 |
 
     <tr>
 
     <tr>
 
         <th>GPS</th>
 
         <th>GPS</th>
Line 665: Line 766:  
         <td>.1.3.6.1.4.1.48690.3.5.0</td>
 
         <td>.1.3.6.1.4.1.48690.3.5.0</td>
 
         <td>Number of available GPS satelites</td>
 
         <td>Number of available GPS satelites</td>
     </tr>
+
     </tr>|}}{{#ifeq: {{{hotspot}}} | 1 |
 
     <tr>
 
     <tr>
 
         <th>Hotspot</th>
 
         <th>Hotspot</th>
Line 703: Line 804:  
     <tr>
 
     <tr>
 
         <td>hssIndex</td>
 
         <td>hssIndex</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.1</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.1.1</td>
 
         <td>Connected Hotspot user indexes</td>
 
         <td>Connected Hotspot user indexes</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssMAC</td>
 
         <td>hssMAC</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.2</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.2.1</td>
 
         <td>Hotspot user MAC addresses</td>
 
         <td>Hotspot user MAC addresses</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssIP</td>
 
         <td>hssIP</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.3</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.3.1</td>
 
         <td>Hotspot user local IP addresses</td>
 
         <td>Hotspot user local IP addresses</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssID</td>
 
         <td>hssID</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.4</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.4.1</td>
 
         <td>Hotspot user session unique IDs</td>
 
         <td>Hotspot user session unique IDs</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssUsername</td>
 
         <td>hssUsername</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.5</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.5.1</td>
 
         <td>Hotspot connected user usernames</td>
 
         <td>Hotspot connected user usernames</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssState</td>
 
         <td>hssState</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.6</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.6.1</td>
 
         <td>Hotspot user session states</td>
 
         <td>Hotspot user session states</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssDwLimit</td>
 
         <td>hssDwLimit</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.7</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.7.1</td>
 
         <td>Hotspot user download limits</td>
 
         <td>Hotspot user download limits</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssUpLimit</td>
 
         <td>hssUpLimit</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.8</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.8.1</td>
 
         <td>Hotspot user upload limits</td>
 
         <td>Hotspot user upload limits</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssTimeLimit</td>
 
         <td>hssTimeLimit</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.9</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.9.1</td>
 
         <td>Hotspot user session time limit</td>
 
         <td>Hotspot user session time limit</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssIdleTimeout</td>
 
         <td>hssIdleTimeout</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.10</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.10.1</td>
 
         <td>Hotspot user maximum idle timeout values</td>
 
         <td>Hotspot user maximum idle timeout values</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssDwBandwidth</td>
 
         <td>hssDwBandwidth</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.11</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.11.1</td>
 
         <td>Hotspot user maximum download speed</td>
 
         <td>Hotspot user maximum download speed</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssUpBandwidth</td>
 
         <td>hssUpBandwidth</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.12</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.12.1</td>
 
         <td>Hotspot user maximum upload speed</td>
 
         <td>Hotspot user maximum upload speed</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>hssURL</td>
 
         <td>hssURL</td>
         <td>.1.3.6.1.4.1.48690.5.6.1.13</td>
+
         <td>.1.3.6.1.4.1.48690.5.6.1.13.1</td>
 
         <td>Hotspot URL</td>
 
         <td>Hotspot URL</td>
     </tr>
+
     </tr>|}}
 
</table>
 
</table>
 +
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Navigation menu