======================================================================
           Halcyon PrimeAlert (R) ClusterWatch
                       Version 2.2.0
                          
                          README
======================================================================



Important Information
======================================================================
This product can be used to extend the functionality of the following
software:

  - Sun Management Center (Sun MC)
  - Halcyon PrimeAlert Neuron

To use this product with Neuron, refer to the README.neuron file.
For more details on Neuron, please visit our corporate website 
(http://www.halcyoninc.com).
To use this product with Sun MC, continue with the instructions
outlined in this file.



Overview
======================================================================
PrimeAlert ClusterWatch automatically disables/enables modules loaded
on an agent based on the output of a user specified script.

The primary purpose of the ClusterWatch module is to disable/enable
modules running on a clustered system based on the output of a script.

For example, a HALModScheduler-checkIP.sh script is provided that
detects whether or not a virtual IP exists on the system on which the
script is run. The script will output either "active" or "disabled" and
run based on some user specified schedule (e.g. every 2 minutes).
The user has the ability to control which modules are to be
enabled/disabled based on a regular expression match. When the
virtual IP no longer exists (a failover has occured), the script will
output "disabled" which will match the disable pattern and the list
of modules will be automatically disabled.  Conversely, when the virtual 
IP exists the script will output "active".

An alternative use of the ClusterWatch module is to provide the
ability to schedule modules based on a relative schedule
(e.g. deactivate monitoring on holidays or immediately after a
certain event) rather than an absolute schedule provided by the
attribute editor (e.g. Sundays at 5:00 PM).

For example, the provided HALModScheduler-holiday.sh script will
check whether the current date is a holiday (specified by rules in a
configuration file).  When a day is a holiday, the script will return
"Holiday" and the user specified list of modules will be disbled based
on a regular expression match.  When the script returns anything other
than "Holiday" the modules become enabled again.


This file consists of the following sections:
   - Included Components
   - Supported Platforms
   - Informational Files
   - Installation and Uninstallation
   - Troubleshooting
   - Release Notes
   - Help Documentation
   - License Agreement


Included Components
============================================================================
This distribution includes the following module:

PrimeAlert ClusterWatch


Supported Platforms
============================================================================
This module supports the following software products:
  
  Sun Management Center 3.0 - 3.6.1

The following table summarizes the platforms supported for the agent
and server components contained within this distribution:

Operating                 Base               Agent  Server  Console
System                    Product            Layer  Layer   Layer
-----------------------   -----------------  -----  ------  -------
SPARC Solaris 2.6-2.10    SunMC 3.0 - 3.6.1    x      x       
x86/x64 Solaris 2.9-2.10  SunMC 3.0 - 3.6.1    x   
Linux 2.4-2.6 		  SunMC 3.6 - 3.6.1    x    

Informational 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:

    /var/opt/SUNWsymon/install/HALClusterWatch


Installation and Uninstallation
============================================================================
For installation/uninstallation instructions, refer to the following file:

  - README.install


Troubleshooting
============================================================================
For troubleshooting information, refer to the following file:

  - TroubleShooting


Release Notes
===========================================================================
For information about bug fixes, enhancements, known problems, and 
upgrades startegies for the current release, refer to the following file:

  - ReleaseNotes


Help Documentation
============================================================================
To view the HTML help documentation, point your browser to the 
following file:

./doc/ClusterWatch/HALModScheduler-h.html

The online help is available through the Sun Management Center
console.  To view it, perform the following:

  - Open the "Host Details" window where you have loaded this module
  - Right-click on the module in the hierarchy and select "Help"


License Agreement
============================================================================
Please read the license agreement in the following file:

  - LICENSE

Without purchasing a license, this module will only operate for an 
evaluation period of 30 days from installation.

If you wish to purchase a license to use PrimeAlert ClusterWatch,
please contact us at:


   Web:   http://www.HalcyonInc.com
   Email: info@HalcyonInc.com

   Tel:   416-932-4647
   Fax:   416-932-4711

---//---
</pre>