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. (This method is for Active Script only.)

Example

JScript

var nCount = parselnt(nNum) +1;
Context.PutProperty("MyNumeric",nCount);

SetProperty(sPropertyName);

This method allows you to store a value in the INMSerialize object. This value is retained across polls. (This method is for PowerShell only.)

SetResult(nCode, sText);

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 succeeds or fails.

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."); //Success
Context.SetResult(1, "An error occurred."); //Failure

VBScript

Context.SetResult 1, "An error occurred."

GetReferenceVariable(sRefVarName );

This method allows the code to grab a reference variable to be used in the monitor.

Example

JScript

Context.GetReferenceVariable("A")

A reference variable "A" would have had to have been created.

SetValue(nValue);

This method allows you to graph a value.

Example

JScript

Context.SetValue(245)

GetProperty(sPropertyName);

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");