Ipswitch WhatsUp Gold User Guide - Ipswitch Documentation Server

Using the SNMP API
The WhatsUp Gold SNMP COM API has been enhanced to improve the performance of your
scripted monitors and actions. With the addition of GetMultiple, you have the ability to get
multiple OIDs within a single SNMP request. GetNext issues the SNMP GetNext command to
retrieve the value of the object that follows a specified object. Finally, the addition of the
SetFunction allows you to send SNMP set commands to your SNMP manageable devices.
The SNMP API includes the following objects:
CoreAsp.SnmpRqst. The main SNMP object used to send SNMP requests (Get,
GetNext, Set) to a remote device.
CoreAsp.ComResult. An object returned by certain methods of the SnmpRqst
object to indicate success or failure.
CoreAsp.ComResponse. A response object returned by certain methods of the
SnmpRqst object that contain the status (either error or success) of an SNMP request
and the value of the polled object(s).
Note: There are several things to keep in mind when attempting to use the SNMP API. If you
are experiencing errors, please see Troubleshooting the SNMP API (on page 949).
CoreAsp.SnmpRqst
This object is used to send SNMP requests to a remote device.
Initialize or Initialize2 must be called prior to any other members.
CoreAsp.SnmpRqst uses a three step process:
1 Calls Initialize or Initialize2 to initialize the object against a particular device.
2 Sets optional parameters such as timeout value, port, etc.
3 Performs any number of Get, GetNext, GetMultiple or Set operations against a
device. Those operations return an ComSnmpResponse object that contains the status
of the operation and the value either directly (use Failed/GetValue/GetOid) or as a
list of SNMP variable binding returned as XML data (use GetPayload).
Method Description Returns
Initialize(
nDeviceID
)
Initializes the SnmpRqst object for the device with
the device ID specified in nDeviceID. If a device is
not configured with a valid SNMP credential, the
operation will fail.
nDeviceID. A positive integer
corresponding to the device ID of a
device configured in WhatsUp Gold.
ComResult object
942