Use this Knowledge Script to perform an SNMP Get or GetNext operation for one or more SNMP attributes from one or more SNMP enabled devices. This script raises an event if retrieved values exceed the threshold you set.
The script attempts to get the specified attributes on all supplied SNMP devices, regardless of whether any previous attempts failed. If failures do occur, successful gets on other devices are not discarded.
This script can independently collect separate data streams for each SNMP device/SNMP attribute pairing. Thus, the total number of data streams collected is the number of devices the script has been run on in the TreeView, multiplied by the number of SNMP attributes provided.
NOTE:Supply either all-numeric SNMP attributes or all-string SNMP attributes, because you must choose either a numeric check or string check. SNMP attributes that are octet strings, OIDs, or IP addresses are considered to be string attributes.
If one or more numerical conversions are selected, they are performed in the following order: Multiplication, Division, Delta and Percentage. If Delta and Division are both selected, integer division is performed and any remainder is discarded. If Delta is not selected, real-number division is performed.
Values reported in SNMP Success events show the results of multiplication and division conversions, but not delta and percentage conversions, as these are performed after the Success event has been raised. The final result of all conversions is shown in any threshold events, or in the data points if data is collected.
This script can be run at intervals to periodically poll SNMP attributes. However, if delta calculations are being performed on the retrieved values, the script interval should not be less than one minute, because the accuracy of delta calculations is time dependent and may not produce reliable results at shorter intervals. This is due to many factors including the accuracy of AppManager job scheduling and network traffic delay. The SyncPoll script should be used to accurately poll at intervals of less than one minute.
By default, this script retrieves sysUpTime.0 from the device, converts the retrieved value to “Days”, and reports the retrieved value in a success event.
One or more SNMP Device objects
By default, this script runs once.
Set the following parameters as needed:
|
Parameter |
How to Set It |
|---|---|
|
Get Parameters |
|
|
SNMP ODE/OIDs |
Supply a list of SNMP Attribute ODEs and/or OIDs. Use ODEs only if the SNMP proxy agent computer has the corresponding MIB available. The default is sysUpTime.0. |
|
SNMP port number |
Specify the UDP port number on the remote SNMP device to which you want to send SNMP requests. The default is 161. |
|
SNMP retries |
Specify the number of retries to attempt if a timeout occurs on an SNMP request. The default is 2 retries. |
|
SNMP timeout |
Specify the number of seconds to wait for a response before timing out an SNMP request. The default is 5 seconds. |
|
Perform GetNext instead of Get? |
Set to Yes to perform an SNMP GetNext operation instead of a Get. The default is to perform a Get operation. |
|
OID Value Check |
|
|
Collect data for OID value? |
Set to Yes to collect data for use in graphs and reports. If enabled, returns a data stream for each SNMP device/SNMP attribute pair. The default is unchecked. |
|
Calculated units |
If this script is performing numeric conversions, a name for the resulting units calculated can be entered here. If nothing is supplied for this parameter, the default units are the name of the data type retrieved. The default is “Days”. |
|
Calculate delta for numeric OID value? |
Set to Yes to specify that the retrieved values are numeric and a delta should be calculated. The difference between the new value and the previous value is calculated. Normally this is used to monitor growth of SNMP counter values between iterations. The default is unchecked. Delta calculations are not normalized. Thus, it is usually necessary to perform a division conversion on delta calculations to convert to the desired time units. For example, if the growth of an SNMP counter is being tracked by doing a delta calculation at a script interval of one minute, it is necessary to divide by 60 to track the growth of the counter on a per-second basis. If set to Yes, integer math (not floating point math) is used; thus, any remainder is discarded. NOTE:Do not enable this option if the script is running at intervals of less than one minute. The results may not be reliable. |
|
Convert string to numeric value (Advanced)? |
Set to Yes to convert the string values returned by SNMP to numeric value. The Knowledge Script converts the string value to number if the string represents a valid numeric data. Otherwise an event is raised. The numeric data allows you to perform the mathematical operations as provided by the Knowledge Script. The default is No. |
|
Process OID’s Individually (Advanced)? |
Set to Yes to see individual success or failure events of each OID. The default is No. |
|
Use multiplier for numeric OID value? |
Set to Yes to specify that the retrieved values are numeric and should be multiplied by the value specified for the next parameter. The default is unchecked. |
|
Multiplier value |
If the Use multiplier for numeric OID value? parameter is enabled, the retrieved SNMP attributes are multiplied by this value before being reported. The default is 1. |
|
Use divisor for numeric OID value? |
Set to Yes to specify that the retrieved values are numeric and should be divided by the value specified for the next parameter. If you enabled the Calculate delta for numeric OID value parameter, integer division is performed and any remainder is discarded. Otherwise, values are converted to real numbers to perform the division and retain the precision of any remainder. The default is Yes. |
|
Divisor value |
If the Use divisor for numeric OID value? parameter is enabled, the retrieved SNMP attributes are divided by this value before being reported. The default is 8640000. |
|
Calculate percentage of numeric OID value? |
Set to Yes to specify that the retrieved values are numeric and should be converted to a percentage of the maximum value supplied in the next parameter. Values are converted to real numbers to perform the percentage calculation and retain the precision of any remainder. Calculated values are restricted to a real number between 0% and 100%. The default is unchecked. |
|
Maximum value |
If the Calculate percentage of numeric OID value? parameter is enabled, the retrieved SNMP attributes are converted to a percentage of the maximum value entered here. The default is 100. |
|
Raise event when maximum threshold exceeded? |
Set to Yes to specify that the retrieved values should be compared against the maximum threshold value supplied in the next parameter. If enabled, the check is performed after any mathematical conversions that may have been selected above. The default is unchecked. |
|
Threshold -- Maximum OID value (post-calculation) |
This parameter has no effect unless Raise event when maximum threshold exceeded? is enabled. For numeric attributes, specify the maximum threshold value. If this value is exceeded, an event is raised. The threshold value is restricted to whole integer values. The default is 1000. |
|
Raise event when minimum threshold not met? |
Set to Yes to specify that the retrieved values should be compared against the minimum threshold value supplied in the next parameter. If enabled, the check is performed after any mathematical conversions that may have been selected above. The default is unchecked. |
|
Threshold -- Minimum OID value (post-calculation) |
This parameter has no effect unless Raise event if threshold not met? is enabled. For numeric attributes, specify the minimum threshold value. If this threshold is not met, an event is raised. The threshold value is restricted to whole integer values. The default is 100. |
|
Raise event when returned value equals “Numeric value”? |
Set to Yes to raise an event when the retrieved numeric values equal the value supplied in the Numeric value parameter. If enabled, the check is performed after any mathematical conversions that may have been selected above. |
|
Check for “not equal” instead of “equals”? |
Use this parameter to change the function of the previous parameter. To raise an event when the retrieved numeric values do not equal the value supplied in the Numeric value parameter, set to Yes and ensure that Raise event when returned value equals “Numeric value”? is also set to Yes. |
|
Numeric value |
Use this parameter only if Raise event when returned value equals “Numeric value”? is enabled. An event is raised if the retrieved SNMP values equal the value you enter here. If Check for “not equal” instead of “equals”? is also enabled, an event is raised if the retrieved SNMP values are not equal to the value you enter here. This threshold is restricted to whole integer values. The default is 0. |
|
Raise event when returned string equals “String value”? |
Set to Yes to raise an event when the retrieved values equal the value supplied in the String value parameter. Use this parameter to retrieve SNMP attributes that are strings, octet strings, OIDs, or IP addresses. |
|
Check for “not equal” instead of “equals”? |
Use this parameter to change the function of the previous parameter. To raise an event when the retrieved values do not equal the value supplied in the String value parameter, set to Yes and ensure Raise event when returned string equals “String value”? is also set to Yes. |
|
Do case-insensitive comparison? |
If Raise event when returned string not equal to value? is enabled, set to Yes to specify that the retrieved values should be compared without regard to character case. |
|
String value |
Use this parameter only If Raise event when returned string equals “String value”? is enabled. An event is raised if the retrieved string equals the value you enter here. If Check for “not equal” instead of “equals”? is also enabled, an event is raised if the retrieved string does not equal the value you enter here. The default is “String Value”. |
|
Event severity when OID value violates check |
Set the severity level, from 1 to 40, to indicate the importance of an event in which a threshold is crossed or an equality/inequality check fails. The default is 5. |
|
Event Notification |
|
|
Raise event if SNMP operation succeeds? |
Set to Yes to raise an event if the SNMP Get or GetNext operation is successful. The details of the event contain the retrieved data. |
|
Event severity when SNMP operation succeeds |
Set the severity level, from 1 to 40, to indicate the importance of an event in which the SNMP operation succeeds. The default is 25. |
|
Raise event if SNMP timeout exceeded? |
Set to Yes to raise an event if the SNMP Get or GetNext request receives no response from the device, and all retries fail. |
|
Event severity when SNMP timeout exceeded |
Set the severity level, from 1 to 40, to indicate the importance of an event in which the SNMP timeout period is exceeded. The default is 15. |
|
Raise event if SNMP Response error received? |
Set to Yes to raise an event if an SNMP Response error is received from the device. The type of error is reported in the event details. |
|
Event severity when SNMP Response error received |
Set the severity level, from 1 to 40, to indicate the importance of an event in which an SNMP Response error is received. The default is 10. |
|
Raise event if delta baseline established? |
This event can be raised only if the Calculate delta for numeric OID value? parameter is enabled. Set to Yes to raise an event when the initial value is retrieved, setting the baseline for a difference calculation on the next job iteration. |
|
Event severity when delta baseline established |
Set the severity level, from 1 to 40, to indicate the importance of an event in which a delta baseline is established. The default is 25. |