Using the context object with active monitors
- Last Updated: January 28, 2025
- 1 minute read
- WhatsUp Gold
- Version 2024
The context object provides an interface for your script to interact with WhatsUp Gold.
All methods and properties are retrieved using the Context
namespace.
|
Methods |
Method description |
||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
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()" |
||||||||||||||||||||||||||||||||||||
|
|
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); |
||||||||||||||||||||||||||||||||||||
|
|
This method allows for a result code and result message to be set. This is how you can tell the WhatsUp Gold system if the monitor succeeded or not. Every script should call SetResult. If SetResult is not called, the script is always assumed to have succeeded. Example JScript Context.SetResult(0, "Script completed successfully."); //SuccessContext.SetResult(1, "An error occurred."); //Failure VBScript Context.SetResult 1, "An error occurred." |
||||||||||||||||||||||||||||||||||||
|
|
This method offers access to any of the device properties listed below. These names are case sensitive.
Example JScript var sAddress = Context.GetProperty("Address"); var sReadCommunity = Context.GetProperty("CredSnmpV1:ReadCommunity");var nDeviceID = Context.GetProperty("DeviceID"); |