======================================================================
          Halcyon PrimeAlert (R) for Sun Messaging Server
                          Version 2.1.0

                          README.install
======================================================================


Overview
======================================================================
This README.install file describes how to install and setup the
PrimeAlert for Sun Messaging Server module.

It consists of the following sections:
   - Definitions
   - Extracting the Distribution
   - Installation Instructions
      . Server Packages
      . Agent Packages
   - Uninstallation Instructions
      . Server Packages
      . Agent Packages
   - Install & Uninstall Logs
   - Module Loading


Definitions
======================================================================
Server Host   The host where the Sun Management Center server is
              installed and running.  This system must be a Solaris
              host, and contain the package SUNWessrv.

Agent Host    A host where a Sun Management Center agent is installed 
              and running.  This system must be a Solaris host, and 
              contain the package SUNWesagt.  Sparse root zones 
              available on Solaris 10+ systems do not require SUNWesagt 
              but the Sun MC agents should be configured before enabling 
              zone support for this product.

Overview
======================================================================
The PrimeAlert for Sun Messaging Server distribution consists of 
the following modules:

 Module Name                                Version    Abbreviation
 -----------                                -------    ------------
 PrimeAlert for Sun Messaging Server        2.1.0      SMS

The Sun Messaging Server application consists of several components,
namely message transfer agents (MTA), message stores and a LDAP store.

Each of these components can be on separate hosts.  To setup the
monitoring using PrimeAlert, install the module(s) on each host where 
the Sun Messaging Server components are running.  

The LDAP store for Messaging Server should be monitored using
PrimeAlert for Sun Directory Server (SDS), available separately from
this product.

For example, if the following is the current configuration of your
Sun Messaging Server rollout:

Host      Sun Components Running
------    --------------------------
Host A    Sun Message Transfer Agent
Host B    Sun Message Store
Host C    Sun Directory Server (formerly iPlanet Directory Server)

You will have to configure the hosts for monitoring as follows:

Host       Sun                 Sun MC         PrimeAlert
           Components          Components     Components
------     ----------          ----------     ----------
Host A     MTA                 Agent          SMS Module
Host B     Message Store       Agent          SMS Module
Host C     Directory Server    Agent          SDS Module


Extracting the Distribution
======================================================================
The PrimeAlert for Sun Messaging Server distribution file,

   HALsmxims_[version].tar.Z OR
   HALsmxims_[version].tar.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
following directory:

   /tmp

In this case, the procedure for extracting the distribution will be:

   % su -
   # cd /tmp
   # gzip -d HALsmxims_[version].tar.gz
   # tar -xvf HALsmxims_[version].tar

Following the example above, the source directory [EXTRACT_DIR] would
be the following: 

   /tmp/HALsmxims_[version] 


Installation Instructions
======================================================================
There are one optional and two required steps to install this product:

   1. Install the server host packages
   2. Install the agent host packages
   3. Zone configuration(optional)


1. Server Packages (Solaris)
----------------------------------------------------------------------
To install the "PrimeAlert for Sun Messaging Server" module packages
on the Sun Management Center server host, do the following:

   1. Become the "root" user on the Sun Management Center server host
   2. Extract the distribution file
   3. Run the install script

   % su -
   # cd [EXTRACT_DIR] (i.e. /tmp/HALsmxims_[version])
   # ./HALSMS-install.sh

Note: During installation on the server host, when asked whether you
      want to install the packages for the agent layer, answer "y"
      only if the Sun Messaging Server software is installed on
      that particular host.  

      In general, the agent host packages should only be installed on
      hosts where the Sun Messaging Server application is installed
      and running.

Install the server host packages for PrimeAlert for Sun Directory 
Server.  Refer to its README.install file for more details:

Now restart the Sun MC metadata agent as follows:

   # /opt/SUNWsymon/sbin/es-stop -m
   # /opt/SUNWsymon/sbin/es-start -m


2. Agent Packages (Solaris)
----------------------------------------------------------------------
The installation of the agent host packages is similar to the server
host packages installation.

Note: The module needs to be installed on each system that is acting 
      as a Message Transfer Agent (MTA) or a Message Store.

Note: The server host packages should be installed or upgraded before
      any of the agent host packages.

To install the "PrimeAlert for Sun Messaging Server" module packages
on the Sun Management Center agent host, do the following:

   1. Become the "root" user on the Sun Management Center agent host
   2. Extract the distribution file
   3. Run the install script
   4. Restart the agent

   % su -
   # cd [EXTRACT_DIR] (i.e. /tmp/HALsmxims_[version])
   # ./HALSMS-install.sh

If Sun Directory Server is also on this host, install the agent host
packages for PrimeAlert for Sun Directory Server.  Refer to its 
README.install file for details.

Now restart the Sun MC agent as follows:

   # /opt/SUNWsymon/sbin/es-stop -a
   # /opt/SUNWsymon/sbin/es-start -a


3. Zone Configuration
----------------------------------------------------------------------
If you would like to use this product in a Solaris whole root zoned
environment, just install the module as if it is a global zone.

If you would like to use this product in a Solaris sparse root zoned
environment, perform the following steps in each sparse root zone
where the product is required after installing it in the global zone:

  # zlogin [name of sparse root zone]
  # $ESROOT/sbin/HALZoneConfig.sh
  # $ESROOT/sbin/es-stop -a
  # $ESROOT/sbin/es-start -a


Uninstallation Instructions
======================================================================
This section explains how to uninstall the various PrimeAlert for
Sun Messaging Server components:

   1. Uninstall the server host packages
   2. Uninstall the agent host packages

In general, the uninstall script can be used with no arguments to 
uninstall any Halcyon PrimeAlert product:
 
   # /var/opt/SUNWsymon/uninstall/HALUninstall.sh
   

Uninstall Server Packages
----------------------------------------------------------------------
To uninstall the PrimeAlert for Sun Messaging Server module packages
on the Sun Management Center server host, do the following:

   1. Become the "root" user on the Sun Management Center server host
   2. Run the uninstall script with the appropriate parameters

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


Uninstall Agent Packages
----------------------------------------------------------------------
To uninstall the PrimeAlert for Sun Messaging Server module packages
on the Sun Management Center agent host, do the following:

   1. Become the "root" user on the Sun Management Center agent host
   2. Run the uninstall script with the appropriate parameters

   % su -
   # cd /var/opt/SUNWsymon/uninstall
   # ./HALUninstall.sh -module iMS agent


Install & Uninstall Logs
======================================================================
All Halcyon PrimeAlert install and uninstall log files can be found 
in the following directories:
   
   /var/opt/SUNWsymon/install
   /var/opt/SUNWsymon/uninstall


   Installation Log
   ----------------
   The name of the installation log for this product is the following:

      HALSMS-install_[YYYYMMDD]-[HHMMSS].log


   Uninstall Log
   -------------
   The following is the generic uninstall log file:

      uninstall.log.[YYYYMMDD]-[HHMMSS]


Module Loading
======================================================================
Please refer to the "Module Loading" section in the help 
documentation for details on how to load the module.  Information on
how to access the help documentation is available in the "README"
file under the section "Help Documentation".

---//---