Ipswitch WhatsUp Gold User Guide - Ipswitch Documentation Server

Ipswitch WhatsUp Gold User Guide
Using Scripting Actions
Active Script Actions can be configured to trigger when an active monitor's state changes.
They can be programmed to perform a variety of tasks, from running automated remediation
scripts to posting data to external, third party services via API.
Note: Please be aware that Ipswitch does not support the custom scripts that you create;
only the ability to use them in the Active Script Monitor.
For more information, see Extending WhatsUp Gold with scripting (on page 909).
Adding and editing an Active Script Action
This action allows you to write either VBScript or JScript code to perform a customized action.
If the script returns an error code, the action failed.
To add or edit an active script action:
1 Click the Admin tab, then click Action Library.
2 Click New to create a new active script action, and then select Active Script Action
from the list. Click OK.
- or -
From the list of current actions, select the action you want to change, and then click
Edit.
3 Type or select the appropriate information in the following fields.
Name. Type a name for the action. This name displays in the Action Library.
Description. Type a short description. This description displays next to the action in
the Action Library.
Timeout. The amount of time (in seconds) WhatsUp Gold should wait for the action
script to run.
Note: Though the maximum timeout is 60 seconds, you are highly discouraged from using a
timeout longer than the default of 10 seconds. You are encouraged to use the shortest
timeout possible.
Script type. Select the scripting language that you want to use to write this active
script (either VBScript or JScript).
Script text. Write or insert your action code here.
Note:It is not recommend that you use percent variables in script text, because they may
resolve to text containing special characters (' ' (quotes), " " (double-quotes), % (percent),
new line characters, and the like) that may break your script.
This script action has a context object you can use to get specific information about the
context of the action.
306