SiteScope User's Guide
The SiteScope SNMP Monitor reads a value from an SNMP device. Many network devices support the SNMP protocol as a way of monitoring them. You will need to know the OID's (Object ID's) for the device you want to monitor. These may be available in the product documentation or in the form of a MIB file.
Note: To have SiteScope listen for SNMP traps from multiple devices, use the SNMP Trap Monitor.
The SNMP monitor allows you to monitor devices that communicate with the SNMP protocol, such
as firewalls, routers and UPS's. Several operating systems suppliers also provide SNMP agents and Management Information Bases (MIBs) for accessing workstation or server performance metrics, interface statistics, and process tables via SNMP.
The SNMP monitor allows you to watch any values known by the SNMP agent on a device provided you can supply an OID that maps to that value. If your router supports SNMP, for example, you could have SiteScope monitor for packet errors, bandwidth, or device status.
Requirements for using the SNMP Monitor include:
In some cases, an equipment manufacturer may supply a list of OID's that are available. Otherwise, you may need to locate a MIB browser utility in order to "walk" a MIB and extract the values of interest to you.
- SNMP agents must be deployed and running on the servers and devices that you want to monitor
- The SNMP agents must be supplied with the necessary Management Information Bases (MIBs) and configured to read those MIBs
- You need to know the Object ID's (OIDs) of the parameters you want to monitor.
Completing the SNMP Monitor Form
To display the SNMP Monitor Form, either click the Edit link for an existing
SNMP Monitor in a monitor table, or click the "Add a new Monitor
to this Group" link on a group's detail page and choose the "Add SNMP
Complete the items on the SNMP Monitor form as follows. When
the required items are complete, click the "Add Monitor" button.
Enter the host name or IP address of the SNMP device that you want to monitor (for example, demo.thiscompany.com). By default, this will connect to port 161. If your SNMP device is using a different port, add it to the hostname using ":port". For example, to use port 170, you would enter demo.sitescope.com:170.
Select the Object ID mnemonic from the drop-down menu or enter the Object Identifier
(OID) for the SNMP value you want to retrieve. The OID specifies which value should be
retrieved from the device. (for example, 220.127.116.11.18.104.22.168). To troubleshooting basic
connectivity to the device and to confirm that the SNMP agent is active, select the system.sysDescr object from the drop-down list if other objects
can not be found.
Note: SiteScope version 7.1 and later supports SNMP version 1 and version 2. In order to send a trap using snmpv2, you must select the version number in the Advanced Options section.
If you receive the error message "There is no such variable name in this MIB", it
means SiteScope was able to contact the device but the OID given is not know by the device. You need to provide an OID that is valid to the device in order to obtain a value.
If you have a MIB file for the device you want to monitor, you can copy the *.mib (or *.my)
file into the SiteScope/templates.mib subdirectory and use the MIB Help utility to
compile the MIB and browse the OID's for the device. Click the MIB Help hyperlink to bring
up the MIB Helper. Select the MIB file to browse using the drop-down list. Click the
List OIDs button to show the OID's from the select MIB file
Note: it is not necessary to browse a MIB file with the SiteScope Mib Helper in order to monitor a device. The MIB Helper is provided simply as a tool to help you discover OID's available
on a device, but it is not the only tool available.
You can also check the on-line Knowledge Base avialable via the Cusotmer Support site for other information relating to monitoring SNMP systems. Also note that not all MIB files
can be browsed by the MIB Helper: the Mib Helper only supports MIB files that are version SNMP v1.
The index of the SNMP object. Values for an OID come as either scalar or indexed (array or table) values.
For a scalar OID, the index value must be set to 0. For an indexed or table value, you must provide the index (a positive integer) to the element that contains the value you want. For
example, the OID 22.214.171.124.126.96.36.199.1.17 is an indexed value that contains four elements. To access
this second element of this OID you enter an index of 2 in the Index field. To access the fourth element, enter an Index value of 4.
In some vendor specific MIB's, the indexed entries (often refered to in tables) can have compound index values. For example, the OID for the process entry table in a Sun MicroSystems server MIB may be: .188.8.131.52.184.108.40.206.12.1.1. This indexed or table object may have up to eleven nodes with OIDs ranging from .220.127.116.11.18.104.22.168.22.214.171.124 to .126.96.36.199.188.8.131.52.184.108.40.206. Each of these nodes contains an indexed list of entries with index values that range from 0 to over 27300 where the Index value represents the process ID number used by the operating system (view examples using the ps -ef command in UNIX). In this example, the index values may not be consecutive from 0 to 27300.
Enter the Community string for the SNMP device. The Community string provides a level of
security for a SNMP device. Most devices use "public" as a community string. However,
the device you are going to monitor may require a different Community string in order
to access it. You will have to find out if the device requires different string and supply
it in this field.
Enter how frequently the monitor should check this SNMP value. The pull-down
menu to the right of the text box lets you specify time increments of
seconds, minutes, hours, or days. You must specify a time increment of
at least 15 seconds.
Enter a name for this monitor. This name appears in the Name text box
on the monitor table when you open the group's detail page. If you don't
enter a name, a default name will be created.
You can also check the on-line Knowledge Base avialable via the Cusotmer Support site for other information relating to monitoring SNMP systems.
The advanced options give you the ability to customize error and warning
thresholds, or set optional monitor and display settings.
Check this box to temporarily disable this monitor and any associated alerts.
To enable the monitor again, clear the box.
- SNMP Version (V1 or V2)
- Select the SNMP version used by the SNMP host you want to monitor. SiteScope supports both SNMP version 1 and version 2.
Enter the total number of seconds SiteScope should wait for a successful
- Retry Delay
Enter the number of seconds SiteScope should wait before retrying the request.
By default SiteScope will wait one second. It will continue to retry at
the interval specified here until the Timeout threshold is met.
If you choose a scaling option from the scaling drop-down list, SiteScope will divide the returned value by this factor before displaying it. Alternatively, you may specify a factor by which the value should be divided in the text box to the right of the drop-down list.
Use this item to match against an SNMP value, using a string or a regular
expression or XML names.
Enter an optional units string to append when displaying the value of this
Enter an optional text string to describe the measurement being made by the monitor.
Measure as Delta
Click this box to have SiteScope report the measurement as the difference
between the current value and the previous value.
Measure as Rate per Second
Click this box to have SiteScope divide the measurement by the number of
seconds since the last measurement.
Enter a number or SNMP object ID in this box. If entered, the measurement
will be divided by this value to calculate a percentage. If an object ID
if entered the Index from above will be used
Measure Base as Delta
Check this box to have SiteScope calculate the Percentage Base as the difference between the current base and the previous base. Use this option when an SNMP object ID is used for Percentage Base and the object is not a fixed value.
- SNMP V3 Username
- If you are using SNMP version 3, enter the username to be used for authentication. Note: SiteScope only supports MD5 authentication for SNMP V3.
- SNMP V3 Password
- If you are using SNMP version 3, enter the password to be used for authentication for SNMP V3. Note: SiteScope only supports MD5 authentication for SNMP V3.
- Verify Error
- Check this box if you want SiteScope to automatically run this monitor again if it detects an error. When an error is detected, the monitor will immediately be scheduled to run again once.
Note: In order to change the run frequency of this monitor when an error is detected, use the Update every (on errors) option below.
Note: The status returned by the Verify Error run of the monitor will replace the status of the originally scheduled run that detected an error. This may cause the loss of important performance data if the data from the verify run is different than the initial error status.
Warning: Use of this option across many monitor instances may result in significant monitoring delays in the case that multiple monitors are rescheduled to verify errors at the same time.
Update Every (on error)
This options allows you to set a new monitoring interval for monitors that
have registered an error condition. For example, you may want SiteScope
to monitor this item every 10 minutes normally, but as often as every 2
minutes if an error has been detected. Note that this increased scheduling
will also affect the number of alerts generated by this monitor.
By default, SiteScope's monitors are enabled every day of the week. You
may, however, schedule your monitors to run only on certain days or on
a fixed schedule. Choose the Edit schedule link to create or edit
a monitor schedule. For information about creating schedules, read
Monitor Description (Optional)
Enter additional information about this monitor. The Monitor Description can include HTML tags such as the <BR> <HR>, and <B> tags to control display format and style. The description will appear
on the Monitor Detail page.
Report Description (Optional)
Enter a description for this monitor that will make it easier to understand
what this monitor does. The description will appear on Management Reports
and on the info list for a monitor.
- Depends On (Optional)
- To make the running of this monitor dependent on the status of another monitor or monitor group, use the drop-down list to select the monitor or group on which this monitor is dependent. Select None to remove any dependency.
- Depends Condition (Optional)
- If you choose to make the running of this monitor dependent on the status of another monitor, choose the status condition that the other monitor or monitor group should have in order for the current monitor to run normally. The current monitor will be run normally as long as the monitor or group on which it depends reports the condition selected in this option.
List Order (Optional)
- By default, new monitors are listed last on the Monitor Detail page. You
may use this drop-down list to choose a different placement for this monitor.
By default, SiteScope generates an error if the returned status is anything
other than 'ok'. You may choose to have SiteScope generate an error based
on the SNMP value returned. Enter a comparison value and use the comparison
operator list to specify an error threshold such as: >= (greater than
or equal to), != (not equal to), or < (less than).
By default, SiteScope does not generate warnings for SNMP monitors. You
may choose to have SiteScope generate an error based on the SNMP value
SiteScope reports a good status if the reading returned is "OK". You can
change this to be based upon a specific value or a content match.
Copyright © 2003 Mercury Interactive Corporation.
All rights reserved.