Changes

Template:Networking rutos manual snmp (view source)

Revision as of 12:45, 24 August 2020

1,235 bytes added ,  12:45, 24 August 2020
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 doesnt have mobile then {{{mobile}}} = 0-->
 
{{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.05
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 7: Line 7:  
==Summary==
 
==Summary==
   −
Simple Network Management Protocol (SNMP) is a popular protocol for network management.
+
<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.
−
It is used for collecting information, and configuring, network devices.
  −
This section is an overview of the SNMP function in {{{name}}} devices.
  −
 
  −
You can download <b>MIB file</b> for each device in their <b>SNMP settings</b> page, at <b>SNMP System Summary</b> section.
      
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
Line 19: Line 15:  
==SNMP settings==
 
==SNMP settings==
   −
The <b>SNMP settings</b> page is used to configure SNMP accessibility and general information in your device.
+
The <b>SNMP settings</b> page is used to configure SNMP accessibility and general SNMP information for your device.
    
===SNMP agent settings===
 
===SNMP agent settings===
 
----
 
----
−
[[File:Networking rutx manual snmp agent settings v2.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_snmp_snmp_agent_settings.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 SNMP service</td>
 
         <td>Enable SNMP service</td>
−
         <td>off | on; default: '''off'''</td>
+
         <td>off | on; default: <b>off</b></td>
 
         <td>Run SNMP service on system's startup.</td>
 
         <td>Run SNMP service on system's startup.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Enable remote access</td>
 
         <td>Enable remote access</td>
−
         <td>off | on; default: '''off'''</td>
+
         <td>off | on; default: <b>off</b></td>
 
         <td>Open port in firewall so that SNMP service may be reached from WAN.</td>
 
         <td>Open port in firewall so that SNMP service may be reached from WAN.</td>
 
     </tr>
 
     </tr>
Line 62: Line 59:  
     <tr>
 
     <tr>
 
         <td>SNMP v3 Mode</td>
 
         <td>SNMP v3 Mode</td>
−
         <td>off | on; default: '''off'''</td>
+
         <td>off | on; default: <b>off</b></td>
 
         <td>Enable/disable SNMP v3 Mode.</td>
 
         <td>Enable/disable SNMP v3 Mode.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
−
===SNMP system summary===
+
 
 +
===SNMP System Summary===
 
----
 
----
−
[[File:Networking rutx manual snmp system summary v2.png|border|class=tlt-border]]
+
The <b<SNMP System Summary</b> section contains general information about SNMP on this device. You can also download this device's <b>MIB file</b> from this section.
 +
 
 +
[[File:Networking_rutos_manual_snmp_snmp_system_summary.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>MIB file</td>
 
         <td>MIB file</td>
 
         <td>-(interactive button)</td>
 
         <td>-(interactive button)</td>
−
         <td>Downloads device MIB file.</td>
+
         <td>Downloads the device's MIB file.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 87: Line 88:  
     <tr>
 
     <tr>
 
         <td>Location</td>
 
         <td>Location</td>
−
         <td>string; default: '''location'''</td>
+
         <td>string; default: <b>location</b></td>
 
         <td>Trap named sysLocation.</td>
 
         <td>Trap named sysLocation.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Contact</td>
 
         <td>Contact</td>
−
         <td>string; default: '''[email protected]'''</td>
+
         <td>string; default: <b>[email protected]</b></td>
 
         <td>Trap named sysContact.</td>
 
         <td>Trap named sysContact.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
 
         <td>Name</td>
 
         <td>Name</td>
−
         <td>string; default: '''name'''</td>
+
         <td>string; default: <b>name</b></td>
 
         <td>Trap named sysName.</td>
 
         <td>Trap named sysName.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 
==SNMP v3 users==
 
==SNMP v3 users==
   −
The <b>SNMP v3 users</b> page is used to create and manage users, who can be authenticated using SNMP v3.  
+
The <b>SNMP v3 users</b> page is used to create and manage users, who can be authenticated using SNMP v3. To configure an SNMP user, you must first create it:
−
Create a User by simply writing a name and pressing '''Add''' button.
     −
[[File:Networking rutx manual snmp users v2.png|border|class=tlt-border]]
+
<ol>
 +
    <li>Enter a custom name for the new user in the 'Name' field.</li>
 +
    <li>Click the 'Add' button.</li>
 +
    <li>Click the 'Edit' button next to the newly created user.</li>
 +
</ol>
 +
[[File:Networking_rutos_manual_snmp_snmp_v3_users_add_button.png|border|class=tlt-border]]
 +
----
 +
The SNMP user configuration window should look like this:
   −
You can modify User settings by pressing [[File:Networking_rutx_manual_edit_button_v1.png]] '''Edit''' button.
+
[[File:Networking_rutos_manual_snmp_snmp_v3_users_snmp_user_configuration.png|border|class=tlt-border]]
   −
[[File:Networking rutx manual snmp user edit 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>Enable </td>
 
         <td>Enable </td>
−
         <td>off | on; default: '''off'''</td>
+
         <td>off | on; default: <b>off</b></td>
−
         <td>Enable or disable user.</td>
+
         <td>Turns this SNMP user on or off.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 142: Line 150:  
     <tr>
 
     <tr>
 
         <td><span style="color:blue">Authentication, no privacy </span>{{!}} <span style="color:red">Authentication and privacy:</span> Authentication passphrase</td>
 
         <td><span style="color:blue">Authentication, no privacy </span>{{!}} <span style="color:red">Authentication and privacy:</span> Authentication passphrase</td>
−
         <td>string; default: '''none'''</td>
+
         <td>string; default: <b>none</b></td>
 
         <td>Set authentication passpharse to generate key for SNMP v3.</td>
 
         <td>Set authentication passpharse to generate key for SNMP v3.</td>
 
     </tr>
 
     </tr>
Line 152: Line 160:  
     <tr>
 
     <tr>
 
         <td><span style="color:red">Authentication and privacy:</span> Privacy passphrase</td>
 
         <td><span style="color:red">Authentication and privacy:</span> Privacy passphrase</td>
−
         <td>string; default: '''none'''</td>
+
         <td>string; default: <b>none</b></td>
 
         <td>Set privacy passpharse to generate key for SNMP v3.</td>
 
         <td>Set privacy passpharse to generate key for SNMP v3.</td>
 
     </tr>
 
     </tr>
Line 162: Line 170:  
     <tr>
 
     <tr>
 
         <td>MIB subtree</td>
 
         <td>MIB subtree</td>
−
         <td>string; default: '''none'''</td>
+
         <td>string; default: <b>none</b></td>
 
         <td>Leave empty to access full MIB tree.</td>
 
         <td>Leave empty to access full MIB tree.</td>
 
     </tr>
 
     </tr>
Line 171: Line 179:  
==Communities==
 
==Communities==
   −
In SNMP community page you can manage access rights.
+
The <b>SNMP Community</b> section is used to manage access rights. You can edit an SNMP community by clicking the 'Edit' button next to it:
 +
 
 +
[[File:Networking_rutos_manual_snmp_communities_edit_button.png|border|class=tlt-border]]
   −
[[File:Networking rutx manual snmp community v2.png|border|class=tlt-border]]
+
This will redirect you to the community's configuration page.
   −
You can access SNMP community settings by pressing [[File:Networking_rutx_manual_edit_button_v1.png]] '''Edit''' button.
+
[[File:File:Networking_rutos_manual_snmp_communities_snmp_community_configuration.png|border|class=tlt-border]]
   −
[[File:Networking rutx manual snmp community edit 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>
Line 201: Line 210:  
     <tr>
 
     <tr>
 
         <td>Access Mode</td>
 
         <td>Access Mode</td>
−
         <td>Read-Only | Read-Write; default: '''Read-Only'''</td>
+
         <td>Read-Only | Read-Write; default: <b>Read-Only</b></td>
 
         <td>Access mode for current community.</td>
 
         <td>Access mode for current community.</td>
 
     </tr>
 
     </tr>
 
</table>
 
</table>
 +
 
==Trap settings==
 
==Trap settings==
   −
SNMP Traps are used to send alert messages to a central collector, the “SNMP manager” when an important event happens. A
+
SNMP Traps are used to send alert messages to a central collector, the “SNMP manager” when an important event happens. A benefit of using Traps for reporting alarms is that they trigger instantaneously, rather than waiting for a status request from the manager.
−
benefit of using Traps for reporting alarms is that they trigger instantaneously, rather than waiting for a status
  −
request from the manager.
      
Trap settings page is divided in two sections - <b>Trap service settings</b> and <b>Trap rules</b>. Trap service settings  
 
Trap settings page is divided in two sections - <b>Trap service settings</b> and <b>Trap rules</b>. Trap service settings  
Line 216: Line 224:  
[[File:Networking rutx manual snmp trap settings v1.png|border|class=tlt-border]]
 
[[File:Networking rutx manual snmp trap settings v1.png|border|class=tlt-border]]
   −
===Configure Trap Service Settings===
+
===Trap Service Settings===
 
----
 
----
 +
To add another host click the 'Add' button at the right side of this table.
 +
 +
[[File:Networking_rutos_manual_snmp_trap_settings_trap_service_settings_add_button.png|border|class=tlt-border]]
   −
To add another host click '''Add''' button at the right side of this table.
+
The newly added Host configuration should look like this:
   −
[[File:Networking rutx manual snmp trap settings trap service v1.png|border|class=tlt-border]]
+
[[File:Networking_rutos_manual_snmp_trap_settings_trap_service_settings_configuration.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 236: Line 247:  
     <tr>
 
     <tr>
 
         <td>Port</td>
 
         <td>Port</td>
−
         <td>integer [0..65535]; default: '''162'''</td>
+
         <td>integer [0..65535]; default: <b>162</b></td>
−
         <td>Port for trap's host.</td>
+
         <td>Trap host's port number.</td>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Line 246: Line 257:  
</table>
 
</table>
   −
===Configure Trap Rules===
+
===Trap Rules===
 
----
 
----
 +
You can create a new trap rule by clicking the 'Add' button.
 +
 +
[[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|borde|class=tlt-border]]
 +
 +
You should be redirected to the rule's configuration page which should look something like this:
   −
You can edit Trap rule by pressing [[File:Networking_rutx_manual_edit_button_v1.png]] '''Edit''' button in <b>Trap settings</b> page on preferred rule.
+
[[File:Networking_rutos_manual_snmp_trap_settings_trap_rules_modify_trap_rule_mobile_{{{mobile}}}.png|border|class=tlt-border]]
   −
{{#ifeq:{{{mobile}}}|0|
+
Above is an example of what rule configuration window looks like. Below is a table with detailed explanations on how to configure the rule and what each of the fields mean.  
−
[[File:Networking rutx10 manual snmp trap settings trap rule edit v1.png|border|class=tlt-border]] <!--rutx no mobile-->
  −
|
  −
[[File:Networking rutx manual snmp trap settings trap rule edit v1.png|border|class=tlt-border]] <!--rutx mobile-->
  −
}}
     −
Above is an example of what rule configuration window looks like.
+
To avoid redundancy, screenshots for the other rules will not be provided, since the structures, syntax and the overall look of the configuration windows for each rule are very similar. Instead, only tables containing information on how to edit each rule will be provided.
−
Below is a table with detailed explanations on how to configure the rule and what each of the fields mean.
  −
To avoid redundancy, screenshots for the other rules will not be provided, since the structures,  
  −
syntax and the overall look of the configuration windows for each rule are very similar.  
  −
Instead, only tables containing information on how to edit each rule will be provided.
      
====Signal strength====
 
====Signal strength====
Line 267: Line 279:  
<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: '''on'''</td>
+
         <td>off | on; default: <b>on</b></td>
 
         <td>Enable or disable this rule.</td>
 
         <td>Enable or disable this rule.</td>
 
     </tr>
 
     </tr>
Line 287: Line 299:  
     </tr>
 
     </tr>
 
</table>
 
</table>
−
 
+
<br>
−
 
   
====Connection type====
 
====Connection type====
 
----
 
----
 
<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: '''on'''</td>
+
         <td>off | on; default: <b>on</b></td>
 
         <td>Enable or disable this rule.</td>
 
         <td>Enable or disable this rule.</td>
 
     </tr>
 
     </tr>
Line 309: Line 320:  
     </tr>
 
     </tr>
 
</table>
 
</table>
−
 
+
<br>
−
 
   
====Input/Output====
 
====Input/Output====
 
----
 
----
Line 321: Line 331:  
     <tr>
 
     <tr>
 
         <td>Enable</td>
 
         <td>Enable</td>
−
         <td>off | on; default: '''on'''</td>
+
         <td>off | on; default: <b>on</b></td>
 
         <td>Enable or disable this rule.</td>
 
         <td>Enable or disable this rule.</td>
 
     </tr>
 
     </tr>
Line 346: Line 356:  
         <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>
 
     </tr>
−
|TRB2XX =
+
|TRB2 =
 
     <tr>
 
     <tr>
 
         <td>Input/Output type</td>
 
         <td>Input/Output type</td>
Line 372: Line 382:  
         <td>At which voltage value will this rule be triggered.</td>
 
         <td>At which voltage value will this rule be triggered.</td>
 
     </tr>
 
     </tr>
−
|TRB14X =
+
|TRB1 =
 
     {{#ifeq:{{{name}}}|TRB141|
 
     {{#ifeq:{{{name}}}|TRB141|
 
         <tr>
 
         <tr>
Line 430: Line 440:  
         </tr>
 
         </tr>
 
     |
 
     |
 +
        <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>
 +
|RUT3 =
 
         <tr>
 
         <tr>
 
             <td>Input/Output type</td>
 
             <td>Input/Output type</td>
Line 450: Line 476:  
</table>
 
</table>
   −
== SNMP Variables list ==
+
==SNMP variables list==
 +
 
 
<table class="nd-mantable">
 
<table class="nd-mantable">
 
     <tr>
 
     <tr>
−
         <th style="width: 250px">NAME</th>
+
         <th style="width: 250px">Name</th>
 
         <th style="width: 250px">OID</th>
 
         <th style="width: 250px">OID</th>
−
         <th style="width: 579px">DESCRIPTION</th>
+
         <th style="width: 579px">Description</th>
 
     </tr>
 
     </tr>
 
     <tr>
 
     <tr>
Retrieved from "https://wiki.teltonika-networks.com/view/Special:MobileDiff/69516"

Navigation menu