Halcyon PrimeAlert (R) for Cisco Router 
                            Version 1.1.1
                  For use with Sun Management Center

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

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

This distribution includes a single PrimeAlert module:

PrimeAlert for Cisco Router


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.

-  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.5.1      SunMC 2.1.x/3.6          x
Solaris 2.6-2.10   SunMC 2.1.x/3.6          x      x        x
Linux 2.0-2.2      PrimeAlert Agent         x
                   for Linux
HP-UX 10.20-11.00  PrimeAlert Agent         x
                   for HP-UX
Windows NT 4/2000  SunMC 2.1.x/3.x                          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/HALRouterAlertCisco

  After installation on a Linux or HP-UX host -
    /var/opt/PrimeAlert/install/HALRouterAlertCisco

  After installation on a Windows host -
    \docs\HALRouterAlertCisco


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 PrimeAlert for Cisco Router, open
the following file in the "doc" subdirectory of the HALsmxcis_1.1.1
directory in the tar file HALsmxcis_1.1.1.tar:

./doc/RouterAlertCisco/HALRouterAlertCisco-h.html

This documentation is also available by selecting "Help" from the
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, this module will only operate for a trial
period of 30 days.

If you wish to purchase a license to use PrimeAlert for Cisco Router,
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
========

PrimeAlert for Cisco Router monitors the health and resources of Cisco
Routers, Series 760 to 12000, inclusively. Each module instance
monitors the status, statistics, and configuration information for a
single router. Multiple routers may be monitored by loading multiple
instances of this module.

This module allows the local SunMC/PrimeAlert agent to act as a proxy
agent for the SNMP agent running on the Cisco Router being monitored;
thus, in the SunMC console, each instance of PrimeAlert for Cisco
Router is located within the Remote Systems section of the Host Details
view of the proxy host upon which the module is loaded.


Loading an Instance of PrimeAlert for Cisco Router 
==================================================

1. Launch the Sun Management Center console application, and select a
   domain that contains the host where PrimeAlert for Cisco Router will
   be loaded.

2. In a Host Details window, select "Load Module..." from the Module
   Menu (or, in the Main console window, select "Load Module..." from a
   host's Pop-up Menu).

3. Select PrimeAlert for Cisco Router from the Module Picklist and
   click on the OK button. This will launch the Module Loader which
   contains the following fields:

Module
              The name of the module assigned to files as part of the
              module file naming convention. This field is read-only.

Module Name
              The actual name of the module. This field is read-only.

Module Description
              The short description of the module. This field is
              read-only.

Version
              The version number of the module. This field is
              read-only.

Enterprise
              The Enterprise where this module will be loaded in the
              agent's MIB. This field is read-only.

Module Type
              The module's type, which determines where this module
              will appear in the module hierarchy. This field is
              read-only.

Instance
              Enter a short, alphanumeric description that has not been
              used previously for other instances of PrimeAlert for
              Cisco Router currently loaded on the same agent. This
              unique description is used to differentiate the various
              instances of PrimeAlert for Cisco Router loaded on the
              same agent. The description you enter here is appended to
              the internal Module name described above.

              For example, if the description "t1" is entered by the
              user, this instance is appended to the internal module
              name "HALRouterAlertCisco" creating the following unique
              instance name:

              HALRouterAlertCisco+t1

              This instance name is useful in specifying alarm actions
              using PrimeAlert EventAction.

Description
              Enter a short formal description of the module. This
              description is used to identify the module in the console
              window.

              The short description you enter in this field will be
              appended with the Module Name described above.

Device Name (or IP Address)
              Enter the host name or IP address of the router to be
              monitored.

SNMP Port
              Enter the SNMP port of the router to be monitored (the
              default port is 161).

SNMPv1 GET Community
              Enter the SNMPv1 GET community of the router to be
              monitored (the default is public).

4. Once you have entered the required information, click on the OK
   button to load the module.


Note                                                                   
====                                                                   

If you have installed PrimeAlert for Cisco Router on an agent host, and
wish to load an instance of the module, but you are not sure what
parameters to enter for:

- Device Name (or IP Address),
- SNMP Port, and/or
- SNMPv1 GET Community

you can try running the script HALRouterAlertCisco-check.sh on the
agent host in question. The script HALRouterAlertCisco-check.sh is
located in one of the following directories:

- on a Linux or HP-UX host, $PAROOT/sbin, where PAROOT is
  /opt/PrimeAlert;

- on a Solaris host, $ESROOT/sbin, where the default value of ESROOT is
  /opt/SUNWsymon. To determine the value of ESROOT on a Solaris host
  that is a SunMC agent host, run the command:

     # echo "`pkgparam SUNWesagt BASEDIR`/SUNWsymon"

The check script will indicate whether or not the SNMP agent of the
specified router can be queried with the parameters entered by the
user. Note that if there is a firewall between the SunMC/PrimeAlert
agent host and the router being queried, then the firewall may block
the transmission of SNMP packets between the router and the agent host.

---//---