======================================================================
Halcyon PrimeAlert (R) Agent for Windows
Version 5.2.0
For use with Sun Management Center
README.install
======================================================================
Overview
======================================================================
This README.install file describes how to install and setup the
PrimeAlert Agent for Windows.
It consists of the following sections:
- Overview
. Definitions
. Requirements
- Extracting the Distribution
- Installation Instructions
. Server Packages
. Agent Packages
. Install Logs
- Uninstallation Instructions
. Server Packages
. Agent Packages
. Uninstall Logs
Definitions
----------------------------------------------------------------------
<INSTALLDIR> On a Windows host, the user-selected installation
directory for the PrimeAlert Agent for Windows. The
default value is
C:\Program Files\Halcyon\PrimeAlert.
Server Host: A host where the Sun Management Center server is
installed and running. This host must be a Solaris
host, and it contains the package SUNWessrv.
Agent Host: The host where the PrimeAlert Agent for Windows is
installed and running.
Console Host: A host where the Sun Management Center console is
installed and running. If this host is a Solaris
host, it contains the package SUNWescon; it may
also be a host running Windows.
Requirements
----------------------------------------------------------------------
The PrimeAlert Agent for Windows is intended for use on Windows 2000 or
later.
If the PrimeAlert Agent is being installed on a host that is currently
running Microsoft SQL Server, it is recommended that the host be
rebooted after the PrimeAlert Agent is installed.
For Windows 2000 - In order for the Agent to function properly, it is
highly recommended that Service Pack 1 or later be applied.
In addition to the PrimeAlert Agent, a Sun Management Center 3.0 or
later server layer and a Sun Management Center 3.0 or later console
layer (Solaris or Windows) are needed.
Extracting the Distribution
======================================================================
The PrimeAlert Agent for Windows distribution file,
HALWinAgent_5.2.0.tar.gz, must be extracted on a Solaris host before
any packages can be installed. For example, assume that the
distribution file has been copied to the /tmp/install directory, and
will be extracted there. In this case, the procedure for extracting the
distribution file is:
% su -
# cd /tmp/install
# gzip -d HALWinAgent_5.2.0.tar.gz
# tar xvf HALWinAgent_5.2.0.tar
In this case, the directory /tmp/install/HALWinAgent_5.2.0 represents
the installation source directory, <SOURCE_DIR> which is referenced
below.
Installation Instructions
======================================================================
Server Layer Packages (Solaris)
----------------------------------------------------------------------
The procedure described in this sub-section should be performed on the
Sun Management Center server layer host only.
Note that server layer packages should be installed/upgraded before
the agent layer packages are installed/upgraded.
Login to the Sun Management Center server host as root. Extract the
PrimeAlert Agent for Windows distribution file (see the above section
'Extracting the Distribution File') in a temporary location, and then
run the script HALWinAgent-install.sh, e.g.:
% su -
# cd <SOURCE_DIR>
# ./HALWinAgent-install.sh -s
Agent Layer Packages (Windows)
----------------------------------------------------------------------
The procedure described in this sub-section should be performed on
any Windows agent host that is being upgraded to the latest version
of the PrimeAlert Agent for Windows, or that is receiving packages
for the first time.
SECURITY NOTE - If the agent layer of the PrimeAlert Agent for Windows
is installed on a Windows drive that has a FAT filesystem (and not an
NTFS filesystem), then the agent files will be readable and writable by
any user that can log into the agent host, even if the user does not
have administrative privileges. Thus, it is highly recommended that the
agent layer be installed on a drive that contains an NTFS filesystem,
so that proper access control rules apply.
INSTALLATION PROCEDURE - The steps to be followed are:
1. Extract the PrimeAlert Agent for Windows distribution file (see the
above section 'Extracting the Distribution File') on a Solaris
host. In this case, the InstallShield installer for Windows has the
pathname:
<SOURCE_DIR>packages/win32/HALWinAgent_5.2.0.exe
2. Copy the Windows InstallShield installer to a convenient location
(<path> on the Windows agent host.
3. If present, remove the currently installed console/agent packages
for the PrimeAlert Agent for Windows (see the following section
'Removing Agent Layer Packages - Windows').
4. The Halcyon PrimeAlert Agent runs as a Windows service. As with
all services, it is possible to specify the account (username
and password) under which the service executes. It is recommended
that a Windows user be created exclusively for running the
PrimeAlert Agent. Any user created to run the Agent service
must be part of the local Administrators group and the account's
password must set to never expire.
Running the PrimeAlert Agent as user LocalSystem (with account
.\SYSTEM) is being discouraged due to security concerns. Consult
Microsoft's web site for more details.
The Setup program should be run by the local administrator or by a
person who is member of the local or domain administrator group. If
the user who is performing the installation does not have
administrative privileges, installation may not be successful.
During installation, Setup attempts to set file permissions for the
user that was specified. If the installation drive contains an NTFS
filesystem, the following security scheme is applied:
Private Directories (<INSTALLDIR>local\bin, <INSTALLDIR>local\cfg):
Everyone: No Access
<hostname>Administrators: Full Control
Agent Service User: Full Control
Public Directories (<INSTALLDIR>install, <INSTALLDIR>local\log):
Everyone: Readable
<hostname>Administrators: Full Control
Agent Service User: Full Control
If you would like to choose different permissions, please set them
in the installation directory, <INSTALLDIR> and its subdirectories.
In order for the service to execute the PrimeAlert Agent, it is
required that the specified user has the right to log-on as a
service. This right can be granted with the "Log as a service"
option in the "LocalPolicies"/"User Rights Assignment" folder that
is available from the Local Security Policy Management Console.
To open Local Security Policy, click Start, click Control Panel,
click Performance and Maintenance, click Administrative Tools,
and then double-click Local Security Policy.
For Windows XP/2003 if you select an account that does not have
permission to log on as a service, Services automatically grants
the appropriate permissions to that account on the computer that
you are managing.
5. Run the InstallShield package HALWinAgent_5.2.0.exe, for example:
Start->Run... <path>HALWinAgent_5.2.0.exe
Follow the instructions presented on screen.
6. During installation of the PrimeAlert Agent for Windows, the
following information must be entered to configure the server
host and the SNMP user table for the agent:
- Agent Port: The port the PrimeAlert Agent will use to communicate
with the server host. The default value is 161.
- Super User Seed: The seed that was used when installing the Sun
Management Center server layer. The default value is
"maplesyrup". You can select the default seed by clicking on
'default'. Note: If you select the default option for the Super
User Seed, the default value for the Public User Seed will also
be employed. Likewise, if you de-select the default option, then
values must be entered manually for both the Super User Seed and
the Public User Seed.
Note: Sun Management Center version 3.6 and above allows a seed
with a maximum length of 16. For versions prior to 3.6
the maximum length of the seed was 8 characters.
- Public User Seed: This seed normally has the default value of
"public". You can select the default seed by clicking on
'default'.
- User Name: This is the account under which the PrimeAlert Agent
is to be run. It must be a user known to Windows or the special
account LocalSystem, for example YOURDOMAIN\PrimeAlert. You can
select a user from your domain by clicking on 'Select User'.
- Password: The password of the account for the PrimeAlert Agent.
This password is for the User Name above. Note: If you use the
default User Name, LocalSystem, do not provide a password, as it
is not needed.
- Trap Server: The hostname of the machine where the Sun Management
Center server layer 'trap server' is running.
- Trap Server Port: The port number of the trap server. The default
value is 162.
- Event Server: The hostname of the machine where the Sun
Management Center server layer 'event server' is running.
- Event Server Port: The port number of the event server. The
default value is 163.
During installation you can choose to start the 'Halcyon PrimeAlert
Agent' service. To manually start and stop the agent select:
Start -> Settings -> Control Panel -> Administrative Tools ->
Services -> Halcyon PrimeAlert Agent -> Start/Stop
or from the Windows command line:
> net start "Halcyon PrimeAlert Agent"
> net stop "Halcyon PrimeAlert Agent"
Agent Layer Installation Problems (Windows)
----------------------------------------------------------------------
If the installation program reports that it could not start the
PrimeAlert Agent service due to a log-on error, ensure that the user
for the PrimeAlert Agent service is valid and has the right to log on
as a service (see Item 4 of the previous sub-section).
---
If the console and/or server cannot communicate with the agent, verify
that the agent has been seeded. This can be done by checking for the
existence of the file <INSTALLDIR>local\cfg\agent-engine-d.dat. To
perform a manual seed, halt the Halcyon PrimeAlert Agent service, and
then run the following commands in a Command Prompt window:
cd <INSTALLDIR>local\cfg
..\..\install\sbin\paAgent - tool usm-seed -s <seed> -p <public> agent
where <seed> is the super-user seed that was used during installation
of the Sun Management Center server layer, and <public> is the public
user seed (default "public"). Make sure that the above command is run
by a user who has full control in the <INSTALLDIR> directory and its
subdirectories.
After reseeding the agent, restart the Halcyon PrimeAlert Agent service.
Installation Log File (Solaris)
----------------------------------------------------------------------
To view the installation log on a Solaris host, see the file:
/var/opt/SUNWsymon/install/HALWinAgent-install_<YYYYMMDD><HHMMSS>log
Uninstallation Instructions
======================================================================
This section explains how to uninstall the various PrimeAlert
Windows Agent components:
1. Uninstall the server host packages
2. Uninstall the console host packages from previous versions of the agent
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
To manually uninstall the product on a Solaris system, use the "pkgrm"
command with the name of the packages to be removed as arguments. Refer
to the "Installation Instructions" section to determine the various packages
installed.
# pkgrm <PKG_1> <PKG_2> ... <PKG_N>
Removing Server Layer Packages (Solaris)
----------------------------------------------------------------------
The procedure described in this sub-section should be performed on the
Sun Management Center server layer host only.
Login to the Sun Management Center server host as root, and then run
the following commands:
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module WinAgent server
Removing Agent Layer Packages (Windows)
----------------------------------------------------------------------
The procedure described in this sub-section should be performed on any
Windows host where the PrimeAlert Agent for Windows is to be removed.
1. Stop the 'Halcyon PrimeAlert Agent' service:
Start -> Settings -> Control Panel -> Administrative Tools ->
Services -> Halcyon PrimeAlert Agent -> Stop
or from the Windows command line:
> net stop "Halcyon PrimeAlert Agent"
2. Go to the Windows Start menu and select:
Start -> Settings -> Control Panel
A new Control Panel window will appear on your screen.
3. Double-click on the "Add/Remove Programs" icon in the Control Panel
window. A new window labeled "Add/Remove Programs (Properties)" will
appear.
4. Select "Halcyon PrimeAlert Agent for Windows" in the scrolling list
of the new window.
Click on the "Change/Remove" button.
An UnInstallShield session will be launched; follow the instructions
presented on screen.
Uninstallation Log File (Solaris)
----------------------------------------------------------------------
To view the uninstallation log on a Solaris host, see the file:
/var/opt/SUNWsymon/uninstall/log/uninstall.log.<YYYYMMDD><HHMMSS>
---//---