======================================================================
Halcyon Neuron Agent for Linux
Version 3.3.0
README.install
======================================================================
Overview
======================================================================
This README.install file describes how to install and setup the
Halcyon Neuron Agent for Linux.
It consists of the following sections:
- Installation Instructions
. Definitions
. Requirements
. Extracting the Distribution File
. Installing the Agent
. Installation Log File
- Uninstallation Instructions
. Uninstallation Log File
Installation Instructions
======================================================================
Definitions
----------------------------------------------------------------------
PAROOT This environment variable contains the directory
where the agent binaries, libraries and default
configuration files are installed. The value of
PAROOT is "/opt/Neuron".
PADIR This environment variable contains the directory
where the agent stores configuration and log files.
The value of PADIR is "/var/opt/Neuron".
Agent Host A host where a Neuron Agent is installed and
running. This host must be a Linux host, and it
contains the package HALnialag.
Requirements
----------------------------------------------------------------------
This agent has been tested on:
Red Hat Linux Enterprise 2.1 - 5.5 (32-bit and 64-bit)
SUSE Linux Enterprise 8.0 - 11.1 (32-bit and 64-bit)
Oracle Enterprise Linux 5.5 (32-bit and 64-bit)
Note: Halcyon officially supports the versions listed above as the
product was tested against these versions. It is possible
that the product may function correctly with other versions.
Extracting the Distribution File
----------------------------------------------------------------------
The Neuron Agent for Linux distribution file,
HALNeuronLinux_[version].tar.(Z|gz), must be extracted on a Linux 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 -
# mkdir -p /tmp/install
# cd /tmp/install
# uncompress HALNeuronLinux_[version].tar.Z
or gzip -d HALNeuronLinux_[version].tar.gz
# tar xvf HALNeuronLinux_[version].tar
In this case, the directory /tmp/install/HALNeuronLinux_[version] represents
the installation source directory, [SOURCE_DIR], which is referenced
below.
Installing the Agent
----------------------------------------------------------------------
The procedure described in this sub-section should be performed on any
Linux host that is being upgraded to the latest version of the
Neuron Agent for Linux, or that is receiving the Neuron Agent for
Linux for the first time.
Login to a Linux host as root. Extract the Neuron Agent for Linux
distribution file (see the above section 'Extracting the Distribution
File') in a temporary location, and then run the script
HALNeuronLinux-install.sh, e.g.:
$ su -
# cd [SOURCE_DIR]
# ./HALNeuronLinux-install.sh -n
The following packages are installed or upgraded by the installation
script:
- HALniasag
- HALnmaevt
- HALnmahtp
- HALnmassa
- HALnmamib
- HALnmaast
- HALnmadir
- HALnmafil
- HALnmalog
- HALnmaprc
- HALnmarrd
- HALnmarpt
- HALnmaweb
- HALnmakit
During installation, you are requested to enter the following
information:
- User name and group name. The Neuron agent runs under the
user selected at install time. The selected user can be either
root or non-root. In addition, files under both the Neuron
install directory and configuration directory are owned by
the selected user and group. Please note: in order for
some Neuron modules to function properly, additional privileges
should be granted to the selected user. Please see the
Troubleshooting file for additional details.
- HTTP Port: The HTTP Port used by the agent. The default value
is 6680.
- Agent Port: The SNMP port used by the agent. The default
value is 6681.
- SNMP manager host/port: If you elect to send SNMP traps to
a manager, you will be prompted for the hostname and port of
a machine which will receive an SNMP trap for each agent event.
See the README file for an explanation of events.
- Module setup: If you elect to setup modules, the module loader
utility will start and you will be given a menu with options to
load, unload or edit modules. See the README file for further
details.
After the previous information has been provided, the install script
modifies the following configuration files:
$PADIR/cfg/domain-config.x
$PADIR/cfg/HALEventTarget-config.x
These files are the main configuration files for your Neuron Agent.
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 Neuron Agent for Linux.
At this stage, the installation of the Neuron 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 "na" script
controls the agent. Use the following commands to control the agent:
- na start agent: Starts the Neuron Agent.
- na stop agent: Stops the Neuron Agent.
- na restart agent: Restarts the Neuron Agent (stop and start).
- na status agent: Prints the status of the Neuron Agent
(is the agent running or not).
The shell script can be found in $PAROOT/bin.
Installation Log File
----------------------------------------------------------------------
To view the installation log on a Linux host, see the file:
$PADIR/install/HALNeuronLinux-install_[YYYYMMDD]-[HHMMSS].log
Uninstallation Instructions
======================================================================
NOTE: Before removing the Neuron Agent for Linux, first remove all
modules that are installed on the host.
First, stop the Neuron Agent for Linux process on the agent host
by issuing the following commands as root:
$ su -
# cd $PAROOT/bin
# ./na stop agent
Then, issue the following commands to uninstall the agent:
# cd $PADIR/uninstall
# ./HALUninstall.sh
Uninstallation removes the following packages:
- HALniasag
- HALnmaevt
- HALnmahtp
- HALnmassa
- HALnmamib
- HALnmaast
- HALnmadir
- HALnmafil
- HALnmalog
- HALnmaprc
- HALnmarrd
- HALnmarpt
- HALnmaweb
- HALnmakit
Uninstallation Log File
----------------------------------------------------------------------
To view the uninstallation log on a Linux host, see the file:
$PADIR/uninstall/log/uninstall.log.[YYYYMMDD]-[HHMMSS]
---//---