Toolpack:Configuring tbSnmpAgent B

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "=== '''''Applies to version(s): v2.8.''''' === {{DISPLAYTITLE:Configuring the SNMP Agent}} Once you are logged into the Web Portal and have successfully activated the tbSnmpA...")
 
(added liks to missing parameters)
 
(24 intermediate revisions by one user not shown)
Line 2: Line 2:
 
{{DISPLAYTITLE:Configuring the SNMP Agent}}
 
{{DISPLAYTITLE:Configuring the SNMP Agent}}
  
Once you are logged into the Web Portal and have successfully activated the tbSnmpAgent application, follow these steps to configure the application to suit your needs:
+
Once you have successfully activated the tbSnmpAgent application, follow these steps to configure the SNMP system parameters:
==  Configuring SNMP system parameters ==
+
 
*Click '''Configurations''' in the navigation panel.
+
 
[[File:Snmp_cfg_Click_configurations.gif|border]]
+
1) Click '''Applications''' in the navigation panel.
 +
 
 +
[[Image:Snmp_cfg_0.png]]
 
<br/><br/>
 
<br/><br/>
*In the '''Application Configuration List''', find the entry for '''tbsnmpagent''' and click '''edit''', next to that entry.
+
2) In the '''Application Configuration List''', select '''tbsnmpagent'''.
[[File:Snmp_cfg_click_edit.gif|border]]
+
 
 +
[[Image:Snmp_cfg_1.png]]
 
<br/><br/>
 
<br/><br/>
<u>The tbSnmpAgent '''Application Configuration''' window is divided into several sections.</u>
+
3) Click '''Application Params'''
 +
 
 +
[[Image:Snmp_cfg_2.png]]
 +
<br/><br/>
 +
4) Enter values for the following parameters:
 +
*'''SNMP IP Port''': The '''IP port''' to use for making SNMP requests (standard default value is 161).
 +
*'''SNMP System Description''': The textual description that will appear when polling the '''sysDescr''' variable of the SNMPv2-MIB.
 +
*'''SNMP System Object ID''': The value appended to TelcoBridges' value (.1.3.6.1.4.1.21776.3) for the SNMPv2-MIB variable '''sysObjectId'''**SNMP System Name: the textual description that will appear when polling the '''sysName''' variable of the SNMPv2-MIB.
 +
*'''SNMP System Location''': The textual description that will appear when polling the '''sysLocation''' variable of the SNMPv2-MIB.
 +
*'''SNMP System Contact''': The textual description that will appear when polling the '''sysContact''' variable of the SNMPv2-MIB.<br/><br/>
 +
[[Image:Snmp_cfg_3.png]]
 +
<br/><br/>
 +
5) Click '''Advanced Params''' to view or change advanced settings for the following parameter(s):
 +
*'''Polling delay to generate traps''': Sets the length (in seconds) for the time intervals at which the SNMP agent polls for newly generated traps.
 +
*'''Use system names''': Indicates that SNMP uses the names interfaces of the system instead of the names interfaces generated by adapters.
 +
 
 +
[[Image:Snmp_cfg_4.png]]
 +
<br/><br/>
 +
*Click '''Save'''
 +
 
 +
[[Image:Snmp_cfg_5.png]]
 +
<br/><br/>
 +
6) Verify that the '''ApplicationCfg was sucessfully updated''' message is displayed.
 +
 
 +
[[Image:Snmp_cfg_6.png]]
 +
 
 +
==List of Parameters==
 +
 
 +
* [[Parameter: Application Type|Application Type]]
 +
* [[Parameter: Name|Name]]
 +
* [[Parameter: Bin Path|Bin Path]]
 +
* [[Parameter: Location|Location]]
 +
* [[Parameter: Working Path|Working Path]]
 +
* [[Parameter: Commadn-line arguments|Command-line arguments]]
 +
 
 +
<br>
 +
 
 +
<div class="mw-collapsible mw-collapsed" data-collapsetext="Application Parameters" data-expandtext="Application Parameters" style="width: 400px;">
 +
{| class="wikitable"
 +
|-
 +
* [[Parameter: SNMP IP port|SNMP IP port]]
 +
* [[Parameter: SNMP System Description|SNMP System Description]]
 +
* [[Parameter: SNMP System Object ID|SNMP System Object ID]]
 +
* [[Parameter: SNMP System Name|SNMP System Name]]
 +
* [[Parameter: SNMP System Location|SNMP System Location]]
 +
* [[Parameter: SNMP System Contact|SNMP System Contact]]
  
#Under the '''Application Params''' heading, the following general application parameters can be configured:
+
* Advanced SNMP Parameters
#*SNMP IP Port: the '''IP port''' to use for making SNMP requests (standard default value is 161)
+
** [[Parameter: Polling delay to generate Traps|Polling delay to generate Traps]]
#*SNMP System Description: the textual description that will appear when polling the '''sysDescr''' variable of the SNMPv2-MIB
+
** [[Parameter: Use system names|Use system names]]
#*SNMP System Object ID: the value appended to TelcoBridges' value (.1.3.6.1.4.1.21776.3) for the SNMPv2-MIB variable '''sysObjectId'''
+
#*SNMP System Name: the textual description that will appear when polling the '''sysName''' variable of the SNMPv2-MIB
+
#*SNMP System Location: the textual description that will appear when polling the '''sysLocation''' variable of the SNMPv2-MIB
+
#*SNMP System Contact: the textual description that will appear when polling the '''sysContact''' variable of the SNMPv2-MIB<br/><br/>[[File:Snmp_cfg_application_params.gif|border]]<br/><br/>
+
#Under the '''Advanced Params''' heading, the following general application parameter can be configured:
+
#*Polling delay to generate traps: this sets the length for the time intervals at which the SNMP agent polls for newly generated traps. The value entered is in seconds<br/><br/>[[File:Snmp_cfg_advanced_params.gif|border]]<br/><br/>
+
  
== Configuring SNMPv1, SNMPv2c ==
+
|}
#Under the '''SNMPv1 SNMPv2c Communities''' heading, new '''communities''' can be created for SNMP versions 1 or 2:
+
</div>
#*By default, the standard communities '''public''' (read-only access), and '''private''' (read-write access) have been created
+
#*Click [[Creating an SNMPv1/SNMPv2 Community|'''Create new community''']] to create a new community for SNMPv1, or SNMPv2<br/><br/>[[File:Snmp_cfg_communities.gif|border]]<br/><br/>
+
  
== Configuring SNMPv3  ==
+
<br>
 +
<div class="mw-collapsible mw-collapsed" data-collapsetext="Advanced Parameters" data-expandtext="Advanced Parameters" style="width: 400px;">
 +
{| class="wikitable"
 +
|-
 +
* Log Parameters
 +
** [[Parameter: Default Trace Level|Default Trace Level]]
 +
** [[Parameter: Log File Path|Log File Path]]
 +
** [[Parameter: Max Log File Segment Size|Max Log File Segment Size]]
 +
** [[Parameter: Max Total Gzipped Log Files Size|Max Total Gzipped Log Files Size]]
  
#Under the '''SNMPv3 Users''' heading, new '''users''' can be created for SNMP version 3:
+
* Network Lib Parameters
#*By default, no SNMPv3 users are created
+
** [[Parameter: Network Polling Delay|Network Polling Delay]]
#*Click [[Creating an SNMPv3 User|'''Create new SNMPv3 user''']] to create a new user definition for SNMPv3<br><br>[[Image:Snmp cfg create user.gif|border]]<br>
+
** [[Parameter: Network Switchover Delay|Network Switchover Delay]]
 +
** [[Parameter: Communication Down Delay|Communication Down Delay]]
  
'''Note: '''If SNMPv3 is used for security reasons, SNMPv1 and SNMPv2 users should be removed completely from the configuration.<br>
+
|}
 +
</div>
  
== Configuring traps ==
+
<br>
#Under the '''SNMP Trap Destinations''' heading, destination addresses for SNMP traps can be defined:
+
#*By default, no SNMP trap destinations are defined
+
#*Click [[Creating an SNMP Trap Destination|'''Create New SNMP Trap Destination''']] to create a new destination for sending SNMP traps to<br/><br/>[[File:Snmp_cfg_create_trap.gif|border]]<br/><br/>
+
#Under the '''Log Params''' heading, logging parameters for the application can be set. The directory and format that logs are stored in can be selected.<br/><br/>
+
#Under the '''Advance Params''' heading, operational time delays ca be modified.
+

Latest revision as of 12:00, 9 June 2015

Applies to version(s): v2.8.

Once you have successfully activated the tbSnmpAgent application, follow these steps to configure the SNMP system parameters:


1) Click Applications in the navigation panel.

Snmp cfg 0.png

2) In the Application Configuration List, select tbsnmpagent.

Snmp cfg 1.png

3) Click Application Params

Snmp cfg 2.png

4) Enter values for the following parameters:

  • SNMP IP Port: The IP port to use for making SNMP requests (standard default value is 161).
  • SNMP System Description: The textual description that will appear when polling the sysDescr variable of the SNMPv2-MIB.
  • SNMP System Object ID: The value appended to TelcoBridges' value (.1.3.6.1.4.1.21776.3) for the SNMPv2-MIB variable sysObjectId**SNMP System Name: the textual description that will appear when polling the sysName variable of the SNMPv2-MIB.
  • SNMP System Location: The textual description that will appear when polling the sysLocation variable of the SNMPv2-MIB.
  • SNMP System Contact: The textual description that will appear when polling the sysContact variable of the SNMPv2-MIB.

Snmp cfg 3.png

5) Click Advanced Params to view or change advanced settings for the following parameter(s):

  • Polling delay to generate traps: Sets the length (in seconds) for the time intervals at which the SNMP agent polls for newly generated traps.
  • Use system names: Indicates that SNMP uses the names interfaces of the system instead of the names interfaces generated by adapters.

Snmp cfg 4.png

  • Click Save

Snmp cfg 5.png

6) Verify that the ApplicationCfg was sucessfully updated message is displayed.

Snmp cfg 6.png

List of Parameters




Personal tools