======================================================================
Halcyon Monitoring Solutions
www.HalcyonInc.com
Neuron Management Suite
Version 1.16.0
README
======================================================================
Overview
======================================================================
Halcyon Neuron Management Suite is a lightweight centralized event
management framework. In addition, Halcyon Neuron Management Suite
enables organizations to perform monitoring of their hardware and
software. It can also be used to leverage their existing Enterprise
Management Framework (EMF) to gain visibility into the health,
performance, and status of critical business services in addition
to the hardware and software components that make up the services.
This file consists of the following sections:
- Included Components
- Supported Platforms
- Supported Integrations
- Supported Browsers
- Documentation
- Installation and Uninstallation Instructions
- Release Notes
- Runtime Directory Structure
- Configuration
- User Interface (Neuron Management Portal)
- Utilities
- Acknowledgements
- Halcyon Forums
- License Agreement
- About Halcyon
Included Components
======================================================================
This distribution includes the following Halcyon products:
Halcyon Neuron Management Suite:
- Halcyon Generic Adapter
- Halcyon Email Adapter
- Halcyon Message Logger
- Halcyon Neuron Event Viewer
- Halcyon Neuron Event Manager
- Halcyon Neuron Inventory Manager
- Halcyon Neuron Configuration Manager
- Halcyon Neuron Health Manager
- Halcyon Neuron Performance Manager
- Halcyon Neuron Integration for Oracle Enterprise
Manager Ops Center
- Halcyon Neuron Integration for IBM Tivoli
- Halcyon Neuron Integration for IBM Tivoli Netcool
- Halcyon Neuron Integration for BMC Event Manager
- Halcyon Neuron Integration for HP OpenView
- Halcyon Neuron Integration for Sun Management Center
- Halcyon Neuron Integration for Oracle Grid Engine
- Halcyon Neuron Module for Generic Hardware
- Halcyon Neuron Module for Linux Base
- Halcyon Neuron Module for Solaris Base
- Halcyon Neuron Module for Solaris Advanced
- Halcyon Neuron Module for Solaris Virtualization
- Halcyon Neuron Module for Windows Base
- Halcyon Neuron Module for Cisco Base
- Halcyon Neuron Agent Module
Supported Platforms
======================================================================
Halcyon Neuron Management Suite is only supported on the following
platforms:
SPARC Solaris 2.9-2.10
x86/x64 Solaris 2.10
Red Hat Enterprise Linux 5.5-6.1 64-bit
Oracle Enterprise Linux 5.5-6.1 64-bit
It only supports Neuron Agent integration with the following Neuron
Agent versions:
Halcyon Neuron Agent 3.1.0-3.4.0
Note: Halcyon officially supports the versions listed above as the
product was tested against these releases. It is possible
that the product may function correctly with other versions.
Supported Integrations
----------------------------------------------------------------------
The Neuron Integration for BMC Event Manager is supported for the
following software products:
BMC PATROL Enterprise Manager Connect SNMP 3.1.00
BMC Event Manager 4.3.x
The Neuron Integration for IBM Tivoli Netcool is supported for
the following software products:
IBM Tivoli Netcool 3.3-7.2
The Neuron Integration for HP OpenView is supported for the
following software products:
HP OpenView Operations Manager 8.x
HP OpenView NNM 6.31-7.53
The Halcyon Neuron Integration for Sun Management Center is supported
for the following software products:
Sun Management Center 3.5.1-4.0
The Neuron Integration for IBM Tivoli is supported for the
following software products:
IBM Tivoli Enterprise Console 3.7 and up
The Neuron Integration for Oracle Enterprise Manager Ops Center is
supported for the following software product:
Oracle Enterprise Manager Ops Center 2.5, 11g
Note: Halcyon officially supports the versions listed above as the
products were tested against these releases. It is possible
that the product may function correctly with other versions.
Supported Browsers
----------------------------------------------------------------------
Halcyon Neuron Management Suite provides a web-based user interface
(Neuron Management Portal) which is only supported for the following
browsers:
Mozilla Firefox 3.0-5.0
Microsoft Internet Explorer 7-8
Note: Halcyon officially supports the browsers and versions listed
above as the product was tested against these releases. It is
possible the product may function correctly with other
browsers and versions.
Documentation
======================================================================
A number of useful informational text files and PDF documentation
files are included with this distribution:
- README
- NeuronManagementSuite_[VERSION]_InstallationGuide.pdf
- README.config
- NeuronManagementServer_[VERSION]_UsersGuide.pdf
- NeuronManagementServer_[VERSION]_ReleaseNotes.pdf
- NeuronUtilities_[VERSION]_UsersGuide.pdf
- README.DataExport
- README.EventActionConverter
- NeuronEventManager_[VERSION]_UsersGuide.pdf
- NeuronEventManager_[VERSION]_ReleaseNotes.pdf
- NeuronInventoryManager_[VERSION]_UsersGuide.pdf
- NeuronInventoryManager_[VERSION]_ReleaseNotes.pdf
- NeuronConfigurationManager_[VERSION]_UsersGuide.pdf
- NeuronConfigurationManager_[VERSION]_ReleaseNotes.pdf
- NeuronHealthManager_[VERSION]_UsersGuide.pdf
- NeuronHealthManager_[VERSION]_ReleaseNotes.pdf
- NeuronPerformanceManager_[VERSION]_UsersGuide.pdf
- NeuronPerformanceManager_[VERSION]_ReleaseNotes.pdf
For licensing information, refer to the following files:
- LICENSE
- COPYRIGHT
- NeuronManagementSuite.LICENSE
- ApacheLicense.txt
- FUSEMessageBroker.txt
- CDDL.txt
- LGPL.txt
- GPL.txt
- MIT.txt
These files are located in the base directory and the doc subdirectory
of the distribution tarball, and after installation, in the directories
on the installation host:
[LOCALDIR]/install/Halcyon_Neuron_Management_Suite
[LOCALDIR]/install/Halcyon_Neuron_Management_Suite/doc
(where LOCALDIR is typically /var/opt/HMF)
Installation and Uninstallation Instructions
======================================================================
For installation or uninstallation instructions, refer to the
following file:
- NeuronManagementSuite_[VERSION]_InstallationGuide.pdf
Release Notes
======================================================================
For information about bug fixes, enhancements, known problems, and
upgrade strategy for the current release, refer to the following
files:
- NeuronManagementServer_[VERSION]_ReleaseNotes.pdf
- NeuronEventManager_[VERSION]_ReleaseNotes.pdf
- NeuronInventoryManager_[VERSION]_ReleaseNotes.pdf
- NeuronConfigurationManager_[VERSION]_ReleaseNotes.pdf
- NeuronHealthManager_[VERSION]_ReleaseNotes.pdf
- NeuronPerformanceManager_[VERSION]_ReleaseNotes.pdf
Runtime Directory Structure
======================================================================
All necessary configuration, log, and data files can be found in the
[LOCALDIR] folder, where LOCALDIR is typically /var/opt/HMF.
The contents of this folder are as follows:
[LOCALDIR]
+ bin - Store for runnable scripts
+ conf - Configuration files
+ lib - Store for additional library files
+ logs - Log files
+ mibs - Store for mibs supported by Neuron Management
Suite
Configuration Files
----------------------------------------------------------------------
Configuration files are located in the [LOCALDIR]/conf directory
as well as the service and module subdirectories.
The following configuration files are most likely
to require modification:
container.xml - general configuration parameters for the
Halcyon Neuron Management Suite
logging.xml - logging related configuration
security.xml - security related configuration
users.xml,groups.xml, - access control list for the Halcyon
domains.xml Neuron Management Suite
Log Files
----------------------------------------------------------------------
Log files are located in the [LOCALDIR]/logs directory as described
above. The following files are the most relevant log files:
messageLogger.log - contains a dump of all messages that have
been sent to the Halcyon Neuron Management
Suite
NeuronServer.log - general logfile for the Halcyon Neuron
Management Suite; all internal logging
information is sent to this log file
Configuration
======================================================================
Various components of the Halcyon Neuron Management Suite require
configuration. Please refer to the following file for configuration
instructions:
- README.config
User Interface
======================================================================
Halcyon Neuron Management Suite provides a web-based user interface
that consists of multiple components all accessed through the
Halcyon Neuron Management Portal. Please refer to the following
document for information on accessing the Portal UI:
- NeuronManagementServer_[VERSION]_UsersGuide.pdf
Information about the various user interface components can be found
in the following documents:
- NeuronEventManager_[VERSION]_UsersGuide.pdf
- NeuronInventoryManager_[VERSION]_UsersGuide.pdf
- NeuronConfigurationManager_[VERSION]_UsersGuide.pdf
- NeuronHealthManager_[VERSION]_UsersGuide.pdf
Utilities
======================================================================
This version of Halcyon Neuron Management Suite comes with several
command-line utilities. Please refer to the following documents for
more information and how to access these tools:
- README.EventActionConverter
The EventActionConverter utility can be used to convert an
existing EventAction rule file to a Neuron Management Suite
rule file.
- README.DataExport
The DataExport utility can be used for data export.
- NeuronUtilities_[VERSION]_UsersGuide.pdf
Neuron Management Suite comes with several utilities for
managing its components.
Acknowledgements
======================================================================
This distribution includes software developed by the OpenSSL Project
for use in the OpenSSL Toolkit. (http://www.openssl.org/)
Halcyon Neuron Management Suite uses the SNMP4J software developed by
Frank Fock and Jochen Katz from SNMP4J.org.
The object code can be found here:
./packages/PLATFORM/HALhmfcon/reloc/lib/snmp4j/SNMP4J.jar
SNMP4J is covered under the terms of the Apache License, Version 2,
January 2004. A copy of the license can also be found in the same
directory as this README file.
Halcyon Neuron Management Suite uses the FUSE Message Broker developed
by Progress Software Corporation.
FUSE Message Broker is covered under the terms of the FUSE Message
Broker v. 5.3 License (based on the Apache License, Version 2,
January 2004). A copy of the license can also be found in the
same directory as this README file.
Halcyon Neuron Management Suite uses the Apache XBean, Apache Commons
IO, Apache Commons FileUpload, Apache FOP, Apache XML Graphics Commons,
Apache Batik, Apache Avalon and Apache Tomcat software all developed by
The Apache Software Foundation.
Apache XBean, Apache Commons IO, Apache Commons FileUpload, Apache
FOP, Apache Batik, Apache Avalon and Apache Tomcat are covered under
the terms of the Apache License, Version 2, January 2004. A copy of
the license can also be found in the same directory as this README
file.
Halcyon Neuron Management Suite uses the Drools software developed by
JBoss. The object code can be found here:
./packages/PLATFORM/HALhmfsrv/reloc/lib/drools/
Drools is covered under the terms of the Apache License, Version
2, January 2004. A copy of the license can also be found in the
same directory as this README file.
Halcyon Neuron Management Suite uses the Ehcache software developed
by Luck Consulting Pty Ltd. The object code can be found here:
./packages/PLATFORM/HALhmfcon/reloc/lib/ehcache/
Ehcache is covered under the terms of the Apache License, Version
2, January 2004. A copy of the license can also be found in the
same directory as this README file.
Halcyon Neuron Management Suite uses the BlazeDS software developed
by Adobe Systems Inc.
(http://opensource.adobe.com/wiki/display/blazeds/BlazeDS/)
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
BlazeDS is covered under the terms of the GNU Lesser General
Public License (LGPL), Version 3. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Management Suite uses the JFreeChart software developed
by Object Refinery Limited.
(http://www.jfree.org/jfreechart/download.html)
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
JFreeChart is covered under the terms of the GNU Lesser General
Public License (LGPL), Version 3. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Management Suite uses the j-Interop software
(http://www.j-interop.org/download.html)
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
j-Interop is covered under the terms of the GNU Lesser General
Public License (LGPL), Version 3. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Management Suite uses the Hibernate Management Suite,
Hibernate Entity Manager and Hibernate Annotations software developed
by Red Hat Middleware (http://www.hibernate.org/6.html).
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
Hibernate Management Suite, Hibernate Entity Manager and Hibernate
Annotations are covered under the terms of the GNU Lesser General
Public License (LGPL), Version 2.1. A copy of the license can also
be found in the same directory as this README file.
Halcyon Neuron Management Suite uses the Envers Easy Entity Auditing/
Versioning software developed by Adam Warski from
JBoss Inc (http://www.jboss.org/envers/).
The source code can be found here:
http://www.halcyoninc.com/products/OpenSource/
Envers Easy Entity Auditing/Versioning is covered under
the terms of the GNU Lesser General Public License (LGPL),
Version 2.1. A copy of the license can also be
found in the same directory as this README file.
Halcyon Neuron Management Suite uses the JMXMP Connector software
developed by Sun Microsystem as part of the Project OpenDMK
(https://opendmk.dev.java.net/download/index.html)
JMXMP Connector is covered under the terms of the Common
Development and Distribution License (CDDL). A copy of the license
can also be found in the same directory as this README file.
Halcyon Neuron Management Suite uses the Mibble software developed
by Per Cederberg (http://www.mibble.org). Halcyon Neuron Management
Suite runs the Mibble as a separate executable, and is only loosely
coupled with it. The source code can be found here:
./packages/PLATFORM/HALhmfmib/install/mibble-2.8-application-src.tar.bz2
The Mibble is covered under the terms of the GNU General Public
License, Version 2, June 1991 (http://www.gnu.org/copyleft/gpl.html).
A copy of the license can also be found in the same directory as this
README file.
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
License Agreement
======================================================================
Please refer to the license agreement in the following file:
- LICENSE
Without purchasing a license, the Halcyon Neuron Management Suite will
only operate for a trial period of 14 days from installation.
If you wish to purchase a license to use the Halcyon Neuron Management
Suite, please contact us at:
Web: http://www.HalcyonInc.com
Email: info@HalcyonInc.com
Tel: 1-877-932-4643 (Toll Free in North America)
Tel: 1-416-932-4647 (International)
Fax: 416-932-4711
About Halcyon
======================================================================
Halcyon delivers Infrastructure Management solutions that provide
operational visibility, availability, and reliability for business
critical services and their underlying infrastructure. Since 1994,
Halcyon solutions have been adopted by numerous Fortune 100 and SMEs,
spanning every major geography and sector.
At Halcyon, we believe the health of the IT infrastructure is integral
to the success of a business. Our clients rely on us for complete
end-to-end monitoring solutions that are straightforward, easy to
deploy and use, and cost-effective, coupled with a history of client
service excellence.
---//---