======================================================================
         Halcyon PrimeAlert (R) for Sun Directory Server 
                          Version 2.0.0

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


This README.install file describes how to install and setup the
PrimeAlert for Sun Directory Server module for Sun Management Center
(SunMC).

It consists of the following sections:
   - Definitions
   - Overview
   - Extracting the Distribution
   - Installation Instructions
      . Server Packages
      . Agent Packages
   - Uninstall 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.  

Console Host  A host where the Sun Management Center console is
              installed and running.  

ESROOT        The directory under which SunMC has been installed.  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 server host, run the 
              following command:
                  # echo "`pkgparam SUNWessrv BASEDIR`/SUNWsymon"


Overview
======================================================================
PrimeAlert for Sun Directory Server monitors the health and statistics 
of a local instance of Sun Directory Server. This module should be 
loaded on the SunMC agent that is running on the host where Sun 
Directory Server is running.

Note:
   To configure and enable monitoring of your Sun Directory
   Server and its instances, the following three steps must be
   completed:

     1. Enable the Sun SNMP Support Services
     2. Load the PrimeAlert for Sun Directory Server Module
     3. Configure and Enable Monitoring of the Directory Server
        Instances from the Monitored Instance Control section

Please refer to the "Module Loading" section in the help
documentation for more details on how to do these three steps. 


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

   HALsmxds5_[version].tar.[gz/Z]

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 would be:

   % su -
   # cd /tmp
   # uncompress HALsmxds5_[version].tar.Z
     or gzip -d HALsmxds5_[version].tar.gz
   # tar -xvf HALsmxds5_[version].tar

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

   /tmp/HALsmxds5_[version]


Installation Instructions
======================================================================
This product may be installed using Halcyon's standard installation
method or with Sun Management Center's Agent Update feature.  To
install the product with Agent Update, refer to the instructions in
the following file:

    ./AgentUpdate/README-AgentUpdate.html
                     or
    http://www.halcyoninc.com/support/README-AgentUpdate.html

NOTE:
   If you choose to use Agent Update, then all Halcyon products must be
   installed using Agent Update.  It is not possible to use Agent
   Update in conjunction with any other installation procedure.

To install the product with Halcyon's standard installation method,
continue with the instructions outlined in this section.

There are two required steps to install this product:

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


1. Server Packages (Solaris)
----------------------------------------------------------------------
To install the "PrimeAlert for Sun Directory 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/HALsmxds5_[version])
   # ./HALiDS5-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 Directory Server software is installed on
      that particular host.

      In general, the agent host packages should only be installed on
      hosts where the Sun Directory Server is installed and running.
      
Now restart the SunMC metadata agent as follows:

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


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

Note: This module needs to be installed on each system that is running
      the Sun Directory Server.

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

To install the "PrimeAlert for Sun Directory 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/HALsmxds5_[version])
   # ./HALiDS5-install.sh

Now restart the SunMC agent as follows:

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


Uninstall Instructions
======================================================================
NOTE: If the Halcyon products have been installed using Agent Update, 
      then Sun's [ESROOT]/sbin/es-uninst script MUST be used to 
      remove the Halcyon products.  If the products have been 
      installed using Halcyon's installation method, continue with the
      instructions outlined in this section.

This section explains how to uninstall the various PrimeAlert for
Sun Directory 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 Directory 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 iDS5 server


Uninstall Agent Packages
----------------------------------------------------------------------
To uninstall the PrimeAlert for Sun Directory 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 iDS5 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/log

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

      HALiDS5-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".

For trouble shooting or common module loading problems, please refer to the
following file:

   - TroubleShooting

---//---