Halcyon PrimeAlert (R) Agent for HP-UX
                             Version 5.1.1
                   For use with Sun Management Center

                                README
-----------------------------------------------------------------------

Included Components
===================

This distribution includes the following PrimeAlert products:

PrimeAlert Agent for HP-UX
PrimeAlert SystemMonitor for HP-UX
PrimeAlert MIB-II System
PrimeAlert AgentHealth

The three PrimeAlert modules bundled with the PrimeAlert Agent for
HP-UX provide the agent with a basic level of functionality.


Nomenclature
============

- 'Sun Management Center' was formerly called 'Sun Enterprise SyMON'.
  This product only supports Sun Management Center 2.1 or higher.

- Halcyon has developed 'PrimeAlert Agents' for a number of platforms
  (Windows NT 4 and 2000, HP-UX, and Linux) that allow non-Solaris
  hosts to be monitored by Sun Management Center.

- <INSTALLDIR> is a user-selected directory for installing PrimeAlert
  agent and console files on a Windows host. The default value is
  C:\Program Files\Halcyon\PrimeAlert.


Supported Platforms
===================

The following table summarizes the platform support for the various
components contained within this distribution:

Operating          Base               Agent  Server  Console
System             Product            Layer  Layer   Layer
-----------------  -----------------  -----  ------  -------
Solaris 2.6-2.8    SunMC 2.1.x/3.0             x        x
HP-UX 10.20-11.00  PrimeAlert Agent     x
                   for HP-UX
Windows NT 4/2000  SunMC 2.1.x/3.0                      x


Informational Text Files
========================

A number of useful informational text files are included with this
distribution:

  - README
  - README.install
  - TroubleShooting
  - ReleaseNotes
  - LICENSE
  - COPYRIGHT

These files are located in the base directory of the distribution
tarball, and after installation, in the directory:

  After installation on a Solaris host -
    /var/opt/SUNWsymon/install/HALHPAgent

  After installation on an HP-UX host -
    /var/opt/PrimeAlert/install/HALHPAgent

  After installation on a Windows host -
    <INSTALLDIR>\docs\HALHPAgent


Installation and Uninstallation Instructions
============================================

For installation or uninstallation instructions, refer to the file
README.install (see the above section 'Informational Text Files').


Troubleshooting
===============

For troubleshooting information, refer to the TroubleShooting file
(see the above section 'Informational Text Files').

The release notes file, ReleaseNotes, which is located in the same
places as the TroubleShooting file, is also a valuable reference.
It contains information about bug fixes, enhancements, known problems,
and upgrade strategy for the current release.


HTML Help Documentation
=======================

To view the Help documentation for the three modules bundled with
the PrimeAlert Agent for HP-UX, see the following files in the
"doc" subdirectory of the HALHPAgent_5.1.1 directory in the tar file
HALHPAgent_5.1.1.tar:

./doc/AgentHealth/HALAgentStatistics-h.html
./doc/HPSystemMonitor/HALHPSystemAlert-h.html
./doc/MIB-II/HALMIBII-h.html

This documentation is also available by selecting "Help" from each
module's pop-up menu in the console's Details window.


License
=======
 
Please read the license agreement in the file LICENSE located in this
directory.
 
Without purchasing a license, the modules that are part of the
PrimeAlert Agent for HP-UX will only operate for a trial period of 30
days.
 
If you wish to purchase a license to use the PrimeAlert Agent for
HP-UX, please contact us at:
 
  Halcyon Inc.
  2300 Yonge Street
  Suite 1801, Box 2419
  Toronto, Ontario  M4P 1E4
  Canada

  http://www.HalcyonInc.com
  mailto:info@HalcyonInc.com
  Tel: 416-932-4647
  Fax: 416-932-4711


Overview
========

The PrimeAlert Agent for HP-UX monitors the health and statistics of
a host running HP-UX. The agent has been verified to run on HP-UX
versions 10.20 and 11.00. The PrimeAlert Agent for HP-UX seamlessly
integrates with Sun Management Center, such that HP hosts running
this agent can be managed and viewed from a Sun Management Center
console.

The following modules are provided with this release:

  - PrimeAlert SystemMonitor for HP-UX
  - PrimeAlert MIB-II System
  - PrimeAlert AgentHealth

These three modules are loaded by default when the PrimeAlert Agent
for HP-UX is first started; note that PrimeAlert MIB-II System cannot
be unloaded by the user.

Documentation for a particular installed module can be found in the
on-line help that is available from the module's context sensitive
menus in the Sun Management Center console.


Using the PrimeAlert Agent for HP-UX
====================================

Starting the Agent
------------------

The PrimeAlert Agent for HP-UX is controlled by the pa script that
is located in /opt/PrimeAlert/bin after installation. The commands
are:

  - pa start agent:    starts the PrimeAlert Agent
  - pa stop agent:     stops the PrimeAlert Agent
  - pa restart agent:  restarts the PrimeAlert Agent (stop and start)
  - pa status agent:   returns status information about the
                          PrimeAlert Agent (agent up/down)


Configuration
-------------

Typically, configuration of the PrimeAlert Agent for HP-UX is done
during installation. If you want to specify different settings after
installation, login to the HP-UX agent host and edit the text file
/var/opt/PrimeAlert/cfg/domain-config.x. The following lines can be
specified in domain-config.x:

# Agent Configuration
agent = {

    # Agent Port
    snmpPort = <port number>

    # Enabled logging channels
    activeChannels = <channel ...>
    # channel can be: error warning info debug status history syslog
}

# Server Configuration
# <component> is either trap or event
<component> = {

    # Server Component Port
    snmpPort = <port number>

    # Server Component Server Name
    <component>Server = <server name>

    # Enabled logging channels
    activeChannels = <channel ...>
}

If host names or port numbers are changed, the agent must be reseeded.
To reseed the agent, do the following in a Unix shell as super user:

# /opt/PrimeAlert/bin/pa usm-seed -s <seed> agent

where <seed> is the seed you used for your Sun Management Center
server layer installation. After reseeding the agent, restart the
PrimeAlert Agent for HP-UX.


Logging
-------

The PrimeAlert Agent for HP-UX creates several log files that can be
used for debugging purposes. These log files use a special format
called clog. Clog files are circular log files that remain at a fixed
size. The following tools can be used to view the log files:

/opt/PrimeAlert/bin/ctail: This is similar to the Unix command tail.
It displays the last few lines of a file. New lines are displayed as
they are added to the file.

/opt/PrimeAlert/bin/ccat: This is similar to the Unix command cat. It
prints the whole file on standard output.

The following log files are created by the agent --

/var/opt/PrimeAlert/log/agent.log:

This log file contains runtime information about the PrimeAlert Agent
for HP-UX. Lines containing critical error messages begin with "error".

/var/opt/PrimeAlert/log/agentStatus.log:

This log file contains events generated by the PrimeAlert Agent for
HP-UX.

/var/opt/PrimeAlert/log/history.log:

This log file contains information about monitored items for which the
history function has been enabled. This can be done in the Sun
Management Center console by using the History tab of the Attribute
Editor.


Monitoring the HP-UX Host with a Sun Management Center Console
==============================================================

This section provides instructions on how to configure your Sun
Management Center console to monitor hosts running the PrimeAlert Agent
for HP-UX.

In the following examples, it is assumed that you are logged into a Sun
Management Center console and an administrative domain is available.


Creating an HP-UX Node
----------------------

Before you can monitor the PrimeAlert Agent, you need to create an
HP-UX node in the Sun Management Center topology.

Using the Sun Management Center console, do the following:

1. In the main console window, select "Edit" from the menu bar and then
   "Create Object...".

2. Select the "Node" tab in the resulting dialog box.

3. For a SunMC 2.1.x server layer, select
   "Sun Management Center Agent - Host" from the "Monitor Via"
   picklist. For a SunMC 3.x server layer, select "SNMP Ping" from the
   "Monitor Via" picklist.

4. Enter a label in the "Node Label" field, e.g.
        Caspian (HP)

5. Enter a description in the "Description" field, e.g.
        HP-UX Host on 4th floor, main building

6. Enter the hostname in the "Hostname" field, e.g.
        caspian

7. Optionally, enter the IP address in the "IP Address" field, e.g.
        192.1.4.5

8. Enter the port number in the "Port" field. This is the port number
   you provided during installation of the Primealert Agent for HP-UX.
   The default is 161.
        161

   Note: If it was necessary to install the PrimeAlert Agent for HP-UX
         on another port (e.g. because there was already an agent using
         UDP port 161), then specify the port you used.

9. Click "OK". A new node is inserted into the topology window.

For a SunMC 3.x server layer, the following additional steps are
required:

1. In the main console window, select (click on) the PrimeAlert agent
   host that was just added to the current domain.

2. Select "Edit" from the menu bar and then "Modify...".

3. Select the "Node" tab in the resulting dialog box.

4. Select "Sun Management Center Agent - Host" from the "Monitor Via"
   picklist.

5. Click "OK".


Monitor the HP-UX Host
----------------------

After you have created the HP-UX node, you can monitor the host.

Using the Sun Management Center console, do the following:

1. Select the HP-UX node in the topology window.

2. Right-click on the selected HP-UX node and choose "Details" from the
   pop-up menu.

Or:

1. Double-click on the HP-UX node.

A new details window is displayed that contains information about the
HP-UX host. By default, the three modules bundled with the PrimeAlert
Agent for HP-UX are loaded; they appear in the 'Operating System" and
'Local Applications' groups.

Documentation for a particular installed module can be found in the
on-line help that is available from the module's context sensitive
menus in the Sun Management Center console.


Module Features
===============

PrimeAlert AgentHealth
----------------------
 
This module monitors statistics about the internal state of the agent
and of the agent process.
 
Note: If the Memory Usage and Virtual Memory Size values exceed the
Critical alarm thresholds (default is set to 70000 Kb for Virtual
Memory Usage), the agent will exit automatically.


PrimeAlert SystemMonitor for HP-UX
----------------------------------

The PrimeAlert SystemMonitor for HP-UX provides information about
the operating system and its components. The following sub-folders
are available:

1. User Statistics: Displays information about the current console
   user, the number of current users and sessions, and the primary
   user of the system.

2. Process Statistics: Displays information about current processes
   on your HP-UX system grouped by their state. It also shows the
   total number of processes and the the process capacity as well as
   the process limit. Probe commands provide a detailed view of 
   processes in different states and ordered by several criteria.

3. System Load: Provides information about the current system load
   (1 min, 5 min and 15 min load averages).

4. CPU Usage: Provides information about the current usage of the
   CPU. Shown are idle time, busy time, system time, user time, and
   the average CPU usage.

5. Swap Usage: Displays information about the total and available swap
   space and the current usage of swap memory. A probe command provides
   detailed information about allocated swap space.

6. Filesystem Usage: Displays information about mounted filesystems.
   For each filesystem the total size, available space, used space,
   and the change rate of used space are shown. 

7. Network Interfaces: Lists installed network interfaces and reports
   input/output packet errors and collisions. Probe commands can be
   used to obtain information about routing tables and protocols.

8. TCP Connections: Provides information about existing TCP
   connections. Probe commands generate a detailed view of network
   statistics for several protocols (e.g. Inet, TCP, UDP).

9. IPC Facilities: Displays information about IPC message queues,
   shared memory, and semaphores. Probe commands can be used to 
   obtain detailed information about these IPC facilities.


PrimeAlert MIB-II System
------------------------
 
The PrimeAlert MIB-II System module provides information about the MIB
used by the PrimeAlert Agent for HP-UX. This module cannot be unloaded
by the user.

---//---