Setup instructions for sending SMS from WhatsUp Gold
In a diverse It environment supervision
job can be demanding and exhaustive. To select the important data from
secondary information is hard to do when one is dealing with a complex
network. WhatsUp Gold provides a solution for supervision difficulties with
its easy to use and uncomplicated interface. However Ozeki's solution makes
it even more professional by adding SMS functionality to it. This SMS
functionality makes it possible to send direct SMS notifications on various
events or problems occurred in your IT system to mobile devices. In this
installation guide you will receive a detailed, step by step description on
the configuration procedure of this solution.
Prerequisites
In order to setup this solution you need to find a way
to connect your system to the mobile network. You can do this
by using an Internet connection or you can
setup a wireless connection by attaching a GSM phone/GSM modem to your computer. To help you make a
decision, we have prepared a webpage for you:
Internet based SMS connections vs. GSM modem based (wireless) SMS connections.
Depending
on what you select, you need the following prerequisites.
Prerequisites for Internet based connection to the Mobile network
If you wish to connect your system to an SMS service
provider over the Internet you need the following components:
Figure 1/a - Prerequisites for Ozeki NG SMS
Gateway IP SMS connection
In this case you need to find an SMS service
provider who can reach the mobile phones in your area. This SMS
service provider should be able to provide SMS service through
the Internet. To find such a provider, you can check our
website where we list some of them:
SMPP SMS Service providers.
Once you have found such a provider, you need to sign up for
their service to get the connection parameters. You can use these parameters
to configure your Ozeki NG SMS Gateway software.
Prerequisites for wireless (GSM modem) connection to the Mobile network
If you wish to connect your system to the mobile
network wirelessly, you need a GSM modem or GSM phone, that you
can attach to your computer with a data cable. In this case your Ozeki
NG SMS Gateway software will operate this phone and will send and receive
SMS messages wirelessly. To setup this connection method, you need the following
components:
Figure 1/b - Prerequisites for Ozeki NG SMS
Gateway GSM modem connection
Your checklist (for GSM modem connection):
*The SIM card will come with a plan, that will
determine how much money you will spend on each SMS.
System architecture
To be able to send and receive SMS messages from
WhatsUp Gold you need to build an SMS system that will work as the follows:
If a problem occurs in the monitored network
(e.g.: down event) WhatsUp Gold notices it. Its SMS Notification Policy-set
during configuration, forwards it to Ozeki NG SMS Gateway software. The
SMS gateway
translates the report into a text message and sends it to the GSM modem
attached to the PC via COM1 cable or to an IP SMS connection. It will
forwards the SMS message to the SMS Center of the service provider(s).
Then the message
is sent to the intended mobile user. This stable and fast connection is
achieved by Ozeki NG SMS Gateway's superior performance (500+ SMS/second
to 64+ concurrent SMSC connections). Please feel free to examine the
architectural diagram below (Figure 2).
Figure 2 - Components of the solution
Installation guide
To install and configure Ozeki's solution for WhatsUp
Gold please follow the steps below and watch the video tutorials at the top
of the page.
Step 1. Create an action.
To create an action you need to click on
"Action Library" in "Configure" menu (Figure 3).
Figure 3 - Action Library
A window appears and you can see pre-defined actions in it.
On the left hand side click on "New" (Figure 4) and set the type of the
action to "Program Action" and click on "OK" (Figure 5).
Figure 4 - New action library
Figure 5 - Action type
In "Launch Program Action" window provide a
name for the action (e.g. SMS Notification) then type in the following values
(Figure 6):
Program file name:
C:\Program Files\Ozeki\OzekiNG - SMS Gateway\SendSMS.exe
|
Working path:
C:\Program Files\Ozeki\OzekiNG - SMS Gateway
|
It is the working path where you can find SendSMS.exe file. If you do not change
your default settings during installation, you can find SendSMS.exe file in this
folder.
Program arguments:
-h 127.0.0.1:9500 -u admin -p abc123 -r "+36301234567" -m
"An error occurred on device %Device.HostName at %System.Date.
Monitor state: %Device.State"
|
(After "-h" please provide the IP address of the computer on which Ozeki
NG SMS Gateway has been installed. As WhatsUp Gold and Ozeki NG SMS Gateway
are on the same computer, the IP address is: "127.0.0.1"
After "-u": provide the username you use to log into Ozeki NG SMS Gateway.
The default username is "admin"
After "-p": type your password used in Ozeki NG SMS Gateway
Figure 6. - Launch program action
Please note, that "%Device.HostName", "%System.Date" and "%Device.State" and
the body of the message can be customized if you replace them for any of
the variables provided in the table below.
| Percent Variables | You can customize an action's message by
adding any of the variables in the following table.
Note: We do not recommend that you use percent variables in script text (Active
Script Action), because they may resolve to text containing special characters
(' ' (quotes), " " (double-quotes), % (percent), new line characters, and the
like) that may break your script. |
| Active Monitor Variables | Description |
| %ActiveMonitor.Argument | SNMP instance number. This is only
used when an action is associated directly with an active monitor, and not the
device as a whole. |
| %ActiveMonitor.Comment | The human readable name that coincides
with the network switch. This is only used when an action is associated directly
with an active monitor, and not the device as a whole. |
| %ActiveMonitor.Name | The name of the active monitor that fired
an action. This is only used when an action is associated directly with an active
monitor, and not the device as a whole. |
| %ActiveMonitor.NetworkInterfaceAddress | IP address for the
network interface. This is only used when an action is associated directly
with an active monitor, and not the device as a whole. |
| %ActiveMonitor.Payload | The payload returned by a WMI, Exchange,
SQL, SNMP or Active Script active monitor. This is only used when an action is
associated directly with an active monitor and not the devices as a whole. For
Active Script Active Monitors, the payload is the text that is passed to the
SetResult() method in the script. |
| %ActiveMonitor.State | The Current status of the monitor, such
as "Down at least 5 min." This is only used when an action is associated directly
with an active monitor, and not the device as a whole. |
| Device Variables | Description |
| %Device.ActiveMonitorDownNames | List of down services using
the abbreviated name if available. |
| %Device.ActiveMonitorUpNames | Full service names of all UP
monitored services on a device. |
| %Device.Address | IP address (from device properties). |
| %Device.Attribute.[Attribute Name] | Returns an attribute from
the SNMP information available for the device, such as the Contact name. To
specify the attribute, append the category name (listed below) to the end of
the variable. For example: %Device.Attribute.Contact, returns the contact name.
Default categories:
? *. Returns all attributes
? Info1. Upgrade path from v8
? Info2. Upatgrade path from v8
? Contact. Contact information from SNMP
? Location. Location information from SNMP
? Description. Description information from SNMP
? Custom. If you have created a custom attribute you can use the name of that
custom attribute in the percent variable.
|
Example:%Device.Attribute.Phone
%Device.Attribute.RackPosition | To avoid an error, when placing
%Device.Attribute in quotation marks, place a space between the last letter
and the closing quotation mark. |
Example:
| | "%Device.Attribute.Contact "; | correct |
| "%Device.Attribute.Contact"; | incorrect |
| %Device.DatabaseID |
Returns the database ID of a device. |
| %Device.DisplayName |
Display Name (from General of device properties) |
| %Device.HostName |
Host Name (from General of device properties) |
| %Device.Notes |
Notes. (Notes are from the device properties Notes) |
| %Device.SNMPOid |
SNMP Object identifier. |
| %Device.State |
The state's description (such as "Down at least 2 min" or "Up at least 5 min")
|
| %Device.Status |
This shows the name of the active monitor, preceded by the device state id :
10|DNS |
| %Device.Type |
Device Type (from General of device properties) |
| Passive Monitor Variables | Description |
| %PassiveMonitor.DisplayName | The name of the monitor as it
appears in the Passive Monitor Library. |
| %PassiveMonitor.LoggedText | Detailed Event description.
(SNMP traps - Returns the full SNMP trap text.) (Windows Log Entries - Returns
information contained in the Windows Event Log entries.) (Syslog Entries -
Returns the text contained in the Syslog message.) |
| %PassiveMonitor.Payload.* | Payload generated by a passive monitor.
|
| %PassiveMonitor.Payload.EventType | The type of passive monitor
(Syslog, Windows Event, or SNMP Trap) |
| %PassiveMonitor.Payload.LogicalSource | Shows the device's
logical IP address. |
| %PassiveMonitor.Payload.PhysicalSource | Shows the device's
physical IP address. |
| System Variables | Description |
| %System.Date | The current system date. Configure the date
format in Regional Options (from Program Options) |
| %System.DisplayNamesDownDevices | Display names of devices with
down monitors |
| %System.DisplayNamesDownMonitors | Shows the name of a device and
each monitor that is down on that device. The format of the response is 'device
name':'monitor 1','monitor 2','...'
Example: ARNOR: FTP, HTTPS, Ping |
| %System.DisplayNamesUpDevices | Display names of up devices |
| %System.DisplayNamesUpMonitors | Shows the name of a device and
each monitor that is up on that device. The format of the response is 'device
name':'monitor 1','monitor 2','...'
Example: ARNOR: FTP, HTTPS, Ping |
| %System.InstallDir | Displays the directory on which WhatsUp Gold
is installed |
| %System.NumberofDownDevices | Number of down devices on your
network |
| %System.NumberOfDownMonitors | Shows the number of down
monitors on your network |
| %System.NumberofUpDevices | Number of up devices on your network
|
| %System.NumberOfUpMonitors | Shows the number of up monitors
on your network |
| %System.Time | The current system time. The format is hh:mm:ss
|
To test the action click on "Test..." on the
right hand side (Figure 7) and (Figure 8).
Figure 7 - Test selected action
Figure 8 - Testing the action
If you can see the sent message in Ozeki
NG SMS Gateway, then it means that the given settings operate properly
(Figure 9).
Figure 9 - Sent message
Step 2. Create an action policy
To create an action policy you need to click
on "Action Policies" in "Configure" menu (Figure 10).
Figure 10 - Action policy
The "Action policy" window appears, here you
can see the pre-defined action policies (there is only one action policy by
default). Click on "New..." (Figure 11).
Figure 11 - New action policy
Provide a name for the action policy
(e.g.: Notification Policy) and click on "Add..." and
select the "Select an action from the Action Library" option and click
on "Next" (Figure 12).
Figure 12 - Select an action
In the appeared "Action Builder" window
select the created action (SMS Notification) and set the executing criteria
to "Down". When it is done, click on "Finish" (Figure 13).
Figure 13 - Select action and state
Step 3. Add a device
To add a device you wish to manage,
right click at the "My Network" on the left hand side and
select "New Device" option (Figure 14)
Figure 14. - Add a new device
In the appeared window you need to type
the IP address of the device (e.g.:127.0.0.1) and click on "OK" (Figure
15).
Figure 15 - IP address of the device
A window appears, here select the device
type and click on "Actions" on the left hand side (Figure 16).
Figure 16 - Device type
Set the "Apply this Action Policy" option
then select the created policy (Notification Policy). When all done click
on "OK" (Figure 17).
Figure 17 - Apply notification policy
Now the configuration is complete, it is
time to test the system.
Test the system
To test the system I need to create a
Down event. To do this right click on the management computer name and click
on "Properties". In the device properties I change the IP address
of the device to a non-existing one in "General" option (Figure 18).
Figure 18 - Creating a down event
This will create a down event (Figure 19).
Figure 19 - Down event
In Ozeki NG SMS Gateway you can see that the message has been sent (Figure
20).
Figure 20 - Sent Message
These steps conclude the installation and configuration
procedure. If you followed the guide above correctly then you will have a
swift, stable and working environment.
Thank you for reading this
guide!
If you wish to implement this solution, please go
to the Download page to download Ozeki NG SMS Gateway!
FAQ
Feature list of Ozeki NG SMS Gateway
User Guide for Ozeki NG SMS Gateway
Product manual
| 
