Halcyon PrimeAlert (R) Agent for Linux
Version 5.2.3
For use with Sun Management Center
README.install
-----------------------------------------------------------------------
Nomenclature
============
- Halcyon has developed 'PrimeAlert Agents' for a number of platforms
(Windows, HP-UX, and Linux) that allow non-Solaris
hosts to be monitored by Sun Management Center (Sun MC).
Supported Platforms
===================
The following table summarizes the platform support for the various
components contained within this distribution:
Operating Base Agent Server Console
System Product Layer Layer Layer
---------------------------------- ------------------- ----- ------ -------
Red Hat Linux 7.2 - 9.0 PrimeAlert Agent x
Sun Java Desktop System 1.0 PrimeAlert Agent x
Red Hat Linux Enterprise 2.1 - 3.0 PrimeAlert Agent x
(32-bit and 64-bit)
SUSE Linux Enterprise 8.0 PrimeAlert Agent x
(32-bit and 64-bit)
SUSE Linux Professional 9.0 PrimeAlert Agent x
(32-bit and 64-bit)
Solaris 2.8 - 2.10 Sun MC 3.5 - 4.0 x x
Windows 2000/XP Sun MC 3.5 Update 1 x
Installation Instructions
=========================
Definitions
-----------
Server Host: The host where the Sun Management Center server is
installed and running. This host must be a Solaris
host, and it contains the package SUNWessrv.
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 Windows host.
Agent Host: A host where the PrimeAlert Agent for Linux is
to be installed or upgraded.
Requirements
------------
In addition to the PrimeAlert Agent for Linux, Sun Management Center 3.5 Update 1
server layer and console layer (Solaris or Windows) are needed.
Extracting the Distribution File
--------------------------------
The PrimeAlert Agent for Linux distribution file,
HALLinuxAgent_5.2.3.tar.(gz|Z), must be extracted 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 HALLinuxAgent_5.2.3.tar.gz
# tar xvf HALLinuxAgent_5.2.3.tar
In this case, the directory /tmp/install/HALLinuxAgent_5.2.3 represents
the installation source directory, <SOURCE_DIR>, which is referenced
below.
Server Layer Packages - Solaris Only
------------------------------------
The procedure described in this sub-section should be performed on the
Sun MC Server Host only.
Note that server layer packages should be installed/upgraded before
agent or console layer packages are installed/upgraded.
Login to the Sun Management Center server host as root. Extract the
PrimeAlert Agent for Linux distribution file (see the above section
'Extracting the Distribution File') in a temporary location, and then
run the script HALLinuxAgent-install.sh, e.g.:
% su -
# cd <SOURCE_DIR>
# ./HALLinuxAgent-install.sh -s
Console Layer Packages - Solaris
--------------------------------
The procedure described in this sub-section should be performed on
Sun MC Console Host(s).
Login to a Sun Management Center console host as root. Extract the
PrimeAlert Agent for Linux distribution file (see the above section
'Extracting the Distribution File') in a temporary location, and then
run the script HALLinuxAgent-install.sh, e.g.:
% su -
# cd <SOURCE_DIR>
# ./HALLinuxAgent-install.sh -c
The local Sun MC console should be restarted after installation.
Console Layer Packages - Windows
--------------------------------
The procedure described in this sub-section should be performed on
Sun MC Console Host(s).
1 - Extract the PrimeAlert Agent for Linux 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/HALLinuxAgent_5.2.3.exe
2 - Copy the Windows InstallShield installer to a convenient location
(<path>) on the Windows console host.
3 - If present, remove the currently installed console package for the
PrimeAlert Agent for Linux (see the following section 'Removing
Console Layer Packages - Windows').
4 - Run the InstallShield package HALLinuxAgent_5.2.3.exe, for example:
Start->Run... <path>\HALLinuxAgent_5.2.3.exe
Follow the instructions presented on screen.
The installation program also creates shortcuts under:
Start Menu -> Programs -> Halcyon
These shortcuts provide easy access to help files for the
three modules included with the PrimeAlert Agent for Linux.
The local Sun MC console should be restarted after installation.
Agent Layer Packages - Linux Only
---------------------------------
The procedure described in this sub-section should be performed on
PrimeAlert Agent Host(s).
Login to the Linux host as root. Extract the PrimeAlert Agent for Linux
distribution file (see the above section 'Extracting the Distribution
File') in a temporary location, and then run the script
HALLinuxAgent-install.sh, e.g.:
% su -
# cd <SOURCE_DIR>
# ./HALLinuxAgent-install.sh -a
If you are doing an initial install, you are requested to enter the
following parameters:
- PrimeAlert Agent Hostname/IP: is the hostname or IP address of the
agent host which correspond to the NIC and IP address through which
communication with the Sun MC Server occurs. The Sun MC server must
be able to resolve the IP from hostname and vice versa. Failure to
properly specify this entry may result in unauthenticated
communication between the server and the agent.
- PrimeAlert Agent Port: This is the port used by the server to
communicate with the PrimeAlert Agent. The default value is 161.
Press <ENTER> if you want to keep the default, or specify a
different port.
- SunMC Trap Server: This is the name of the host that runs the Sun MC
Trap Server component. This can only be a Solaris host. Therefore,
no default value is provided. Typically, the trap server runs on
the server layer host.
- SunMC Trap Port: This is the port used by the PrimeAlert Agent for
Linux to communicate with the Sun MC Trap Server. The default value
is 162. Press <ENTER> if you want to keep the default, or specify a
different port.
- SunMC Event Server: This is the name of the host that runs the
Sun MC Event Server component. This can only be a Solaris host. The
default value is the hostname you provided for the Sun MC Trap
Server, since the server components usually reside on the same
host. Press <ENTER> if you want to keep the default, or specify a
different hostname.
- SunMC Event Port: This is the port used by the PrimeAlert Agent for
Linux to communicate with the Sun MC Event Server. The default value
is 163. Press <ENTER> if you want to keep the default, or specify a
different port.
- Seed: This is the seed you used when you installed the Sun MC server
components. In order for the PrimeAlert Agent for Linux to function
correctly, you have to specify the same seed. The default value is
"maplesyrup". Press <ENTER> if you want to keep the default, or
specify a different seed.
After the previous information has been provided, the install script
modifies the file /var/opt/PrimeAlert/cfg/domain-config.x. This file
is used as the main configuration file for your PrimeAlert Agent.
The install script also seeds the PrimeAlert Agent for Linux with the
seed you provided above.
Finally, the install script displays some information on additional
shell scripts that can be used to start, stop, or inquire about the
status of the PrimeAlert Agent for Linux.
At this stage, the installation of the PrimeAlert Agent component is
complete. No host reboot is required. If you have upgraded the agent
or any of its bundled modules, the agent must be restarted. For an
initial install, the agent must simply be started. The agent is
controlled by the pa script. Use the following commands to control
the agent:
- To Start the PrimeAlert Agent
# /opt/PrimeAlert/bin/pa start agent
- To stop the PrimeAlert Agent
# /opt/PrimeAlert/bin/pa stop agent
- To restart the PrimeAlert Agent (stop and start).
# /opt/PrimeAlert/bin/pa restart agent
- To print the status of the PrimeAlert Agent
# /opt/PrimeAlert/bin/pa status agent
Note that after starting the agent for the first time, you must
wait 5-10 minutes for the server and agent to authenticate with
one-another before attempting to manage the host through the
console.
Installation Problems
---------------------
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 /var/opt/PrimeAlert/cfg/agent-engine-d.dat on the
Linux agent host.
Remember that you must wait 5-10 minutes after starting a newly
installed or re-seeded agent before it and the server authenticate
one-another.
Remember that you must add the Linux agent to the topology first as
an "Snmp Ping" type object, then change that object (modify) it to
a "Sun MC Host" type object.
To perform a manual seeding on the Linux agent host, do the following
as root on the Agent Host:
# /opt/PrimeAlert/bin/pa usm-seed -s <seed> [ -u <community> ] agent
where <seed> is the seed value that was used during the installation of
the Sun Management Center server layer, and <community> is the SNMPv1
community being used by the server layer (optional). After the
PrimeAlert Agent for Linux has been re-seeded, it must be restarted.
Note that no other processes need to be restarted on any other hosts.
Once again remember to wait 5-10 minutes before attempting console
actions.
Note that if you have changed the IP address or snmp Port of the
agent process, you will likely need to delete the existing
topology host object, and re-create it.
Installation Log File - Solaris/Linux
-------------------------------------
To view the installation log on a Solaris/Linux host, see the file:
On Solaris:
/var/opt/SUNWsymon/install/HALLinuxAgent-install_<YYYYMMDD>-<HHMMSS>.log
On Linux:
/var/opt/PrimeAlert/install/HALLinuxAgent-install_<YYYYMMDD>-<HHMMSS>.log
Uninstallation Instructions
===========================
NOTE: Before removing the PrimeAlert Agent for Linux, first remove all
the Halcyon PrimeAlert add-on modules that are installed on the
Linux Agent Host.
Removing Server Layer Packages - Solaris
----------------------------------------
The procedure described in this sub-section should be performed on the
Sun MC Server Host where packages for the PrimeAlert Agent for Linux
are to be removed.
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 LinuxAgent server
Removing Console Layer Packages - Solaris
-----------------------------------------
The procedure described in this sub-section should be performed on
Sun MC Console Host(s) where packages for the PrimeAlert Agent for Linux
are to be removed.
Login to a Sun Management Center console host as root, and then run
the following commands:
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module LinuxAgent console
It is not necessary to restart the local Sun MC console after package
uninstallation.
Removing Console Layer Packages - Windows
-----------------------------------------
The procedure described in this sub-section should be performed on
Sun MC Console Host(s) where the PrimeAlert Agent for Linux
is to be removed.
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 Agent for Linux" in the scrolling list
of the new window and click on the "Change/Remove" button.
An UnInstallShield session will be launched; follow the instructions
presented on screen.
Removing Agent Layer Packages
-----------------------------
The procedure described in this sub-section can be performed on
Agent Host(s) where PrimeAlert Agent for Linux is no longer required.
First, stop the PrimeAlert Agent for Linux process on the Linux host
by issuing the following commands as root:
% su -
# cd /opt/PrimeAlert/bin/pa stop agent
Then, issue the following commands to uninstall the agent:
# cd /var/opt/PrimeAlert/uninstall
# ./HALUninstall.sh -module LinuxAgent agent
If the uninstall script fails for any reason
do the following manual steps:
# rpm -qa | grep HALp
If the above finds any Halcyon package, do the following
for each package found:
# rpm -e <package>
If the above complains about a package, try the following:
# rpm -e --noscripts <package>
Then run the following if you are attempting to uninstall all the
halcyon modules:
# rm -rf /opt/PrimeAlert/
And finally do this if you want to wipe out any configuration information
(loaded module lists, logfiles, customized alarm thresholds/actions, etc).
# rm -rf /var/opt/PrimeAlert/
Uninstallation Log File - UNIX Only
-----------------------------------
To view the uninstallation log on a Solaris/Linux host, see the file:
On Solaris:
/var/opt/SUNWsymon/uninstall/log/uninstall.log.<YYYYMMDD>-<HHMMSS>
On Linux:
/var/opt/PrimeAlert/uninstall/log/uninstall.log.<YYYYMMDD>-<HHMMSS>
---//---