Ipswitch WhatsUp Gold User Guide - Ipswitch Documentation Server

Ipswitch WhatsUp Gold User Guide
Keep In Mind
You need to include error handling in your monitor script. Your script either needs a
value to graph by using Context.SetValue, or you must use Context.SetResult
to tell WhatsUp Gold that the script failed.
Context.GetReferenceVariable will return 'null' if the poll fails for any reason.
If you do not have a call to SetValue or SetResult, the script does not report any
errors and no data is graphed.
If SetValue is used, it is not necessary to use SetResult, as SetValue implicitly
sets SetResult to 0, or "good."
Results from this performance monitor are displayed on Custom Performance Monitors
(on page 639) full and dashboard reports.
Errors from this performance monitor are displayed in the Performance Monitor Error
log (on page 691) as well as EventViewer.exe.
Using the Context object with Performance Monitors
The context object provides an interface for your script to interact with WhatsUp Gold.
All methods and properties are retrieved using the Context namespace.
Note: You may have to remove the copyright information from the cut and paste if it appears
when you copy from this help file.
Methods Method description
LogMessage(sText); This method allows for a message to be written to the
WhatsUp Gold debug log.
Example
JScript
Context.LogMessage( "Checking Monitor name using
Context.GetProperty()");
VBScript
Context.LogMessage "Checking Address using Context.GetProperty()"
PutProperty(sPropertyName); This method allows you to store a value in the INMSerialize
object. This value is retained across polls.
Example
JScript
var nCount = parselnt(nNum) +1;
Context.PutProperty("MyNumeric",nCount);
SetResult(nCode, sText); This method allows for a result code and result message to
928