======================================================================
Halcyon PrimeAlert (R) Reporter
Version 2.3.0
README.install
-----------------------------------------------------------------------
Overview
======================================================================
This README.install file describes how to install and setup
PrimeAlert Reporter and PrimeAlert WebPortal.
It consists of the following sections:
- Definitions
- Upgrade Information
- Extracting the Distribution
- Preinstallation Information
- Installation Instructions
. Server Packages (Solaris)
. Agent Packages (Solaris)
. Agent Packages (Windows)
. Zone Configuration (optional)
- Uninstallation Instructions
. Server Packages (Solaris)
. Agent Packages (Solaris)
. Agent Packages (Windows)
- 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.
Console Host A host where the Sun Management Center Console is
installed and running. This system may be a Solaris or
a windows host. On Solaris is contains the package
SUNWescon.
ESROOT For Sun Management Center (Sun MC) 3.5 or higher, this
directory is determined by the user while installing
Sun MC; the default value is /opt/SUNWsymon. To
determine the value of ESROOT on a Sun MC agent host,
run the command (for Solaris 10+ zoned environment,
run the following command in a non-sparse root zone):
# echo "`pkgparam SUNWesagt BASEDIR`/SUNWsymon"
On a Windows host, the user-selected installation
directory for the PrimeAlert Agent for Windows. The
default value is
C:\Program Files\Halcyon\PrimeAlert\install
LOCALDIR The configuration and logfile directory specified during
installation. To determine <LOCALDIR> after installation,
issue the command on a Solaris host:
# pkgparam HALsmsptl LOCALDIR
For a Windows host running the PrimeAlert Agent for Windows
the default value is the following:
C:\Program Files\Halcyon\PrimeAlert\local
Upgrade Information
======================================================================
If an existing installation of PrimeAlert Reporter or PrimeAlert
WebPortal is being upgraded, it is recommended that the UPGRADE
STRATEGY section of the ReleaseNotes file be consulted prior to
installing any packages.
Extracting the Distribution File
======================================================================
The PrimeAlert Reporter distribution file,
HALReporter_[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 HALReporter_[version].tar.gz
# tar xvf HALReporter_[version].tar
Following the example above, the source directory <EXTRACT_DIR> would
be the following:
/tmp/HALReporter_[version]
Preinstallation Information
======================================================================
Gateway Port
The default gateway port is 26680. If this port is in use, then
after installation you must specify a new port in the files:
On a Solaris host:
/var/opt/SUNWsymon/cfg/HALReport-user-config.x and
/var/opt/SUNWsymon/cfg/HALReport-gatway.conf.
On a Windows host:
C:\Program Files\Halcyon\PrimeAlert\local\cfg\HALReport-user-config.x and
C:\Program Files\Halcyon\PrimeAlert\local\cfg\HALReport-gatway.conf.
Disk Requirements
See the 'Maintaining PrimeAlert Reporter Databases' section of
the README file.
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 and one optional step 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 Reporter" 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 Agent and Metadata process.
% su -
# cd [EXTRACT_DIR] (i.e. /tmp/HALReporter_[version])
# ./HALReporter-install.sh
# $ESROOT/sbin/es-stop -ma
# $ESROOT/sbin/es-start -ma
After the packages are installed, start the Apache Tomcat server by
issuing the commands:
% su -
# $ESROOT/HALsmsptl/bin/webportal start
Point your web browser to the URL indicated during installation to
begin using the PrimeAlert WebPortal.
2. Agent Packages (Solaris)
----------------------------------------------------------------------
The installation of the Agent host packages is similiar to the Server
host packages installation.
Note: The Server host packages should be installed or upgraded before
any of the Agent packages.
The procedure described in this sub-section should be performed
on any Sun Management Center agent host for which the reporting
functionality of PrimeAlert Reporter is desired.
To install the "PrimeAlert Reporter" 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/HALReporter_[version])
# ./HALReporter-install.sh
# $ESROOT/sbin/es-stop -a
# $ESROOT/sbin/es-start -a
3. Zone Configuration (optional)
----------------------------------------------------------------------
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
3. Agent Packages (Windows)
----------------------------------------------------------------------
To install the "PrimeAlert Reporter" module packages on the
PrimeAlert Agent for Windows host, do the following:
1. Extract the distribution file on a UNIX host. In this case, the
InstallShield installer for Windows has the pathname:
<SOURCE_DIR>/packages/win32/HALReporter_[version].exe
2. Copy the Windows InstallShield installer to a convenient location
([path]) on the Windows agent host.
3. Run the InstallShield package HALReporter_[version].exe, for
example:
Start->Run... [path]\HALReporter_[version].exe
Follow the instructions presented on screen.
4. Restart the PrimeAlert Agent for Windows by entering the
following in command prompt:
# net stop "halcyon primealert agent"
# net start "halcyon primealert agent"
4. Zone Configuration (optional)
----------------------------------------------------------------------
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
======================================================================
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 unistall the various PrimeAlert Reporter
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 (Solaris)
----------------------------------------------------------------------
To uninstall the PrimeAlert Reporter packages on the Sun Management
Center Agent 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 Reporter server
Uninstall Agent Packages (Solaris)
----------------------------------------------------------------------
To uninstall the PrimeAlert Reporter 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 Reporter agent
NOTE: After the agent layer packages for PrimeAlert Reporter are
removed from a host, a number of database files will still remain in
two directories (default):
- /var/opt/SUNWsymon/db/rrd
- /var/opt/SUNWsymon/db/ps
If desired, the rrd and ps directories noted above can be deleted after
the PrimeAlert Reporter agent packages are removed.
Uninstall Agent Packages (Windows)
----------------------------------------------------------------------
To uninstall the PrimeAlert Reporter packages on the PrimeAlert for
Windows host, do the following:
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 Reporter" in the
scrolling list of the new window.
Windows NT 4 --
Click on the "Add/Remove..." button.
Windows 2000/XP/2003 --
Click on the "Change/Remove" button.
An UninstallShield session will be launched; follow the instructions
presented on screen.
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:
HALReporter-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
---//---