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

                            README.install          
-----------------------------------------------------------------------

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.


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


Installation Instructions
=========================

Definitions
-----------

ESROOT:             This parameter only applies for a Solaris
                    installation host. For SunMC 2.1 or higher, this
                    directory is determined by the user while
                    installing SunMC; the default value is
                    /opt/SUNWsymon. To determine the value of ESROOT
                    on a SunMC agent host, run the command:

                    # echo "`pkgparam SUNWesagt BASEDIR`/SUNWsymon"

Server Host:        A host where the Sun Management Center server is
                    installed and running. This host must be a Solaris
                    host, and it contains the package SUNWessrv.

Agent Host:         A host where a Sun Management Center or PrimeAlert
                    agent is installed and running. If the host is a
                    Solaris host, it contains the package SUNWesagt;
                    for a Linux host, HALpialag; and for an HP-UX host,
                    HALpiahpa.

Console Host:       A host where the Sun Management Center console is
                    installed and running. If this host is a Solaris
                    host, it contains the package SUNWescon; it may
                    also be a host running Windows.


Extracting the Distribution File
--------------------------------

The PrimeAlert for Cisco Router distribution file,
HALsmxcis_1.1.1.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 HALsmxcis_1.1.1.tar.Z
    or gzip -d HALsmxcis_1.1.1.tar.gz
  # tar xvf HALsmxcis_1.1.1.tar

In this case, the directory /tmp/install/HALsmxcis_1.1.1 represents
the installation source directory, <SOURCE_DIR>, which is referenced below.

NOTE:

  Versions of Red Hat Linux prior to 6.1 may contain a problematic
  version of tar that cannot handle long pathnames. Although this will
  not affect the installation of the Linux packages, extraneous files
  may be created in the directory where the tarball is extracted; thus,
  the tarball should be extracted in a dedicated staging directory,
  such as /tmp/install. Note that if your version of Linux tar cannot
  handle long pathnames, then the extracted tarball should only be used
  for doing installations on the local Linux host.


Server Layer Packages - Solaris Only
------------------------------------

The procedure described in this sub-section should be performed on the
Sun Management Center server layer host only.

Note that server layer packages should be installed/upgraded before
agent or console layer packages are installed/upgraded.

Login to the Sun Management Center server host as root. Extract the
PrimeAlert for Cisco Router distribution file (see the above section
'Extracting the Distribution File') in a temporary location, and then
run the script HALRouterAlertCisco-install.sh, e.g.:

  % su -
  # cd <SOURCE_DIR>
  # ./HALRouterAlertCisco-install.sh -s

The following package is installed or upgraded by the installation
script:

  - HALmmscis


Agent Layer Packages - Solaris, HP-UX, and Linux
------------------------------------------------

The procedure described in this sub-section should be performed on any
agent host that is being upgraded to the latest version of PrimeAlert
for Cisco Router, or that is receiving PrimeAlert for Cisco Router for
the first time.

For Solaris, login to a Sun Management Center agent host as root; for
HP-UX or Linux, login to a PrimeAlert Agent host as root. Extract the
PrimeAlert for Cisco Router distribution file (see the above section
'Extracting the Distribution File') in a temporary location, and then
run the script HALRouterAlertCisco-install.sh, e.g.:

  % su -
  # cd <SOURCE_DIR>
  # ./HALRouterAlertCisco-install.sh -a

NOTE:

  On HP-UX systems it may be necessary to run the install script from
  a local file system since the HP installation software requires root
  access to the directories containing the packages.

On a Solaris host, the following package is installed or upgraded by
the installation script:

  - HALsmacis 

On an HP-UX or Linux host, the following package is installed or
upgraded by the installation script:

  - HALpmacis

After the package is installed, restart the agent:

Solaris:        % su -
                # $ESROOT/sbin/es-stop -a
                # $ESROOT/sbin/es-start -a

HP-UX/Linux:    % su -
                # /opt/PrimeAlert/bin/pa stop agent
                # /opt/PrimeAlert/bin/pa start agent


Console Layer Packages - Solaris
--------------------------------

The procedure described in this sub-section should be performed on any
console host that is being upgraded to the latest version of PrimeAlert
for Cisco Router, or that is receiving PrimeAlert for Cisco Router for
the first time.

Login to a Sun Management Center console host as root. Extract the
PrimeAlert for Cisco Router distribution file (see the above section
'Extracting the Distribution File') in a temporary location, and then
run the script HALRouterAlertCisco-install.sh, e.g.:

  % su -
  # cd <SOURCE_DIR>
  # ./HALRouterAlertCisco-install.sh -c

The following package is installed or upgraded by the installation
script:

  - HALmmccis

The local SunMC console should be restarted after installation.


Console Layer Packages - Windows 
--------------------------------

The procedure described in this sub-section should be performed on any
Windows console host that is being upgraded to the latest version of
PrimeAlert for Cisco Router, or that is receiving PrimeAlert for Cisco
Router for the first time.

1 - Extract the PrimeAlert for Cisco Router distribution file (see the
    above section 'Extracting the Distribution File') on a Solaris
    host. In this case, the InstallShield installer for Windows has the
    pathname:

    <SOURCE_DIR>/packages/win32/HALRouterAlertCisco_1.1.1.exe

2 - Copy the Windows InstallShield installer to a convenient location
    (<path>) on the Windows console host.

3 - If present, remove the currently installed console package for
    PrimeAlert for Cisco Router (see the following section 'Removing
    Console Layer Packages - Windows').

4 - Run the InstallShield package HALRouterAlertCisco_1.1.1.exe, for
    example:

    Start->Run... <path>\HALRouterAlertCisco_1.1.1.exe

    Follow the instructions presented on screen.

    Besides installing a number of program files, the installation 
    program puts a shortcut in the Start Menu's Programs folder,
    sub-folder Halcyon. This shortcut provides easy and fast access
    to help files for PrimeAlert for Cisco Router.

The local SunMC console should be restarted after installation.


Installation Log File - UNIX Only
---------------------------------

To view the installation log on a Solaris/Linux/HP-UX host, see the
file:

  Solaris -
  /var/opt/SUNWsymon/install/HALRouterAlertCisco-install_<YYYYMMDD>-<HHMMSS>.log

  HP-UX/Linux -
  /var/opt/PrimeAlert/install/HALRouterAlertCisco-install_<YYYYMMDD>-<HHMMSS>.log


Uninstallation Instructions
===========================

Removing Server Layer Packages
------------------------------

The procedure described in this sub-section should be performed on the
Sun Management Center server layer host only.

Login to the Sun Management Center server host as root, and then run
the following commands:

  % su -
  # cd /var/opt/SUNWsymon/uninstall
  # ./HALUninstall.sh -module CiscoRouter server

The following package will be removed:
  - HALmmscis


Removing Agent Layer Packages
-----------------------------

The procedure described in this sub-section can be performed on any
Sun Management Center agent layer or PrimeAlert Agent for HP-UX/Linux
host where PrimeAlert for Cisco Router is no longer required.

First, unload any instances of PrimeAlert for Cisco Router currently
loaded on the agent host where PrimeAlert for Cisco Router is to be 
uninstalled.

Then, login to the agent host as root, and run the following commands:


Solaris:     % su -
             # cd /var/opt/SUNWsymon/uninstall
             # ./HALUninstall.sh -module CiscoRouter agent

  The following packages are removed by this process:

    - HALmpawlk (SunMC 2.1X)
    - HALsmacis

HP-UX/Linux:  % su -
              # cd /var/opt/PrimeAlert/uninstall
              # ./HALUninstall.sh -module CiscoRouter agent

  The following package is removed by this process:

    - HALpmacis
  
After the packages are removed, the agent process can be restarted,
although this step is not required:

  Solaris:     % su -
               # $ESROOT/sbin/es-stop -a
               # $ESROOT/sbin/es-start -a

  HP-UX/Linux: % su -
               # /opt/PrimeAlert/bin/pa stop agent
               # /opt/PrimeAlert/bin/pa start agent


Removing Console Layer Packages - Solaris
-----------------------------------------

The procedure described in this sub-section should be performed on any
console host where packages for the PrimeAlert for Cisco Router are to
be removed.

Login to a Sun Management Center console host as root, and then run
the following commands:

  % su -
  # cd /var/opt/SUNWsymon/uninstall
  # ./HALUninstall.sh -module CiscoRouter console

The following package will be removed:

  - HALmmccis

It is not necessary to restart the local SunMC console after package
uninstallation.


Removing Console Layer Packages - Windows
-----------------------------------------

The procedure described in this sub-section should be performed on any
Windows host where the PrimeAlert for Cisco Router is to be removed.

1.  Go to the Windows Start menu and select:

    Start -> Settings -> Control Panel

    A new Control Panel window will appear on your screen.

2.  Double-click on the "Add/Remove Programs" icon in the Control Panel
    window. A new window labeled "Add/Remove Programs (Properties)" will
    appear.

3.  Select "Halcyon PrimeAlert for Cisco Router" in the scrolling list
    of the new window.

      Windows NT 4 --

      Click on the "Add/Remove..." button.

      Windows 2000 --

      Click on the "Change/Remove" button.

    An UnInstallShield session will be launched; follow the instructions
    presented on screen.


Uninstallation Log File - UNIX Only
-----------------------------------

To view the uninstallation log on a Solaris/Linux/HP-UX host, see the
file:

  Solaris -
  /var/opt/SUNWsymon/uninstall/log/uninstall.log.<YYYYMMDD>-<HHMMSS>

  HP-UX/Linux -
  /var/opt/PrimeAlert/uninstall/log/uninstall.log.<YYYYMMDD>-<HHMMSS>

---//---