======================================================================
Halcyon PrimeAlert (R) Event Gateway
Version 1.2.0
README.install
======================================================================
This README.install file describes how to install and setup the
PrimeAlert Event Gateway module for Sun Management Center (SunMC).
It consists of the following sections:
- Definitions
- Overview
- Extracting the Distribution
- Installation Instructions
. Server Packages
. Agent Packages
. Zone Configuration
- 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. This system must be a Solaris host, and
contain the package SUNWesagt (SunMC agent on
Solaris).
(Note: Sparse root zones available on Solaris 10+ systems
do not require SUNWesagt but SunMC agents should be
configured before enabling zone support for this product.)
ESROOT: This parameter only applies for a Solaris
installation host. This directory is determined by
the user while installing Sun MC; the default value
is $ESROOT. To determine the value of $ESROOT on a
SunMC agent host, run the following command (for Solaris
10+ zoned environment, run the following command in a
non-sparse root zone):
# echo "`pkgparam SUNWesagt BASEDIR`/SUNWsymon"
Overview
======================================================================
PrimeAlert Event Gateway accepts and logs SNMP traps from hosts within
a network to either open or close SUN MC alarm events.
Extracting the Distribution
======================================================================
The PrimeAlert Event Gateway distribution file,
HALsmxevg_[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 would be:
% su -
# cd /tmp
# gzip -d HALsmxevg_[version].tar.gz
# tar -xvf HALsmxevg_[version].tar
Following the example above, the source directory [EXTRACT_DIR] would
be the following:
/tmp/HALsmxevg_[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
3. Zone configuration (optional)
1. Server Packages (Solaris)
----------------------------------------------------------------------
To install the "PrimeAlert Event Gateway" 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
4. Restart the SunMC metadata agent
% su -
# cd [EXTRACT_DIR] (i.e. /tmp/HALsmxevg_[version])
# ./HALEventGateway-install.sh
Now restart the SunMC metadata agent as follows:
# $ESROOT/sbin/es-stop -m
# $ESROOT/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 server host packages should be installed or upgraded before
any of the agent host packages.
To install the "PrimeAlert Event Gateway" 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/HALsmxevg_[version])
# ./HALEventGateway-install.sh
Now restart the SunMC agent as follows:
# $ESROOT/sbin/es-stop -a
# $ESROOT/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 the same way as in a global zone.
If you would like to use this product in a Solaris sparse root zoned
environment, ensure SunMC agent is configured in the sparse root zone.
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
======================================================================
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 Event
Gateway 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 Event Gateway 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 EventGateway server
Uninstall Agent Packages
----------------------------------------------------------------------
To uninstall the PrimeAlert Event Gateway 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 EventGateway 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:
HALEventAction-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 solutions to common module loading problems, please refer to the
following file:
- TroubleShooting
---//---
</pre>