Halcyon PrimeAlert (R) InstantPaging
Version 1.1.0
README.install
---------------------------------------------------------------------------
Definitions
===========
InstantPaging server The host to which the modem is connected and the
server component of the InstantPaging software is
installed. This host is responsible for sending
messages to pagers by dialing out through the
modem.
InstantPaging client The host on which the client component of the
InstantPaging software is installed. The clients
connect to the InstantPaging server over the
network and make requests to send messages to
pagers.
<users> The pagers or aliases that are configured in the
/etc/inet/snppd.conf file on the InstantPaging
server. These are the people that the
InstantPaging server knows about and can send
messages to.
<SOURCE_DIR> This directory represents the installation source
directory. It is the directory under which the
distribution file, HALsmxpag_1.1.0.tar.(Z|gz) has
been extracted. For example, if the distribution
file has been extracted in /tmp then the
<SOURCE_DIR> is /tmp/HALsmxpag_1.1.0.
Requirements
============
In order to install and use InstantPaging, the following requirements must
be met:
Solaris:
- 200 KBytes free space in /usr
- 1000 KBytes free space in /var
- Hayes compatible modem connected to the InstantPaging server via a serial port
- Alphanumeric paging service using TAP (Teleocator Alphanumeric Protocol),
if alphanumeric paging is required.
Installation Overview
=====================
The following steps are needed to successfully install InstantPaging:
1. Configure the modem serial port
2. Install the InstantPaging server and clients
3. Configure the paging service and <users>
4. Test InstantPaging
These steps are outlined in detail below.
STEP 1: Serial Port Configuration
=================================
The serial port to which the paging modem is attached on the InstantPaging
server must be configured for dial-out or bi-directional use. It is
recommended that the paging modem be reserved for PrimeAlert InstantPaging.
For Dial-out Only:
1. As root on the InstantPaging server, run admintool and launch the
serial port configuration window.
2. Select "Modem - Dial out Only" from the "Template" toggle switch,
and the "Expert" radio button of "Detail".
3. Choose "Enabled" from the "Service" toggle switch and set the baud
rate to a value of your choice. "Terminal Type" can be left blank.
4. Under "Options", choose only "Initialize Only" and set the
"Port Monitor Tag" to "zsmon".
5. Under "Expert Options", choose only "Create utmp Entry". Leave other
fields as they are.
6. Select "OK" or "Apply" to have changes take affect.
For bi-directional:
1. As root on the InstantPaging server, run admintool and launch the
serial port configuration window.
2. Select "Modem - bi-directional" from the "Template" toggle switch,
and the "Expert" radio button of "Detail".
3. Choose "Enabled" from the "Service" toggle switch and set the baud
rate to a value of your choice. "Terminal Type" can be left blank.
4. Under "Options", choose "bi-directional". Set the "Login Prompt" to
"login:", and the "Port Monitor Tag" to "zsmon".
5. Under "Expert Options", choose "Create utmp Entry". Set "Service" to
"/usr/bin/login", "Streams Modules" to "ldterm,ttcompt", and "Timeout"
to "Never".
6. Select "OK" or "Apply" to have changes take affect.
STEP 2: Installation Instructions
=================================
Extracting the Distribution File
--------------------------------
The PrimeAlert InstantPaging distribution file,
HALsmxpag_1.1.0.tar(Z|gz), must be extracted on a UNIX host before any
packages can be installed. For example, assume that the distribution
file has been copied to the /tmp/install directory, and will be
extracted there. In this case, the procedure for extracting the
distribution file is:
% su -
# cd /tmp/install
# uncompress HALsmxpag_1.1.0.tar.Z
or gzip -d HALsmxpag_1.1.0.tar.Z
# tar xvf HALsmxpag_1.1.0.tar
InstantPaging Server Packages
-----------------------------
As root on the host with the modem attached (the InstantPaging server),
install the server package.
# su -
# cd <SOURCE_DIR>
# ./HALInstantPaging-install.sh -s
You will be prompted whether you wish to be able to access the paging
service from remote hosts.
If you answer 'no', then the InstantPaging server will not accept messages
over the network.
If you answer 'yes', then you will need to install the paging client on
all machines from which you want to send pages.
The following package is installed by the installation script:
- HALpuspag
InstantPaging Client Packages
-----------------------------
As root on these hosts, install the client package.
# su -
# cd <SOURCE_DIR>
# ./HALInstantPaging-install.sh -c
The following package is installed by the installation script:
- HALpucpag
STEP 3: Configuring the Paging Service
=======================================
You will need to edit the '/etc/inet/snppd.conf' file on the paging
server. The modem parameters may need to be adjusted to fit your local
configuration, and you will need to define your paging services and
<users>. See the comments in the snppd.conf file for more details.
STEP 4: Test InstantPaging
==========================
Verify that pages can be sent successfully. For details on how to send
pages look at the "Command Line Usage" section in this file. If pages
are not being sent, then look at the paging log file for the cause of
failure and correct the situation. See the section "Paging Log and Spool
File" for details in this file.
Command Line Usage
==================
To invoke the utility from command line, run the following command:
On the InstantPaging Server -
HALpage <user1>[,<user2>,<user3>,...] <message>
On a InstantPaging Client -
HALpage <host> <user1>[,<user2>,<user3>,...] <message>
Where <host> is the hostname of the InstantPaging server, <users> is a name
or alias that has been defined in the /etc/inet/snppd.conf file
on the InstantPaging server and <message> is a text message that you wish
to send.
Setting up InstantPaging for SUN Management Center (SunMC)
=========================================================
Sun Management Center is the most advanced systems management and
monitoring framework from Sun Microsystems.
SunMC framework can be extended using other third party products,
such as Halcyon PrimeAlert EventAction, to monitor applications
and perform event-based actions such as SNMP trap forwarding and paging.
For more info visit:
http://www.sun.com/sunmanagementcenter
InstantPaging can be configured to send pages from within
SunMC in two different ways.
1. Using Halcyon PrimeAlert EventAction Module for SunMC
We recommend this method as it provides centralized event handling
and notification of enterprise-wide alarms from all SunMC agents
and thus simplifies the configuration and maintenance.
For more info visit:
http://www.halcyoninc.com/products
2. Using SunMC Alarm Actions
This requires configuration on each agent.
1. Using PrimeAlert EventAction Module
--------------------------------------
Install InstantPaging client or server on the host where EventAction
Module is installed.
As root, create a link to the HALpage executable:
# cd /var/opt/SUNWsymon/bin/HALEventAction
# ln -s /usr/bin/HALpage HALEventAction-page
Setup an action in the PrimeAlert EventAction Module to send a page using
the HALEventAction-page executable. Refer to the PrimeAlert EventAction
help for details on how to configure event actions.
For arguments to the HALEventAction-page executable, enter
<host> <users> %smsg
or
<host> <users> <number>
Where <host> is the name of the InstantPaging server (on the InstantPaging
server itself, LEAVE THIS BLANK), and <users> is a comma-separated list of
the names or aliases you wish to page as defined above. For alphanumeric
pagers, it is recommended to use %smsg, which will be expanded to the full
status message. For numeric pagers, use a <number> which will be
recognizable to the page recipients. For example,
server23 tom,dick,harry 611
2. Using SunMC Alarm Actions
-------------------------
As root, create a link to the HALpage executable:
Note: InstantPaging client or server should be available on this host.
# ln -s /usr/bin/HALpage /var/opt/SUNWsymon/bin/HALpage
Setup an alarm action to send a page using the HALpage executable. Refer
to the SunMC help for details on how to configure alarm actions.
It is recommended that the PrimeAlert EventAction module be used with
SunMC to send pages since it provides centralized notification and is
much easier to configure and administer. Configuring alarm actions
involves having to go to each system and configuring an action for each
object that you would like to get notified for.
InstantPaging log file and spool file
=====================================
The paging log file '/var/opt/HALInstantPaging/HALInstantPaging.log'
reports the status of each page that is being sent. It can be used
to monitor the status of the paging service and to diagnose the failure
of pages. The format of this log file is:
<date> <status> <service>/<pager_id> - (<cause>) - [<msg>]
where <date> is the time at which the page was being sent, <status> is
the status of the page, <service> is the pager service being used,
<pager_id> is the user to whom the message is being sent, <cause> is the
reason for the <status>, and <msg> is the message that was destined for
the user. Possible <status> strings are 'Success', 'Fatal Failure' and
'Non Fatal Failure'. If <status> is 'Non Fatal Failure' then an attempt
was made by the software to resend the message for the number retries
specified in the '/etc/inet/snppd.conf' file.
If the software is being used with Sun Management Center, it is recommended
that the paging log file be monitored with the PrimeAlert LogFileMonitor
module to detect any possible problems with the paging system. Since
the log file grows infinitely, it is the responsibility of the user to
administer its size. The size of the file can be monitored with the
PrimeAlert FileSizeMonitor module.
The spool file '/var/opt/HALInstantPaging/HALInstantPaging.spool' is
a special file that queues page requests. It should not be modified
by a user unless he/she wishes to delete all pages in the queue. In
this case the user may delete the file only after killing the HALsnppd
or HALpage process on the InstantPaging server. A user may look at the
list of pages in the queue by using the 'cat' or 'more' command.
Uninstallation Instructions
===========================
Removing InstantPaging Server Packages
--------------------------------------
Login to the InstantPaging server host as root, and then run the following
command:
# pkgrm HALpuspag
Removing InstantPaging Client Packages
--------------------------------------
Login to the InstantPaging client host(s) as root, and then run the following
command:
# pkgrm HALpucpag
---//---