======================================================================
Halcyon Monitoring Solutions
www.HalcyonInc.com
Halcyon Neuron Core
Version 1.8.0
README.install
======================================================================
Overview
======================================================================
This README.install file describes how to install and setup the
Halcyon Neuron Core.
It consists of the following sections:
- Definitions
- Extracting the Distribution File
- Installation Instructions
. Server Packages (Solaris)
- Halcyon Forums
- Uninstallation Instructions
. Server Packages (Solaris)
- Install & Uninstall Logs
Definitions
======================================================================
Installation Host The host where the Halcyon Neuron Core is to be
installed. This system must be a Solaris host,
and contain the package SUNWcsr.
BASEDIR The base directory where the Halcyon Neuron
Core was installed. The default value is
/opt/HMF. To determine the value of BASEDIR run
the command (for Solaris 10+ zoned environment,
run the following command in a non-sparse root
zone):
# echo "`pkgparam HALhmfcon BASEDIR`/HMF"
LOCALDIR The configuration and logfile directory of the
Halcyon Neuron Core. By default this is
/var/opt/HMF
To determine [LOCALDIR] after installation,
issue the command (for Solaris 10+ zoned
environment, run the following command in a
non-sparse root zone):
# pkgparam HALhmfcon LOCALDIR
Extracting the Distribution File
======================================================================
The Halcyon Neuron Core distribution file,
Halcyon_Neuron_Core_[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
/var/tmp
In this case, the procedure for extracting the distribution will be:
% su -
# cd /var/tmp
# gzip -d Halcyon_Neuron_Core_[version].tar.gz
# tar xvf Halcyon_Neuron_Core_[version].tar
Following the example above, the source directory [EXTRACT_DIR] would
be the following:
/var/tmp/Halcyon_Neuron_Core_[version]
Installation Instructions
======================================================================
There is one required step to install this product:
1. Install the Server host packages
1. Server Packages (Solaris)
----------------------------------------------------------------------
To install the "Halcyon Neuron Core" packages on a Solaris
host, do the following:
1. Become the "root" user on the Solaris host
2. Extract the distribution file
3. Run the install script
% su -
# cd [EXTRACT_DIR] (i.e. /var/tmp/Halcyon_Neuron_Core_[version])
# ./Halcyon_Neuron_Core-install.sh
After the packages are installed, start the Halcyon Neuron Core
by issuing the commands:
% su -
# [BASEDIR]/bin/NeuronCore start
or
# [BASEDIR]/bin/NeuronCoreStart
On Solaris versions that support the Service Management Facility (SMF)
Neuron Core installs its start-stop script as a service. The Fault
Managed Resource Identifier (FMRI) is application/management/neuroncore.
When Neuron Core is started or stopped it enables or disables the
service, respectively. If Neuron Core was running and the host is
rebooted Neuron Core will be started by the SMF master restarter.
The regular commands for enabling or disabling the service can be used
alongside the Neuron Core script. Execute the following commands to
enable or disable the Neuron Core service:
% su -
# svcadm enable application/management/neuroncore
or
# svcadm disable application/management/neuroncore
Output of the SMF command and the Neuron Core script can be found at:
/var/svc/log/application-management-neuroncore:default.log
You will also have access to the Halcyon Neuron EventViewer.
Please refer to README.EventViewer for details on how to
access and use this tool.
This distribution also contains the Generic Adapter Module that
monitors fault events within the Neuron Core. It is used to perform
pre-defined actions whenever a fault event occurs. Currently, those
actions include sending an SNMP trap or calling a provided script.
Configuration details will have been asked during installation,
but the Generic Adapter can also be configured manually.
Please refer to the README.config file for instructions.
Halcyon Forums
======================================================================
Halcyon experts actively participate in the online Halcyon Forums. The
experts are constantly monitoring the forums, answering questions and
posting useful tips, tricks, and general knowledge base information.
Whether you have a technical question or just wish to expand our
knowledge base, this is the place for you.
http://forums.HalcyonInc.com
Uninstallation Instructions
======================================================================
This section explains how to uninstall the various Halcyon Neuron Core
components:
1. Uninstall the Server host packages
In general, the uninstall script can be used with no arguments to
uninstall any Halcyon product:
# [LOCALDIR]/uninstall/HALUninstall.sh
Uninstall Server Packages (Solaris)
----------------------------------------------------------------------
To uninstall the "Halcyon Neuron Core" packages on a Solaris
host, do the following:
1. Become the "root" user on the Solaris host
2. Run the uninstall script with the appropriate parameters
% su -
# cd [LOCALDIR]/uninstall
# ./HALUninstall.sh -module Neuron_Core hmf
The Halcyon Neuron Core keeps its data in the following directory:
[LOCALDIR] which by default is /var/opt/HMF
This directory contains the following sub-directories:
- conf: configuration files
- bin: store for runnable scripts
- logs: log files
- mibs: store for mibs supported by the Halcyon Neuron Core
- install: Halcyon installation files
- uninstall: Halcyon uninstallation files
Uninstalling the Halcyon Neuron Core will leave these directories
intact. Remove any of them if they are no longer needed for future
use.
If you do not wish to retain this directory, run the uninstaller
with the -X option:
# ./HALUninstall.sh -module Neuron_Core hmf -X
Install & Uninstall Logs
======================================================================
All Halcyon install and uninstall log files can be found in the
following directories:
[LOCALDIR]/install
[LOCALDIR]/uninstall/log
Installation Log
----------------
The name of the installation log for this product is the following:
Halcyon_Neuron_Core-install_[YYYYMMDD]-[HHMMSS].log
Uninstall Log
-------------
The following is the generic uninstall log file:
uninstall.log.[YYYYMMDD]-[HHMMSS]
---//---