WebNMS Framework 5.0 :: Installation Guide
Transcript of WebNMS Framework 5.0 :: Installation Guide
WebNMS Framework 5.2 SP1 :: Installation Guide
1
Zoho Corp.
Table of Contents
3.1 INSTALLATION GUIDE - INTRODUCTION ........................................................ 2
3.2 SYSTEM REQUIREMENTS ................................................................................. 3
3.2.1 Hardware Requirements ........................................................................................... 3
3.2.2 Software Requirements ............................................................................................. 4
3.3 INSTALLATION AND SETUP OPTIONS .......................................................... 10
3.3.1 Installing WebNMS ................................................................................................. 10
3.3.2 Installing Web NMS as NT Service ......................................................................... 21
3.3.3 Installing WebNMS as Unix Service ........................................................................ 27
3.3.4 Database Setup ...................................................................................................... 29
3.3.5 Cloudera Setup ....................................................................................................... 36
3.3.6 Front-End Server Installation and Setup.................................................................. 38
3.3.7 Installing Standalone Application Client .................................................................. 40
3.3.8 Service Pack ........................................................................................................... 41
3.3.8.1 Installing Service Pack ....................................................................................................... 42
3.3.8.2 Uninstalling Service Pack .................................................................................................. 50
3.3.9 Uninstalling WebNMS Server .................................................................................. 52
3.3.10 Licensing the Product ............................................................................................ 53
3.4 STARTUP OPTIONS ......................................................................................... 58
3.4.1 Starting WebNMS From WebNMS Launcher .......................................................... 58
3.4.2 Starting WebNMS from Bin Directory ...................................................................... 64
3.4.3 Starting WebNMS From Any Directory .................................................................... 65
3.4.5 Starting FE Server .................................................................................................. 66
3.4.6 Starting Application Client ....................................................................................... 68
3.4.7 Reinitializing WebNMS ............................................................................................ 69
3.4.8 Shutting Down WebNMS Server ............................................................................. 71
3.5 PACKAGES BUNDLED .................................................................................... 75
3.5.1 Package Structure .................................................................................................. 75
3.5.2 Web NMS Jars ........................................................................................................ 79
3.5.3 Third Party Software ............................................................................................... 86
WebNMS Framework 5.2 SP1 :: Installation Guide
2
Zoho Corp.
3.1 Installation Guide - Introduction
The Installation Guide explains the system requirements for installing and working with WebNMS
Framework in different operating systems such as Windows, Linux, and Solaris. It describes the
installation procedures to be followed when installing WebNMS Framework on different platforms.
Next, it details the starting, reinitializing, and shutting down procedures in the product. It also
describes the JAR files that are present in the product along with the third party JARs.
The hardware and software requirements to install and work with WebNMS Framework are dealt with
in the System Requirements topics. After going through this section, you will know the supported JDK
platforms and other products required to use the tools.
Installation details about the steps involved in installing the product on different OS such as Windows,
Linux, and Solaris. It also describes the steps to be performed to install WebNMS as a service.
Startup Options guide you in starting, reinitializing, and shutting down the server.
Packages Bundled describes the package structure of WebNMS, in addition to the list of JARs
present in the product. It also lists the third party softwares required for WebNMS.
WebNMS Framework 5.2 SP1 :: Installation Guide
3
Zoho Corp.
3.2 System Requirements
3.2.1 Hardware Requirements
Performance of WebNMS depends considerably on the CPU and memory of both the client and
server systems. The following table describes the suggested minimum configuration of the client and
the server.
Operating
Platform
Processor
Type
Processor
Speed Memory
Hard Disc Space
Required
(For Installation)
Extra Disc Space
Required
(For Execution)
Windows Pentium D 2.0 GHz 1 GB RAM or
Higher 400 MB 200 MB
Linux Pentium 4 2.4 GHz 1 GB RAM or
Higher 400 MB 200 MB
Solaris UltraSPARC-
III+ 1.2 GHz
1 GB RAM or
Higher 400 MB 200 MB
WebNMS Framework 5.2 SP1 :: Installation Guide
4
Zoho Corp.
3.2.2 Software Requirements
WebNMS Framework can run on different platforms such as Windows, Solaris, and Linux. Below is a
list of software versions supported by WebNMS. Though WebNMS supports different software
versions, only a particular software version is bundled with the product. If you wish to use any other
supported version, you need to download that version from the respective web site and follow the
upgrade procedure provided in the Developer Guide.
For the complete list of software versions bundled with WebNMS, refer to the section Packages
Bundled. Certain third party software such as database drivers are to be downloaded by the users
from the respective sites.
Supported Platforms
RedHat Linux 9.0, Redhat Enterprise Linux 5.0, AS 4.0, and Fedora Core 9 (32 bit and 64
bit*)
Solaris 10 (Sun and X86)
Windows Vista, Windows XP (32 bit and 64 bit*), and Windows Server 2008
* For 64 bit installation build, please mail to [email protected]
The databases supported are PostgreSQL, MySQL, Oracle, Sybase, and MSSQL. For information
on drivers, refer to Database Drivers. The default bundled database is PostgreSQL 9.0.1.
The Cloudera Manager supported version is 5.1. For more details, refer to Cloudera Installation and
Configuration section.
Linux Platform
The tables below list the software that are compatible with WebNMS Framework on Linux platform.
Back-end Server
Platforms Java
Version JRE/JDK
Database Web Server
and
Servlet Engine MySQL Oracle PostgreSQL
Sybase SQL Anywhere
MSSQL
Redhat
Enterprise
Linux 5.0
JRE
1.6.0
JDK
1.6.0
5.0.44 11.1.0.0.0 9.0.1 - - Tomcat 5.5.20
RedHat Linux JRE 5.0.44 11.1.0.0.0 9.0.1 - - Tomcat 5.5.20
WebNMS Framework 5.2 SP1 :: Installation Guide
5
Zoho Corp.
Platforms Java
Version JRE/JDK
Database Web Server
and
Servlet Engine MySQL Oracle PostgreSQL
Sybase SQL Anywhere
MSSQL
AS 4.0 1.6.0
JDK
1.6.0
RedHat Linux
9.0
JRE
1.6.0
JDK
1.6.0
5.0.44 11.1.0.0.0 9.0.1 ASA
10.0.1.3415
2005
Tomcat 5.5.20
Fedora Core
9
JRE
1.6.0
JDK
1.6.0
5.0.44 11.1.0.0.0 9.0.1 ASA
10.0.1.3415
2005
Tomcat 5.5.20
Front-end Server
Platforms JRE Version Web Server and Servlet Engine
Redhat Enterprise Linux 5.0 1.6.0 Tomcat 5.5.20
RedHat Linux AS 4.0 1.6.0 Tomcat 5.5.20
RedHat Linux 9.0 1.6.0 Tomcat 5.5.20
Fedora Core 9 1.6.0 Tomcat 5.5.20
Client
Platforms
Browser* Java
Web
Start
JRE Version Firefox** Chrome**
Internet
Explorer**
Java Plug-in
Version
Redhat
Enterprise
Linux 5.0
16x 26x Not Applicable 1.6.0 1.6.0 1.6.0
RedHat Linux AS 4.0
16x 26x Not Applicable 1.6.0 1.6.0 1.6.0
RedHat Linux 9.0
16x 26x Not Applicable 1.6.0 1.6.0 1.6.0
Fedora Core 9
16x 26x Not Applicable 1.6.0 1.6.0 1.6.0
WebNMS Framework 5.2 SP1 :: Installation Guide
6
Zoho Corp.
Solaris Platform
The tables below list the software that are compatible with WebNMS Framework on Solaris operating
system with SPARC platform.
Back-end Server
Platforms
Java
Version
JRE/JDK
Database Web Server
and Servlet
Engine MySQL Oracle
PostgreSQL
Sybase SQL
Anywhere MSSQL
Solaris
10
(Sun
and
X86)
JRE 1.6.0
JDK 1.6.0 5.0.44 11.1.0.0.0 9.0.1
ASA
10.0.1.3415
2005 Tomcat 5.5.20
Front-end Server
Platforms JRE Version Web Server and Servlet Engine
Solaris 10 1.6.0 Tomcat 5.5.20
Client
Platforms
Browser*
Java Web Start JRE
Version Mozilla Internet
Explorer Java Plug-in Version
Solaris 10 1.4 Not Applicable 1.6.0 1.6.0 1.6.0
WebNMS Framework 5.2 SP1 :: Installation Guide
7
Zoho Corp.
Windows Platform
The tables below list the software that are compatible with WebNMS Framework on Windows
platform.
Back-end Server
Platforms
Java
Version
JRE/JDK
Database Web Server
and Servlet
Engine MySQL Oracle PostgreSQL
Sybase SQL
Anywhere MSSQL
Windows
Vista
JRE 1.6.0
JDK 1.6.0 5.0.44 11.1.0.0.0 9.0.1
ASA
10.0.1.3415 2005
Tomcat
5.5.20
Windows
XP
JRE 1.6.0
JDK 1.6.0 5.0.44 11.1.0.0.0 9.0.1
ASA
10.0.1.3415 2005
Tomcat
5.5.20
Windows
Server
2008
JRE 1.6.0
JDK 1.6.0 5.0.44 11.1.0.0.0 9.0.1
ASA
10.0.1.3415 2005
Tomcat
5.5.20
Windows 7 JRE 1.6.0
JDK 1.6.0 5.0.44 11.1.0.0.0 9.0.1
ASA
10.0.1.3415 2005
Tomcat
5.5.20
Front-end Server
Platforms JRE Version Web Server and Servlet Engine
Windows Vista 1.6.0 Tomcat 5.5.20
Windows XP 1.6.0 Tomcat 5.5.20
Windows Server 2008 1.6.0 Tomcat 5.5.20
Windows 7 1.6.0 Tomcat 5.5.20
Client
Platforms
Browser* Java Web
Start
JRE
Version Firefox ** Chrome ** Internet
Explorer **
Java Plug-in
Version
Windows
Vista 16x 26x 9x 1.6.0 1.6.0 1.6.0
Windows XP 16x 26x 9x 1.6.0 1.6.0 1.6.0
Windows Server 2008
16x 26x 9x 1.6.0 1.6.0 1.6.0
Windows 7 16x 26x 9x 1.6.0 1.6.0 1.6.0
WebNMS Framework 5.2 SP1 :: Installation Guide
8
Zoho Corp.
Note: The Windows Vista OS has an additional security feature called "User Account Control or (UAC)". This forces the users of local administrative group to use the PC like regular users without any administrative privileges by default. Due to this, the WebNMS 5 Server when installed under the "Program Files" folder will not have permissions to copy and write files which there by prevents the server from starting. This feature can be disabled to install and start WebNMS 5 server under the "Program Files" folder itself. But, disabling this feature has some security disadvantages. The details about UAC and disabling is available in the link below: http://www.petri.co.il/disable_uac_in_windows_vista.htm
Note: * - HTML UI - Cookies and Java Script should be enabled - JAVA UI - Suitable Plug-ins should be installed for starting Java Client ** - The browsers supported versions are versions provided in the chart and higher versions.
Database Drivers
Database JDBC Driver
(WebNMS is JDBC 2.0 compliant)
PostgreSQL
PostgreSQL 9.0.1(Bundled
Version) postgresql_jdbc4.jar
Oracle
Oracle 11.1.0.0.0 ojdbc5_g.jar
Oracle JDBC driver version 11.1.0.6.0-Production
Sybase SQL Anywhere
Sybase ASA 10.0.1.3415 jconn3.jar (JConnect 6.05)
MySQL
MySQL 5.0.44 mysql-connector-java-v5.0.7
MSSQL
MSSQL 2005 (9.00.1399)
sqljdbc.jar (Microsoft SQL Server 2005 JDBC Driver (1.2.2828.100))
JTurbo.jar (JTurbo 4.0.0.0 JDBC 3.0)
The Java Plug-In can be downloaded from the following link:
http://java.sun.com/products/plugin/index.html.
WebNMS Framework 5.2 SP1 :: Installation Guide
9
Zoho Corp.
Cloudera Installation and Configuration
WebNMS recommends Path A installation of CDH Cluster, i.e using Cloudera Manager to do the
installation. Please follow the Cloudera Installation Guide.
Product Supported Version
Cloudera Manager Version 5.1
CDH Components to be installed
For TSDB HDFS *
HBase *
YARN *
ZooKeeper
For Table Customization
HDFS
Hive *
Impala
Hue
ZooKeeper
* Follow the Cloudera document for Deploying Client Configuration Files for the above components.
And also download the relevant .zip file following the instruction provided in the “download an
individual client configuration zip file” section of the document.
Extract the zip file and copy the relevant .xml file to the <WebNMS Home>/conf folder.
Note: WebNMS recommends to use HDFS HA and atleast two ZooKeeper servers for High
Availability.
Please refer to the Cloudera Setup section for configuring WebNMS for Cloudera.
WebNMS Framework 5.2 SP1 :: Installation Guide
10
Zoho Corp.
3.3 Installation and Setup Options
3.3.1 Installing WebNMS
This section discusses the installation procedure of WebNMS using different modes on operating
systems such as Windows, Linux, and Solaris. WebNMS can be downloaded from the below link.
http://www.webnms.com/webnms/download.html.
This topic explains
Installing WebNMS Professional Edition
Installing WebNMS Free Edition
Troubleshooting
For information on various WebNMS Editions, refer to Quick Tour
Installing WebNMS Professional Edition
This section covers the following modes of installation
GUI Mode
Command or Console Mode
Silent Mode
GUI Mode
The GUI mode is an interactive GUI based installation mode.
Steps to install WebNMS Professional Edition
1. Download the installation files (.exe file for Windows and .bin files for Linux and Solaris).
2. Check the executable permission of the .bin file. If the file is not executable, execute the
following command:
chmod a+x <filename> where <filename> is the corresponding .bin file
WebNMS Framework 5.2 SP1 :: Installation Guide
11
Zoho Corp.
3. Execute the downloaded file. The InstallShield Wizard with the Welcome message is
displayed.
4. Click Next.
5. The License Agreement screen is displayed. Select "I accept the License Agreement".
5. Click Next.
6. The Localization screen is displayed. Choose the required language - English (default),
Japanese, or Chinese.
7. Click Next.
8. The Edition screen is displayed. It provides the choice of Server and Client and Advanced
installation options. Select Server and Client to install the Combo package (BE server, FE server and
Client) and Advanced to install the Standalone versions of BE, FE and Client.
WebNMS Framework 5.2 SP1 :: Installation Guide
12
Zoho Corp.
9. Click Next.
10. If you have chosen Server and Client, skip this step and proceed to the next. If you have
chosen Advanced, perform this step and proceed. When Advanced is chosen, the OEM Edition -
Advanced screen is displayed with various installation options. Select the required type of installation.
Click Next.
11. Click Next. The directory location screen is displayed. Specify the location where WebNMS
has to be installed. Use the Browse button to specify a different location.
12. Click Next. The details of the installation (pre-installation summary) is displayed. If you need
to change any of it, use the Back button to modify.
WebNMS Framework 5.2 SP1 :: Installation Guide
13
Zoho Corp.
13. Click Next. The installation begins. Once the installation is complete, a final screen is
displayed. Click Yes, I want to view the Readme file (if it is not selected) to view the README for
the product.
14. Click Finish.
After installation, when you start WebNMS, you need to provide the license information. For
more information, refer to Licensing the Product.
Command/Console Mode
The Command or Console mode is an Interactive and Non-GUI based installation mode.
The user can install WebNMS through the command prompt.
Steps to install Web NMS Professional Edition in Command or Console
mode
1. Download the installation files (.exe file for Windows and .bin files for Linux and Solaris).
2. Check the executable permission of the .bin file; if the file is not executable, then execute the
following command: chmod a+x <filename> where <filename> is the corresponding .bin file.
3. Execute the file to install WebNMS as follows
For Windows <File Name>.exe -console
For Linux/Solaris : <File Name>.bin -console
4. The above command will initiate an interactive installation procedure. The user needs to
select the options from the messages displayed on the command prompt.
Silent Mode
The Silent mode is a Non-interactive and Non-GUI based installation mode. This mode of
installation is generally useful for automated setups. The user can specify all the options
required in a text file and the installation process continues without manual intervention.
Steps to install WebNMS in Silent mode
1. Download the installation files (.exe file for Windows and .bin files for Linux and
Solaris).
2. Check the executable permission of the .bin file; if the file is not executable, then
execute the following command: chmod a+x <filename> where <filename> is the
corresponding .bin file.
3. For building the installoptions.txt file required for installation, open a new text file
and copy the following contents and save the file as installoptions.txt.
WebNMS Framework 5.2 SP1 :: Installation Guide
14
Zoho Corp.
#******************************************************
-W locale.lang=English
-W OEMProducts.selectedValue=OEMADV
-W OEMAdvance.selectedValue=OEMADVBE
-W StdCustom.optComponents=Javadocs,Tutorials
-G replaceExistingResponse="yesToAll"
#*******************************************************
The editable options beginning with "-W" can have the following values.
Options Description
locale.lang
Specifies the language in which the Installation will take
place.
English
Chinese
Japanese
OEMProducts.selectedValue
Specifies the options for installation
OEMSTD for standard installation
OEMADV for advanced installation
OEMAdvance.selectedValue
Specifies the category for advanced installation
OEMADVBE for Back-End Server installation
OEMADVFE for Standalone Front-End Server
installation
OEMADVClient for Standalone Client
installation
StdCustom.optComponents
Specifies the option for including Javadocs and Tutorials.
The valid values are
Javadocs - For installing only Javadocs
Tutorials - For installing only Tutorials
Javadocs,Tutorials - For installing both
Javadocs and Tutorials
4. Execute the .exe or .bin files as follows where <InstallLocation> should be replaced by the
path where WebNMS has to be installed.
WebNMS Framework 5.2 SP1 :: Installation Guide
15
Zoho Corp.
For Windows:
<File Name>.exe -is:javaconsole -silent -options
installoptions.txt -P
ProductRoot.installLocation=<InstallLocation>
For Linux:
./<File Name>.bin -is:javaconsole -silent -options
installoptions.txt -P
ProductRoot.installLocation=<InstallLocation>
For Solaris:
./<File Name>.bin -is:javaconsole -silent -options
installoptions.txt -P
ProductRoot.installLocation=<InstallLocation>
Where,
InstallLocation is any writable location in the system, where the product has to be to
installed.
installoptions.txt is the text file which supplies different arguments to the installer
(creating this file is explained above)
Points to remember while installing in Silent Mode.
1. Avoid installing WebNMS using silent mode in a previously installed location.
2. Changing the variable name in the installoptions.txt file (value on LHS of
"=") leads to installation failure.
3. The variable OEMAdvance.selectedValue will have no effect if
OEMProducts.selectedValue is set to OEMSTD.
Installing WebNMS Free Edition
This section covers the following modes of installation
GUI Mode
Command or Console Mode
Silent Mode
GUI Mode
The GUI mode is an interactive GUI based installation mode.
WebNMS Framework 5.2 SP1 :: Installation Guide
16
Zoho Corp.
Steps to install WebNMS Free Edition
1. Download the installation files (.exe file for Windows and .bin files for Linux and Solaris).
2. Check the executable permission of the .bin file. If the file is not executable, execute the
following command:
chmod a+x <filename> where <filename> is the corresponding .bin
file
3. Execute the downloaded file. The InstallShield Wizard with the Welcome message is
displayed.
For Windows: <File Name>.exe
For Linux/Solaris: ./<File Name>.bin
4. Click Next.
5. The License Agreement screen is displayed. Select "I accept the License Agreement".
5. Click Next.
6. The Localization screen is displayed. Choose the required language - English (default),
Japanese, or Chinese.
7. Click Next.
8. The Category of Installation screen is displayed. It provides the choice of Server and Client
and Remote Client options. Select Server and Client to install the Combo package (BE server and
Client) and Remote Client to install the Standalone Application Client.
WebNMS Framework 5.2 SP1 :: Installation Guide
17
Zoho Corp.
9. Click Next.
10. The directory location screen is displayed. Specify the location where WebNMS has to be
installed. Use the Browse button to specify a different location.
13. Click Next. The details of the installation (pre-installation summary) is displayed. If you need
to change any of it, use the Back button to modify.
WebNMS Framework 5.2 SP1 :: Installation Guide
18
Zoho Corp.
14. Click Next. The installation begins. Once the installation is complete, a final screen is
displayed. Click Yes, I want to view the Readme file (if it is not selected) to view the README for
the product.
15. Click Finish.
After installation, when you start WebNMS, you need to provide the license information. For
more information, refer to Licensing the Product.
Command/Console Mode
The procedure is same as explained under Installing WebNMS Professional Edition.
Silent Mode
The Silent mode is a Non-interactive and Non-GUI based installation mode. This mode of
installation is generally useful for automated setups. The user can specify all the options
required in a text file and the installation process continues without manual intervention.
Steps to install WebNMS in Silent mode
1. Download the installation files (.exe file for Windows and .bin files for Linux and
Solaris).
2. Check the executable permission of the .bin file; if the file is not executable, then
execute the following command: chmod a+x <filename> where <filename> is the
corresponding .bin file.
3. For building the installoptions.txt file required for installation, open a new text file
and copy the following contents and save the file as installoptions.txt.
#******************************************************
-W locale.lang=English
-W STDCategory.selectedValue SERVER
-G replaceExistingResponse="yesToAll"
#*******************************************************
The editable options beginning with "-W" can have the following values.
Options Description
locale.lang Specifies the language in which the Installation will take
place.
WebNMS Framework 5.2 SP1 :: Installation Guide
19
Zoho Corp.
English
Chinese
Japanese
STDCategory.selectedValue
Specifies the options for installation
SERVER for server and client installation
CLIENT for standalone client installation
4. Execute the .exe or .bin files as follows where <InstallLocation> should be replaced by the
path where WebNMS has to be installed.
For Windows:
<File Name>.exe -is:javaconsole -silent -options
installoptions.txt -P
ProductRoot.installLocation=<InstallLocation>
For Linux/Solaris:
./<File Name>.bin -is:javaconsole -silent -options
installoptions.txt -P
ProductRoot.installLocation=<InstallLocation>
Where,
InstallLocation is any writable location in the system, where the product has to be to
installed.
installoptions.txt is the text file which supplies different arguments to the installer
(creating this file is explained above)
Points to remember while installing in Silent Mode
1. Avoid installing WebNMS using silent mode in a previously installed location.
2. Changing the variable name in the installoptions.txt file (value on LHS of
"=") leads to installation failure
Troubleshooting
In case of any errors during installation, follow the steps listed below to produce the logs files.
Create a text with the same name as that of the installer and with extension as ".sp". i.e,
For <File Name>.bin, create a text file named <File Name>.sp
For <File Name>.exe, create a text file named <File Name>.sp
Example: If the file name is WebNMS_Framework_Linux.bin, create a text file named
WebNMS_Framework_Linux.sp
WebNMS Framework 5.2 SP1 :: Installation Guide
20
Zoho Corp.
Open the ".sp" text file in a editor, add is.debug=1 as the content
Save the ".sp" text file in the same directory where the binary file resides.
Change to the directory where the binary file is present by executing cd command
Invoke the installer as
./<File Name>.bin -is:javaconsole -is:log log.txt [for Linux/Solaris]
<File Name>.exe -is:javaconsole -is:log log.txt [for Windows]
The above command will create the log file named log.txt. Mail the log file to nms-support
Note: If the execution of the installation command throws an error such as "there may not be
enough temporary space available in the temp folder", then execute the file with the argument
as
<File Name>.exe -is:tempdir $DIRNAME [for Windows]
./<File Name>.bin -is:tempdir $DIRNAME [for Linux/Solaris]
where $DIRNAME is the absolute path of any existing directory
WebNMS Framework 5.2 SP1 :: Installation Guide
21
Zoho Corp.
3.3.2 Installing Web NMS as NT Service
WebNMS can be installed as an NT Service. On installation as NT Service, WebNMS starts when the
machine boots up along with other services such as Telnet, FTP etc. This section will guide you in
installing and uninstalling WebNMS as an NT Service.
This topic explains
Installing Web NMS as NT Service
Uninstalling the Web NMS Service
Usage of wrapper.exe file for NT Service
Configurable Parameters in wrapper.conf file
Configuring HTTP Proxy Host and Port to upload Support Information File to WebNMS
Support
Configuring Oracle/Sybase drivers
Warning: If you want to start a fresh installation of Web NMS 5 as a Java service, you
must first start the server in the normal mode, supply the required license information
and then restart as a Java service. The server will not start as a Java service directly,
due the license requirements.
Installing Web NMS as NT Service
Execute wrapper.exe -i from the command prompt from <Web NMS Home> directory to
install Web NMS as NT Service. For information on the parameters in wrapper.exe file, refer
to Configurable Parameters in wrapper.conf file.
Example command:
C:\Program Files\AdventNet\WebNMS>wrapper.exe -i conf\wrapper.conf
Uninstalling the Web NMS Service
Execute wrapper.exe -r from the command prompt to uninstall Web NMS Service.
Example command:
C:\Program Files\AdventNet\WebNMS>wrapper.exe -r conf\wrapper.conf
WebNMS Framework 5.2 SP1 :: Installation Guide
22
Zoho Corp.
Note:
When WebNMS service is run, it takes PostgreSQL as its database, as
PostgreSQL is the default database bundled with WebNMS. To start NMS with
a different database, add/edit the wrapper.ntservice.dependency.<x> property
of wrapper.conf file under <WebNMS Home>/conf directory In addition, modify
the database_params.conf and DatabaseSchema.conf in the respective
database directory under <WebNMS Home>/conf directory and copy the files to
<WebNMS Home>/conf. Also modify the hibernate.cfg.xml file available in the
<WebNMS Home>/classes/hbnlib directory.
To make any change to the Java service, you must set the classpath in
wrapper.conf file under <WebNMS Home>/conf directory
Usage of wrapper.exe file for NT Service options in WebNMS Windows version
The command:
wrapper.exe <command> <configuration file> [configuration properties] [...]
<command> can be one of:
1. -c run as a Console application
2. -t starT an NT service
3. -p stoP a running NT service
4. -i Install as an NT service
5. -r Remove as an NT service
6. -? print this help message
<configuration file> is the wrapper.conf to use
3. [configuration properties] are configuration name-value pairs which override values in
wrapper.conf.
For example:
wrapper.debug=true
WebNMS Framework 5.2 SP1 :: Installation Guide
23
Zoho Corp.
Configurable Parameters in wrapper.conf file
Command Parameter Description Default Value (If any)
wrapper.java.command The Java executable to be used
to run the server.
Configured to the bundled JRE.
wrapper.java.mainclass * The wrapper class to be used to
start and stop the WebNMS
service.
org.tanukisoftware.wrapper.Wrapp
erSimpleApp
wrapper.java.classpath
****
This parameter is used to set
the JARs and class directories
into classpath.
All WebNMS server side classes
(including database JARs,
Hibernate JARs, Tomcat JARs, and
wrapper JAR) are kept.
The directories and JARs are
configured serially numbered
starting from 1. The path should
configured with respect to <Web
NMS Home> directory.
Example:
wrapper.java.classpath.55=classes/
test1.jar //Points
<NMS_Home>/classes/test1.jar
wrapper.java.classpath.56=classes/
test2.jar //Points
<NMS_Home>/classes/test2.jar
wrapper.java.library.path The libraries to be kept in the
path when starting the server.
Configured to <WebNMS
Home>/lib directory. If needed
additional paths can be configured
as wrapper.java.library.path.2, 3
etc.
wrapper.java.additional ** The system properties (-D) and
non-standard (-X) parameters
are configured. (Example: To
use SSL, Dual NIC Machine
etc.,)
The default system parameters
values are configured.
wrapper.java.initmemory Initial Java Heap Size (in Mega
Bytes)
The default value is 100.
wrapper.java.maxmemory Maximum Java Heap Size (in
Mega Bytes)
The default value is 64.
wrapper.app.parameter The main class to start the
server and the required
arguments are configured.
Default main class is
com.adventnet.launcher.nms.Sta
rtNmsJdbc. Can be changed if
required.
wrapper.logfile The log file where the output of
the wrapper console is to be
Configured to <Web NMS
Home>/logs/wrapper.log file. Can
WebNMS Framework 5.2 SP1 :: Installation Guide
24
Zoho Corp.
Command Parameter Description Default Value (If any)
logged. be changed if required.
wrapper.logfile.maxsize Maximum size (number of lines)
of a single log file.
The default value is 0. Can be
changed if required.
wrapper.logfile.maxfiles Maximum number of log files
after which the rollover should
occur.
The default value is 0. Since the
maximum files are 0, only one log
file be present. Can be changed if
required.
Wrapper Parameters applicable only for Windows
wrapper.console.title This parameter is the title of the
console window, if run as a
console application.
Configured as WebNMS.
wrapper.ntservice.name Name of the NT/Unix service. WebNMS5
wrapper.ntservice.display
name
Display name of the NT/Unix
service.
WebNMS 5
wrapper.ntservice.descrip
tion
Description of the NT/Unix
service.
WebNMS5 Service
wrapper.ntservice.startty
pe
The mode in which the service
is started. Automatic or Manual.
Configured as AUTOSTART.
wrapper.ntservice.interact
ive
Allow the service to interact with
the desktop.
Configured as TRUE.
wrapper.ntservice.depend
ency***
The Service(s) on which
WebNMS is dependent to get
started.
Configure as per requirement.
More than one dependency service
can be configured. The dependent
services can be configured serially
numbered starting from 1.
* - Warning:
We use the main class as WrapperSimpleApp. The method1 by default. Refer the
other two methods (method2 and method3) documented in the Wrapper documentation.
Note that when you use method2 or method3, the user name and password should be
configured in the wrapper.conf file and when the password for the Admin user is
changed, it should be changed in the wrapper.conf file also. Hence we recommend the
default method (which uses WrapperSimpleApp) to start and stop the service.
*** - Note:
For example, if Oracle is used instead of the bundled PostgreSQL database,
Oracle also should be started as a service along with WebNMS. For that include
the parameter Oracle service name as its value in dependency1.
If you want to use any other web server other than Tomcat (say IIS), IIS also
should be started as a service along with WebNMS. For that include the
parameter IIS service name as its value in dependency2.
WebNMS Framework 5.2 SP1 :: Installation Guide
25
Zoho Corp.
**
Configuring HTTP Proxy Host and Port to upload Support Information File to
WebNMS Support
To upload the Support Information File to WebNMS Support, you need to configure the HTTP Proxy
Host and Port as given below.
Before configuring Web NMS as NT Service/Unix Service
Edit the wrapper.conf file located in the <WebNMS Home>/conf directory and add the
following under the "wrapper.java.additional" parameter entries.
wrapper.java.additional.21=-Dhttp.proxyHost=<Host name of web proxy
server>
wrapper.java.additional.22=-Dhttp.proxyPort=80
wrapper.java.additional.23=-Dhttp.PROXY_USERNAME=<User name of proxy
server>
wrapper.java.additional.24=-Dhttp.PROXY_PASSWORD=<Password of proxy
server>
****
Configuring Oracle/Sybase drivers
To configure the Oracle/Sybase drivers carryout the procedure as given below.
Before configuring Web NMS as NT Service/Unix Service
Edit the wrapper.conf file located in the <WebNMS Home>/conf directory and add the
following under the "wrapper.java.classpath" parameter entries.
wrapper.java.classpath.56=classes/ojdbc14.jar
wrapper.java.classpath.57=classes/jconn3.jar
Configuring Secured Socket Layer (SSL)
To configure the SSL carryout the procedure as given below.
Before configuring Web NMS as NT Service/Unix Service
Edit the wrapper.conf file located in the <WebNMS Home>/conf directory and uncomment
the following
#wrapper.java.additional.18=-
WebNMS Framework 5.2 SP1 :: Installation Guide
26
Zoho Corp.
Djavax.net.ssl.trustStore=conf/Truststore.truststore
#wrapper.java.additional.19=-Dssl.port=8443
under the "wrapper.java.additional" parameter entries.
####################### FOR SSL #######################
#Change both -Dwebserver.port & -Dwebcontainer.port to 8443 in the
above properties & Add below 2 properties
#wrapper.java.additional.18=-
Djavax.net.ssl.trustStore=conf/Truststore.truststore
#wrapper.java.additional.19=-Dssl.port=8443
######## For SSL ends #############################
WebNMS Framework 5.2 SP1 :: Installation Guide
27
Zoho Corp.
3.3.3 Installing WebNMS as Unix Service
When WebNMS is installed as a service, it starts when the machine boots up along with the other
services like Telnet, FTP etc.
This topic explains
Installing WebNMS as UNIX Service in Linux machine
Installing WebNMS as UNIX Service in Solaris machine
Uninstalling the WebNMS UNIX Service
Usage of wrapper.exe file for NT Service
Configurable Parameters in wrapper.conf file
Warning: If you want to start a fresh installation of WebNMS 5 as a Java service, you must first
start the server in the normal mode, supply the required license information and then restart as
a Java service. The server will not start as a Java service directly, due the license
requirements.
WebNMS can be installed as a Unix Service by performing the following steps by logging in as super
user.
Linux and Solaris Machine
Login to the system as super user.
Execute <Web NMS Home>/bin/admintools/setup-service.sh as:
# sh setup-service.sh install
If you are using the RPM PostgreSQL (that comes by default in Linux OS) skip the below step.
Change the ownership of PostgreSQL 's data directory as follows:
# chown -R pgsql <WebNMS Home>/pgsql/data
WebNMS will be installed as a UNIX Service. When you reboot/restart the system, at that
time Web NMS service will start and when you shutdown the system, WebNMS service will
be shutdown.
Warning: Once you perform the above steps, thereafter WebNMS installation can only be
started by super user.
WebNMS Framework 5.2 SP1 :: Installation Guide
28
Zoho Corp.
Uninstalling WebNMS Unix Service
To uninstall WebNMS as a Unix Service, execute the <Web NMS Home>/bin/admintools/setup-
service.sh script as follows:
# sh setup-service.sh uninstall
Using testwrapper file to start/stop WebNMS Service in Linux/Solaris machines
After installing WebNMS as UNIX Service in Linux/Solaris machine, if you want stop, start, restart the
WebNMS service, use the testwrapper command.
To stop WebNMS Service
Execute ./testwrapper stop from the command prompt from <Web NMS Home> directory to
uninstall WebNMS UNIX Service.
Example command:
# ./testwrapper stop
To start WebNMS Service
Execute ./testwrapper start from the command prompt from <Web NMS Home> directory to
install WebNMS as UNIX Service. For information on the parameters in wrapper.conf file,
refer to Configurable Parameters in wrapper.conf file.
Example command:
# ./testwrapper start
Detailed usage of the command is given below.
Usage of testwrapper file
The command:
./testwrapper { console | start | stop | restart | status | dump }
command can be one of:
1. console run as a Console application
2. start run as UNIX service
3. stop stop running as UNIX service
4. restart restart as UNIX service
5. status run as a Console application
6. dump run as a Console application
WebNMS Framework 5.2 SP1 :: Installation Guide
29
Zoho Corp.
3.3.4 Database Setup
WebNMS supports Hibernate and was tested with PostgreSQL, MySQL, Oracle, Sybase, and
MSSQL. WebNMS supports Hibernate connection pooling, which is a store for all the database
connections. Refer to Connection Pooling document for the detailed description.
The Hibernate default value for the number of connections will be set for WebNMS.
Configuring Hibernate for WebNMS
Carryout the configuration in the hibernate.cfg.xml file in the <Web NMS Home>/classes/hbnlib
directory. This configuration is common for all the databases.
Property Description Default Value (If any)
For PostgreSQL (For Oracle database configure the below properties with respective default
values)
connection.driver_class org.postgresql.Driver
com.p6spy.engine.spy.P6SpyDriver
connection.url jdbc:postgresql://localhost/WebNmsDB
connection.username postgres
connection.password
dialect SQL dialect org.hibernate.dialect.PostgreSQLDialect
databasename SQL dialect POSTGRESQL
JDBC connection pool
hibernate.c3p0.min_size 15
hibernate.c3p0.max_size 15
nontransaction.connection 3
hibernate.connection.autocommit true
hibernate.c3p0.acquire_increment 1
hibernate.jdbc.batch_size 1000
hibernate.connection.isolation 2
current_session_context_class Enable
Hibernate's
automatic
session
context
management
thread
hibernate.cache.use_second_level_cache true
hibernate.cache.provider_class org.hibernate.cache.EhCacheProvider
hibernate.cache.use_query_cache true
WebNMS Framework 5.2 SP1 :: Installation Guide
30
Zoho Corp.
Property Description Default Value (If any)
cache.provider_class Disable the
second-level
cache
org.hibernate.cache.NoCacheProvider
show_sql Echo all
executed
SQL to
stdout.txt
log file.
false
hbm2ddl.auto
The
database will
be updated
with schema
changes if
any in
between
subsequent
server
startups.
update
hibernate.c3p0.acquireRetryAttempts 100
hibernate.c3p0.acquireRetryDelay 3000
hibernate.c3p0.breakAfterAcquireFailure false
testQuery To check if
the database
is running.
(Used
internal)
select HOSTADDRESS from
BEFailOver
hibernate.default_schema userName
connection.schemaname Postgresql
specific
parameter.
public
mapping resource - Object mapping entries of the Topology, Map, Fault, and Performance
modules are given here
Database Supported
Most of the RDBMS, which have a JDBC driver are supported and in our lab we have tested the
following databases extensively.
1. PostgreSQL
2. MySQL
3. Oracle
WebNMS Framework 5.2 SP1 :: Installation Guide
31
Zoho Corp.
4. Sybase
5. MSSQL
Note:
The databasename entry of the hibernate.cfg.xml file indicates the database
(Example: POSTGRESQL, MYSQL, ORACLE, SYBASE, MSSQL) used by the
WebNMS server.
Before moving the database files from the default database PostgreSQL to some other
database, ensure that the tables related to collected data are properly reinitialized.
Procedure to Configure WebNMS for PostgreSQL
PostgreSQL 9.0.1 Professional Edition is the default database bundled with WebNMS. WebNMS
starts and initializes this database before starting the WebNMS modules. Therefore, in Windows,
Linux and Solaris environments, you can start the PostgreSQL daemon by invoking the script
"startnms.bat/sh" present under <Web NMS Home>/bin.
Procedure to Configure WebNMS for MySQL
1. Edit the DB_CLASSPATH variable (which is by default set to postgresql driver) in setEnv.bat
file under <Web NMS Home> directory to set the JDBC Driver for MySQL. Set the JDBC
Driver path to mysql_connector.jar.
2. Check whether the MySQL driver is placed in the appropriate location as per the path
specified in the setEnv.bat file.
3. If the WebNMS Server is already started, then do a proper and normal shutdown. Do not
terminate the process abruptly.
4. Copy the DatabaseSchema.conf file from <WebNMS Home>/conf/MySQL directory to
<WebNMS Home>/conf directory.
Note: When using latest versions of MySQL, the columns MINVALUE and MAXVALUE must
be backquoted in the databaseSchema.conf file as MAXVALUE is a keyword in MySql 5.5 and
higher versions. These column names are present in REPORTS_HOURLY and
REPORTS_DAILY tables.
"`MINVALUE`"
"`MAXVALUE`"
5. Un-comment the following lines and comment out the PostgreSQL database configuration
lines in the hibernate.cfg.xml file.
<!--For MYSQL,Starts From Here-->
<!--
WebNMS Framework 5.2 SP1 :: Installation Guide
32
Zoho Corp.
<property name="connection.driver_class">com.mysql.jdbc.Driver</property>
<property
name="connection.url">jdbc:mysql://localhost/WebNmsDB?dumpQueriesOn
Exception=true&jdbcCompliantTruncation=false</property>
<property name="connection.username">root</property>
<property name="connection.password"></property>
<property
name="dialect">org.hibernate.dialect.MySQL5InnoDBDialect</property>
<property name="databasename">MYSQL</property>
<property name="engineType">InnoDB</property>
-->
<!--End Of MYSQL-->
6. Set the parameter hibernate.default_schema value as "userName" in <WebNMS
Home>/classes/hbnlib/hibernate.cfg.xml.
7. Check if the MySQL server is listening to the port 3306.
8. Start the WebNMS server.
Procedure to Configure WebNMS for Oracle
1. Edit the DB_CLASSPATH variable (which is by default set to postgresql driver) in setEnv.bat
file under <WebNMS Home> directory to set the JDBC Driver for Oracle. Set the JDBC
Driver path to ojdbc5_g.jar or Oracle JDBC driver version 11.1.0.6.0-Production.
2. If the WebNMS Server is already started, then do a proper and normal shutdown of Oracle.
Do not terminate the process abruptly.
3. For Oracle, add the entry open_cursors=300. For example, you can edit the line as shown
below.
Go to ORACLE_HOME/Database/init<database name>.ora file, add/edit the line
OPEN_CURSORS 250.
4. After changing the OPEN_CURSORS value, first start the TnsListener Service and then the
Oracle database
Note: The TnsListener Service listens for and accepts incoming connection requests from
client applications.
5. Copy the DatabaseSchema.conf from <WebNMS Home>/conf/Oracle directory to conf/
directory.
6. Un-comment the following lines and comment out the PostgreSQL database configuration
lines in the hibernate.cfg.xml file.
<!--For Using Oracle DB , Uncomment the below tags -->
<!--
<property
name="connection.driver_class">oracle.jdbc.driver.OracleDriver</property>
WebNMS Framework 5.2 SP1 :: Installation Guide
33
Zoho Corp.
<property name="connection.url">jdbc:oracle:thin:@HOST_NAME:PORT_NUMBER:
CONNECT_STRING</property>
<property name="connection.username">scott</property>
<property name="connection.password">tiger</property>
<property name="dialect">org.hibernate.dialect.Oracle9Dialect</property>
-->
<!-- Uncomment till here-->
7. Set the parameter hibernate.default_schema value as "userName" in <WebNMS
Home>/classes/hbnlib/hibernate.cfg.xml.
8. Check if the Oracle server is listening to the port 1521.
9. Start the WebNMS server.
Note on using Oracle: In Oracle, the number of open cursors supported for a single
connection is set to 50 by default. It has to be changed to 250 for WebNMS to work with
Oracle.
Procedure to Configure WebNMS for Sybase ASA 10.0.1.3415
1. Edit the DB_CLASSPATH variable (which is by default set to postgresql driver) in setEnv.bat
file under <WebNMS Home> directory, to set the JDBC Driver for Sybase. Set the JDBC
Driver path to jconn3.jar. An example entry in setEnv.bat file for Sybase is given below.
set DB_CLASSPATH=<WebNMS Home>/conf/Sybase/jconn3.jar
2. Check whether the jconn3.jar, is placed in the appropriate location as per the path specified
in the setEnv.bat file.
3. If the WebNMS Server is already started, then do a proper and normal shutdown. Do not
terminate the process abruptly.
4. Copy the DatabaseSchema.conf file from <WebNMS Home>/conf/Sybase directory to
<WebNMS Home>/conf directory.
5. Un-comment the following lines and comment out the PostgreSQL database configuration
lines in the hibernate.cfg.xml file.
<!--For Using Sybase ASA DB , Uncomment the below tags -->
<!--
<property
name="connection.driver_class">com.sybase.jdbc3.jdbc.SybDriver</property>
<property
name="connection.url">jdbc:sybase:Tds:localhost:2638/WebNmsDB</property>
<property name="connection.username">dba</property>
WebNMS Framework 5.2 SP1 :: Installation Guide
34
Zoho Corp.
<property name="connection.password">sql</property>
<property
name="dialect">org.hibernate.dialect.SybaseAnywhereDialect</property>
<property name="databasename">SYBASE</property>
-->
<!--END of SYBASE ASA ,Uncomment till here-->
6. Set the parameter hibernate.default_schema value as "userName" in <WebNMS
Home>/classes/hbnlib/hibernate.cfg.xml.
7. Check if the Sybase server is listening to the port 2638 for Sybase ASA 10.0.1.3415.
8. Start the WebNMS server.
Note: The outer join functionality in Sybase must be enabled to facilitate the certain database
operations in WebNMS.
The steps to enable the functionality is provided below:
1. Run the Interactive SQL system administration utility by entering the following
command.
<Sybase_Insallation>/bin>dbisql
2. A connection dialog appears. Enter the following details.
USER ID - dba
password - sql
databasename - WebNMSDB
This is default user name, password, and database name (created database). Leave the
other fields blank.
3. Click OK to connect to the database.
4. Enter the following query in the command window.
SET OPTION tsql_outer_joins="on";
5. Click Execute.
Procedure to Configure WebNMS for MSSQL
1. Edit the DB_CLASSPATH variable (which is by default set to postgresql driver) in setEnv.bat
file under <Web NMS Home> directory to set the JDBC Driver for MSSQL. Set the JDBC
Driver path to sqljdbc.jar or JTurbo.jar . An example entry in setEnv.bat file for MSSQL is
given below.
set DB_CLASSPATH=%NMS_HOME%conf/MSSQL/sqljdbc.jar or
DB_CLASSPATH=%NMS_HOME%conf/MSSQL/JTurbo.jar
WebNMS Framework 5.2 SP1 :: Installation Guide
35
Zoho Corp.
2. Check whether the MSSQL driver is placed in the appropriate location as per the path
specified in the setEnv.bat file.
3. If the WebNMS Server is already started, then do a proper and normal shutdown. Do not
terminate the process abruptly.
4. Copy the DatabaseSchema.conf file from <WebNMS Home>/conf/MSSQL directory to
<WebNMS Home>/conf directory.
5. Check whether the MSSQL driver "sqljdbc.jar" is placed in the appropriate location as per the
path specified in the setEnv.bat file.
6. Un-comment the following lines and comment out the PostgreSQL database configuration
lines in the hibernate.cfg.xml file.
<!--For MSSQL,Starts From Here-->
<!--
<property
name="connection.driver_class">com.microsoft.sqlserver.jdbc.SQLServerDriver</property>
<property
name="connection.url">jdbc:sqlserver://localhost:1433;databaseName=WebNmsDB</property>
<property name="connection.username">admin</property>
<property name="connection.password">public</property>
<property name="dialect">org.hibernate.dialect.SQLServerDialect</property>
<property name="databasename">MSSQL</property>
-->
<!--End Of MSSQL Uncomment till here-->
7. If JTurbo driver is use, then the following lines must be un-commented instead of the above
lines.
<!--For MSSQL,Starts From Here-->
<!--
<property name="connection.driver_class">com.newatlanta.jturbo.driver.Driver</property>
<property name="connection.url">jdbc:JTurbo://localhost:1433/WebNmsDB</property>
<property name="connection.username">admin</property>
<property name="connection.password">public</property>
<property name="dialect">org.hibernate.dialect.SQLServerDialect</property>
<property name="databasename">MSSQL</property>
-->
<!--End Of MSSQL Uncomment till here-->
8. Set the parameter hibernate.default_schema value as "userName" in <WebNMS
Home>/classes/hbnlib/hibernate.cfg.xml.
9. Start the MSSQL Server.
10. Start the WebNMS Server.
WebNMS Framework 5.2 SP1 :: Installation Guide
36
Zoho Corp.
3.3.5 Cloudera Setup
WebNMS supports Cloudera and was tested with CDH 5.
Configuring WebNMS for Cloudera
1. Download and install WebNMS 5.2
(Refer to the Installing WebNMS section for instructions.)
2. Apply the Service Pack 1 using <WebNMS Home>/bin/UpdateManager.sh/bat
(Refer to the Installing Service Pack section for instructions.)
3. Apply the Cloudera pack over WebNMS 5.2 SP1
Mail to [email protected] to receive the Cloudera.
4. The Cloudera specific properties and values are copied to the relevant files on installing the
Cloudera ppm. Ensure that the following files are updated properly.
1. Open <WebNMS Home>/conf/serverparameter.bat/sh (a) Set IS_HADOOP_ENABLE parameter to true. By default the value is false. #To enable/disable Hadoop in Performance IS_HADOOP_ENABLE true
(b) Ensure the DISTRIBUTED_HADOOP_PROCESS_IMPL is specified. This process
is required only in the case of Distributed Poller.
#Default implementation of Hadoop process. Used only in Distributed Poller
DISTRIBUTED_HADOOP_PROCESS_IMPL
com.webnms.nms.hadoop.NmsHadoop
2. Open <WebNMS Home>/setEnv.bat/sh Ensure that the HADOOP_CLASSPATH is set in setEnv.sh. set HADOOP_CLASSPATH= <NMS_CLASSES>/hadoop-hdfs-2.3.0-cdh5.1.0.jar;<NMS_CLASSES>/hadoop-mapreduce-client-core-2.3.0-cdh5.1.0.jar;<NMS_CLASSES>/hadoop-yarn-api-2.3.0-cdh5.1.0.jar;……………………………………..<NMS_CLASSES>/asynchbase-1.4.1.jar;<NMS_CLASSES>/zookeeper-3.3.4.jar;<NMS_CLASSES>/suasync-1.3.1.jar;<NMS_CLASSES>/netty-3.6.1.Final.jar
3. Open <WebNMS Home>/bin/startnms.bat/sh Ensure that the HADOOP_CLASSPATH is appended to the CLASS_PATH setting. set CLASS_PATH=%NMS_SERVER_CLASSES%;%NMS_CLASSES%\
WebNMS Framework 5.2 SP1 :: Installation Guide
37
Zoho Corp.
AdventNetOPExtn.jar;…………;JSON_CLASSPATH%;%HADOOP_CLASSPATH%
4. Open <WebNMS Home>/conf/NmsProcessesBE.conf Ensure the following entry is present. PROCESS com.webnms.nms.hadoop.NmsHadoop ARGS USE_HADOOPKPI_COLLECTOR true
5. Ensure that the respective <component-site>.xml files are copied to the conf folder as mentioned in the Software Requirements section of the guide. (core-site.xml, hdfs-site.xml mapred-site.xml,hive-site.xml,hbase-site.xml,yarn-site.xml)
Component XML File name
HDFS hdfs-site
core-site.xml
YARN
yarn-site.xml
mapred-site.xml
HBase hbase-site.xml
Hive hive-site.xml
Configuring Polling.conf
Open the <WebNMS Home>/conf/Polling.conf file.
And add the statsDataTableName="HADOOP_TSDB" to save the stats data table values in HDFS.
Sample Entry
<POLLING_OBJECT name="Interface1" status="true"> <MATCH_CRITERIA> ... </MATCH_CRITERIA> <DATA_COLLECTION pollingPeriod="30" statsDataTableName="HADOOP_TSDB"> <DATA_TO_POLL name="Interface_OutDiscards" oid=".1.3.6.1.2.1.2.2.1.19" type="multiple"/> ... </DATA_COLLECTION> </POLLING_OBJECT>
WebNMS Framework 5.2 SP1 :: Installation Guide
38
Zoho Corp.
3.3.6 Front-End Server Installation and Setup
WebNMS front-end server provides a link between the back-end server and the clients. By default,
whenever you start a WebNMS Server, one front-end server is started along with the back-end server.
Apart from this, you can also run standalone front-end server(s), when you need to connect more
clients. This can be used when you require a more scalable WebNMS deployment. This installation
can be deployed only when a back-end server is already running. This package includes only the
front-end server and application client components. It is used to set up a distributed server
environment for WebNMS.
The front-end server can access the database directly when the client request is of type read only,
thereby, reducing the load on the back-end server. However, when the client request involves a write
operation, the request goes through the back-end server. The procedures for installing the front-end
and back-end server is discussed in this section.
Procedure for Installing the Standalone Front-End Server
Installing on Windows
The WebNMS is available in a self-extracting EXE format for the Windows platform.
Download and execute the EXE file WebNMS_Framework_Windows.exe. You can select
the "Advanced" option in the Installation Wizard to install the standalone front-end server.
Installing on Linux/Solaris
The WebNMS is supplied as a bin file for Linux/Solaris. Download the corresponding bin
file. You can select and install standalone front-end server using the Advanced Installation
Option.
For more information on installation options refer to Installing WebNMS.
Procedure For Setting up the FE server
The following procedure explains two setups. The first setup where the back-end server and front-end
server are on different machines and the second the back-end server and front-end server are on the
same machine.
WebNMS Framework 5.2 SP1 :: Installation Guide
39
Zoho Corp.
FE and BE on Different Machines
Assume the back-end-front-end combo is running on a machine with DNS name
"MachineBE". Install the standalone front-end on the machine with DNS name "MachineFE".
Connecting the Installed FE server to the BE server
Edit BE_HOST parameter present in <Web NMS FE HOME>/bin/startnmsFE.bat of
machine with DNS name "MachineBE".
BE_HOST host name (for example : MachineBE)
BE_PORT port number (for example : 2000)
By default only the files required for standalone front-end server installation, are present in
the <Web NMS FE Home> /conf directory in "MachineFE". All the other configuration files
required for connecting to the database and other operations are downloaded from
"MachineBE" on the standalone front-end startup.
FE and BE on the same machine
Assume the back-end-front-end combo is present in the same machine "MachineBE". The
front-end present in the combo download does not require any changes for the BE_HOST
and BE_PORT parameters. By default, these parameters are set to "localhost" and "9090"
respectively. In case the front-end server needs to be invoked as a separate process on the
same machine as the back-end server, then some port values have to be changed in order
to avoid clash of usage of ports.
Note: If you want to run the front-end server as a separate process in the same machine where
the back-end server is running, the following ports have to be changed in <Web NMS
Home>/setEnv.sh/bat.
WEBSERVER_PORT : Change the port from 9090 to 9095(say)
WEBCONTAINER_PORT : Change the port from 8009 to 8010(say)
TOMCAT_SHUTDOWNPORT : Change the port from 8005 to 8006(say)
Procedure for connecting the FE Server to the JDBC driver
If you want to use any database other than PostgreSQL, the default database bundled with WebNMS,
change the DB_CLASSPATH parameter in <WebNMS FE HOME>/setEnv.bat present in
"MachineFE" in case of the standalone FE Server or the <Web NMS Home>/setEnv.bat present in
"MachineBE" in case of the FE bundled with the BE. For more details on how to configure database
parameters refer to Configuring Database Parameters.
WebNMS Framework 5.2 SP1 :: Installation Guide
40
Zoho Corp.
3.3.7 Installing Standalone Application Client
The Application client, which is also known as the Java client, is a non web-based interface that can
be accessed as a standalone application. In order to access this client, it is necessary that all the
client-related files are installed in the local machine.
Standalone Application Client Installation on Windows Platform
To install Standalone Application Client, select the Advanced Deployment Option. For more details
please refer to Installing WebNMS.
Standalone Application Client Installation on Linux/Solaris
The WebNMS is supplied as a bin file for Linux/Solaris. Download the bin file. You can select and
install Standalone Application Client using the Advanced Deployment Option.
WebNMS Framework 5.2 SP1 :: Installation Guide
41
Zoho Corp.
3.3.8 Service Pack
Installing Service Pack Releases on WebNMS
A service pack is a collection of bug fixes and minor feature enhancements, which can be applied at a
single instance over the product. It is an efficient and easy process for maintaining and updating the
product. When a service pack is developed all the product users and customers are informed of the
service pack and the fixes available in it.
Installing a Service Pack
The installation of service pack is explained under the section Installing Service Pack. The service
pack will be available in web site under http://www.webnms.com/products/webnms/support.html. The
same service pack can be applied to both the combo and standalone setups to effect the necessary
changes.
Uninstalling a Service Pack
It is possible to revert to any previous version of service pack or the base version of the product. The
uninstallation of service pack is explained under the section Uninstalling Service Pack.
The details of an already installed Service Pack can be viewed using the Update Manager. For more
details, refer to Viewing the details of a Service Pack.
WebNMS Framework 5.2 SP1 :: Installation Guide
42
Zoho Corp.
3.3.8.1 Installing Service Pack
Installing the Service Pack
o UI mode
o Command Line mode
Viewing the details of the Service Pack
o UI mode
o Command Line mode
Installing the Service Pack
WebNMS Framework periodically provides Service Packs which provide new features (requested by
the customers), fixes for certain bugs and document updates in the form of HTML files. Service Packs
can be downloaded from the web site, and updated into WebNMS using the Update Manager tool.
There are two ways in which the Service Pack can be installed.
Using the Update Manager through UI
Using the Update Manager through Command Line
Installing the Service Pack Using Update Manager Through UI
The Update Manager can be invoked by choosing Update Manager from the Options menu
in the Launcher. Alternatively, you can invoke Update Manager by executing the file
<WebNMS Home>/bin/UpdateManager.bat/sh for BE and <Web NMS FE
Home>/bin/UpdateManager.bat/sh for FE. When you start the Update Manager, all the
Service Packs that are already installed are listed and it provides the options to Install,
Uninstall and view the details of any Service Pack.
Warning: Ensure that no application is running when applying the Service Pack. This
prevents any files used by the application from being over-written. For example in the
WebNMS server is running, stop the server and then install the service pack.
The steps to apply a Service Pack are as follows.
Step 1 : Start Update manager - You can invoke the UpdateManager.bat/sh file in the
<WebNMS Home>/bin directory or click the menu Options -> Update Manager or click the
Update Manager icon from the Launcher tool bar.
WebNMS Framework 5.2 SP1 :: Installation Guide
43
Zoho Corp.
Step 2 : Select the Install option: Click "Browse" button and select the Service Pack file
(.ppm) to be installed. When the Service Pack is selected, the Update Manager displays a
Preview button alongside the Install and Readme buttons as shown in the screen below. Use
the Preview button, to view the changes that will be effected for the selected Service Pack.
Click Install button to install the Service Pack.
The Preview screen showing the changes made for the selected Service Pack is shown
below. The left tree shows some general categories of files and the right panel shows the list
of changes with clear categorization of the type of change. The four categories of changes
are Overwritten Open Source Files, Modified Files, New Files and Re-introduced Files.
WebNMS Framework 5.2 SP1 :: Installation Guide
44
Zoho Corp.
Step 3: Install the Service Pack - You can go through the Readme file of the Service Pack
by clicking the "Readme" button and Install the Service Pack by clicking the "Install" button. If
the Service Pack has some optional upgrades, it will prompt you to select the same if
required and then continue.
Note: On clicking the "Install" button, the tool checks whether there is enough space
for the installation of the service pack. If there is not enough space, the tool informs the
user about the lack of space. You must clear the space and then proceed with the
installation.
Step 4 : Configuration Updator Tool - The Configuration Updator tool is invoked to
updates all the configuration files that are modified for the particular service pack. The
screen prompts you to select one of the three radio button: Update, Revert or Query the
configuration changes. A text field to get the JDK installation path, which will be used to
compile the jsp files.
WebNMS Framework 5.2 SP1 :: Installation Guide
45
Zoho Corp.
Select the Update option, enter the JDK installation path and click "Next" button. The list of
configuration files that will be updated is shown in the next screen. If you want to update all
the files you can select the "Select All Files" checkbox and click Update.
All the configuration files are updated in a smart manner without affecting the user changes in
these files (if any). Then the jsp files will be compiled automatically. This completes the
WebNMS Framework 5.2 SP1 :: Installation Guide
46
Zoho Corp.
process of a service pack installation. The log message pane of the Configuration Update
Tool lists the changes made to the Configuration Files. Click Close button once the updation
of configuration files is completed. The screen image shows "Installation Completed", click
Close to proceed to the next screen.
Note: To update only selected configuration files, select the required configuration files
from the table and view the changes of each configuration file. Click on the Update
button. The configuration files selected, along with the configuration files that are
mandatory are updated by the tool.
Step 5 : View Readme and Logs: If you want to go through the Readme and the Logs
created during the Service Pack update, check the "View Readme and Logs" option in the
bottom-left corner of the screen and click the "Close" button. By default this option is
checked. If you do not select this option and close, the main screen is shown.
If you want to uninstall a Service Pack and revert to a previous version, refer to the
Uninstalling Service Pack section.
Installing the Service Pack Through Command Line
In command line mode, the Update Manager can be invoked by the UpdateManager.bat/sh
file. The command to invoke the Update Manager can be interactive or non-interactive. The
interactive method prompts for input for installation option, to avoid any prompting, you can
use the non-interactive mode.
Usage: java com.adventnet.tools.update.installer.UpdateManager {options}
Options are:
[-help Displays this usage.]
[-u (update_conf.xml file path)]
[-h (the product home directory path)]
[-c to invoke in commandline]
[-option i(to install),u(to uninstall),v(to view the installed ServicePack vers
ions)]
[-ppmPath ServicePack file path]
[-version ServicePack version to uninstall]
[-g to invoke in GUI mode]
[-language language(lowercase two-letter ISO-639 code)]
[-country country(uppercase two-letter ISO-3166 code)]
[-fileName propertiesfileName(Give the name of .properties file)]
[-ppmInfo ServicePack file path]
WebNMS Framework 5.2 SP1 :: Installation Guide
47
Zoho Corp.
Interactive Mode :
1. Run the UpdateManager.bat/sh file under <WebNMS Home>/bin directory with the
"-c" option (UpdateManager -c). The options to install, uninstall, view installed Service
Pack versions, and exit will be shown and you will be prompted to enter your choice.
2. Enter "i" to install a new Service Pack. The screen will prompt you to enter the path
where the new Service Pack is located.
3. Enter the absolute path where the new Service Pack is placed. You will see the
update happening and the message "Service Pack installed successfully" will be
shown.
4. The screen will prompt you to mention whether you want to continue. Choosing "y"
will take you back to the first step.
5. Choosing "n" will close the application.
Non-Interactive Mode :
To install a Service Pack using Update Manager in a single command, you can use the
following command
sh UpdateManager.sh -u conf -c -option i -ppmPath <Patch file path> -h <Product
HOME directory>
Note:
1. Preview option is not available for command line installation.
2. The Product HOME directory should be specified if the Update Manager is
being invoked external to your product.
Viewing the Details of a Service Pack
There are two ways in which the Service Pack details can be viewed.
Through UI
Through Command Line
Viewing the Details of a Service Pack Through UI
You may want to know the details of an already installed Service Pack. The details are
shown in two tabs namely, General and Readme. The details like the Service Pack name, its
description, its size, its time of installation, and the list of files that are updated are shown in
the General tab. While the Readme file is shown in the Readme tab.
WebNMS Framework 5.2 SP1 :: Installation Guide
48
Zoho Corp.
The steps to view the details of a Service Pack are as follows.
1. Start Update manager: Either run the UpdateManager.bat/sh file in the <Product
Home>/bin directory or select the Update Manager icon from the WebNMS Launcher.
The text area in the bottom of the screen lists all the Service Packs installed in the
application.
2. View the Service Pack details: Select the Service Pack whose details are to be
viewed. Click the Details button to get the details dialog. It has the two tabs:
General and Readme.
3. Close the details dialog: Click the "Close" button to close the details dialog. Thus
the main screen of Update Manager is shown.
Thus any Service Pack file content can be viewed. You can now continue with the screen
(like viewing the details of another Service Pack) or quit the tool by clicking the "Exit" button.
WebNMS Framework 5.2 SP1 :: Installation Guide
49
Zoho Corp.
Viewing the Details of a Service Pack Through Command Line
1. Run the UpdateManager.bat/sh file under <WebNMS Home>/bin directory with the
"-c" option. (UpdateManager -c)The options to install, uninstall, view installed Service
Pack versions, and exit will be shown and you will be prompted to enter your choice.
2. Enter "v" to view the details of the already installed Service Packs. The screen will
shown you the list of Service Packs installed in the product.
3. The screen will prompt you to mention whether you want to continue. Choosing "y"
will take you back to the first step. Choosing "n" will close the application.
Single command Usage :
sh UpdateManager.sh -u conf -c -option v -h <Product HOME directory>
Note: The Product HOME directory should be specified if the Update Manager is
being invoked external to your product.
Note for 64 bit Installation: If the service pack is installed over a 64 bit Web NMS 5
version, certain 64 bit specific files should be retained. The files under the folder <Web
NMS Home>/lib such as UniqueID.dll, and libUniqueID.so should be copied from the
<Web NMS Home>/Patch/<ServicePack_Name> folder to <Web NMS Home>/lib
folder.
WebNMS Framework 5.2 SP1 :: Installation Guide
50
Zoho Corp.
3.3.8.2 Uninstalling Service Pack
Overview
Uninstalling the Service Pack
o UI mode
o Command Line mode
Overview
You have the option of reverting the changes incorporated by the installation of a Service Pack. You
can revert to the previous version of the Service Pack or to the base version of the application. Before
you start the uninstallation process, make sure no application is running.
Uninstalling the Service Pack
There are two ways in which a Service Pack can be uninstalled.
Through UI
Through Command Line
Uninstalling the Service Pack Using Update Manager Through UI
The steps to revert to a previous version are as follows.
1. Start Update Manager: Run UpdateManager.bat/sh from <WebNMS Home>/bin
directory.
WebNMS Framework 5.2 SP1 :: Installation Guide
51
Zoho Corp.
2. Select the service pack, which needs to be uninstalled, from the list. Click "Uninstall" button to
proceed with the uninstallation.
3. The list of dependent service packs if any will be shown for your confirmation before
proceeding with the process. Click Finish button to proceed.
Thus the specified Service Pack is uninstalled in the application. You can now continue with
the screen (like uninstalling another Service Pack) or quit the tool by clicking the "Exit"
button.
Note: The results of Update and Revert operations are displayed in the Log window.
The message is saved in ConfChanges.log file in <WebNMS Home> /logs for
reference.
Uninstalling the Service Pack Using Update Manager Through
Command Line
1. Run the UpdateManager.bat/sh file under <WebNMS Home>/bin directory with the
"-c" option. (UpdateManager -c). The options to install, uninstall, view installed
ServicePack versions, and exit will be shown and you will be prompted to enter your
choice.
2. Enter "u" to uninstall a Service Pack. The screen will show you the list of installed
Service Packs and prompt you to select the one to be uninstalled.
3. Enter the number corresponding to the Service Pack to be uninstalled. You will see
the uninstallation happening and the message "Uninstalled successfully" will be
shown.
4. The screen will prompt you to mention whether you want to continue. Choosing "y"
will take you back to the first step. Choosing "n" will close the application.
Single command Usage :
sh UpdateManager.sh -u conf -c -option u -h <Product HOME directory> -
version <Patch version>
Please refer to Update Manager Options for details on options.
Note: To see the details of the installed service pack please refer to the Viewing the
Details of a Service Pack section in Installing Service Pack document.
WebNMS Framework 5.2 SP1 :: Installation Guide
52
Zoho Corp.
3.3.9 Uninstalling WebNMS Server
To uninstall WebNMS, make sure you shutdown the WebNMS server first, by following the procedure
given in the section Shutting down server.
Reinitializing Database before Uninstallation
If the data in the database is not required, then it is recommended to reinitialize the database in order
to conserve disk space. For deleting the data, execute the reinitialize_nms.sh/bat file present under
the <WebNMS Home>/bin folder. Executing reinitialize_nms.sh/bat causes all tables present in the
default database schema to be dropped. If you have any custom tables, please ensure that these are
manually deleted because reinitialize_nms.sh/bat does not drop any table that has been altered. If
reinitialization is not performed, the data remains intact and can be reused.
Uninstalling WebNMS Server in GUI Mode
Windows
For uninstalling the WebNMS server, execute the uninstaller.exe file present under the
<WebNMS Home>/_uninst folder.
Linux/Solaris
For uninstalling the WebNMS server, execute the uninstaller.bin file present under the
<WebNMS Home>/_uninst folder.
Uninstalling WebNMS Server in Command Line Mode
For uninstalling in command line mode, execute the command "./uninstaller.bin -is:javaconsole -
console".
Uninstalling WebNMS Server in Silent Mode
For uninstalling in silent mode, execute the command "./uninstaller.bin -is:javaconsole -silent"
Note:
Removing the entire folder where the product is installed will lead to improper
uninstallation.
Locked files (the files that are changed after installation) will not be removed after
uninstallation
WebNMS Framework 5.2 SP1 :: Installation Guide
53
Zoho Corp.
3.3.10 Licensing the Product
Licensing Information
Licensing Procedure
Upgrading License
Licensing Information
There are two types of licensing policies for WebNMS:
Trial User Policy: WebNMS provides an Evaluation (trial) period for 45 days for WebNMS 5,
which can be extended if required. The trial license file is available with the product. If you
need to extend the trial license or obtain a new trial license, e-mail to [email protected].
Registered User Policy: WebNMS provides the Registered user file after you purchase the
product. To get the registered user file, e-mail to [email protected].
Licensing Procedure
After installation, when you start the product, you are required to provide the licensing information in a
License Agreement dialog box that is displayed. Follow the procedure given below:
1. In the initial screen, select I accept the License Agreement (on accepting the license
agreement).
2. Click Next.
3. The User Type screen is displayed.
WebNMS Framework 5.2 SP1 :: Installation Guide
54
Zoho Corp.
If you are an evaluation user, select Evaluation User and click Finish. Now, you are ready to
use the product.
If you are registered user, select Registered User and click Next. Perform the remaining
steps.
4. The Licensee Details screen is displayed. Click Browse and locate the license file in your
local machine.
5. Click Next.
6. The next screen displays list of users who are authorized to use the product in the User
Name drop-down box. Select a user name.
WebNMS Framework 5.2 SP1 :: Installation Guide
55
Zoho Corp.
7. Click Finish.
The licensing procedure is complete and the product is ready to use.
Upgrading License File
This section provides you information on how to upgrade your license file
from an expired trial license to a new trial license
from a current (not expired) trial license to a new trial license
from a trial license to permanent license
from one Edition of WebNMS to another Edition
Expired Trial License to New Trial License
1. After the trial license has expired, when you start any of the WebNMS services or
applications, an error message is displayed (refer to following image).
2. If you need a new trial license, contact our sales team.
3. Place the trial license file in your local machine.
4. Start WebNMSLauncher.sh/bat located in <WebNMS Home> directory. An error
message is displayed.
WebNMS Framework 5.2 SP1 :: Installation Guide
56
Zoho Corp.
5. Click OK. The WebNMS Software License Agreement dialog box is displayed.
6. In the next screen, click Browse and locate the license file in your local machine.
7. Click Next. The license information is displayed.
8. Click Finish.
Current Trial License to New Trial License (extension of validity period)
If you need to extend the validity of your trial license, perform the following procedure.
1. For extending the existing trial license, e-mail to [email protected]. A temporary
license file is sent to you.
2. Place the license file in your local machine.
3. Start WebNMSLauncher.sh/bat located in <WebNMS Home> directory.
4. In the WebNMS Launcher, from Help menu, choose Register. The WebNMS
Software License Agreement dialog box is displayed.
5. In the next screen, click Browse and locate the license file in your local machine.
6. Click Next. The license information is displayed.
7. Click Finish.
Trial License to Permanent License
If you need to upgrade your license from trial to registered version, perform the following
procedure.
1. For a permanent license, e-mail to [email protected].
2. Place the license file in your local machine.
3. Start WebNMSLauncher.sh/bat located in <WebNMS Home> directory.
WebNMS Framework 5.2 SP1 :: Installation Guide
57
Zoho Corp.
4. In the WebNMS Launcher, from Help menu, choose Register. The WebNMS
Software License Agreement dialog box is displayed.
5. In the next screen, click Browse and locate the license file in your local machine.
6. Click Next. The license information is displayed.
7. Click Finish. At the bottom of the WebNMS Launcher, a message 'This evaluation
copy will be valid for 37 day(s)' is displayed because the Launcher is not restarted.
Ignore this message.
8. Restart the Launcher and you will find that you are now a Registered User. You can
verify this by choosing Help > About menu. The text "Product Licensed to:
<user_name>" is displayed.
One Edition to Another
If you need to upgrade your license from one edition of WebNMS to another edition contact
WebNMS Framework 5.2 SP1 :: Installation Guide
58
Zoho Corp.
3.4 Startup Options
3.4.1 Starting WebNMS From WebNMS Launcher
WebNMS Launcher is a single point access for various WebNMS applications and tools that are
bundled with WebNMS. You can perform various operations such as starting, shutting down, or
reinitializing WebNMS Server by double-clicking on the respective icon or by selecting the Options -
>Run menu from the menu bar. The application can also be run by right-clicking on a particular icon
and selecting the Run option. Using WebNMS Launcher is much easier than starting, shutting down
or reinitializing WebNMS server by selecting the respective batch file from the <Web NMS Home>
directory.
The WebNMS Launcher UI is organized in two panels - the top panel and the bottom panel. The top
panel shows all the options or applications that are part of WebNMS. The bottom panel shows the
currently running applications in the form of tabs. The bottom panel also displays the error and
exception messages of the respective applications that are running.
How to Run WebNMS Launcher?
Users can run the WebNMS Launcher, by invoking the script WebNMSLauncher.bat/sh. Running the
script brings up the following screen.
WebNMS Framework 5.2 SP1 :: Installation Guide
59
Zoho Corp.
On right-clicking the Launcher icons, either the menu option "Open" is displayed or a menu list with
"Run", "Settings" and "Log" is displayed. Selecting the menu option "Open" advances the screen to
the next screen containing information related to the icon. Selecting the menu option "Run" executes
the script related to the icon. Selecting the menu option "Settings" allows you to set the classpath
variable, log file name, etc., and other icon specific information.
Following are the applications and tools that can be invoked from Web NMS Launcher.
Start WebNMS Server
Application Client
Applet Client
Shut Down NMS Server
Web NMS IDE
Simulators and Browsers
Administrator Tools
Reinitialize WebNMS
Utilities
Start WebNMS Server
Starts WebNMS Server.
Application Client
This brings up the Application Client i.e., WebNMS Client UI.
Applet Client
WebNMS Applet Client brings up a browser with two options (viz., HTML UI and Java UI).
Users can choose between HTML UI and Java UI.
Shut Down NMS Server
This shuts down the WebNMS server, which is the appropriate way to kill the server.
WebNMS Framework 5.2 SP1 :: Installation Guide
60
Zoho Corp.
WebNMS IDE
WebNMS IDE tools includes the following
Chassis Wizard - The Chassis Wizard is used to build management applications to manage
devices with a framework containing Shelves, Slots, Cards and Ports. It enables to build
configuration management applications for SNMP and TL1 based devices.
Configuration Wizard - The Configuration Wizard is used to build configuration
management applications, to configure the device attributes. It enables to build configuration
management applications for SNMP and TL1 based devices.
BeanBuilder - Invokes the WebNMS BeanBuilder. The WebNMS BeanBuilder is a Java
Beans IDE which provides integration, testing, and packaging environment for a Network
Device and Element management system.
Deployment Wizard - The Deployment Tool helps you to create a nar and install the nar
over WebNMS or uninstall any nar created by you. You can also deploy WebNMS as a
complete package or deploy specific applications, client applications, and device
administration applications over another instance of WebNMS.
WebNMS Framework 5.2 SP1 :: Installation Guide
61
Zoho Corp.
Simulators and Browsers
Simulator and Browsers tools includes the following
MibBrowser - MibBrowser is used to access the values of the Mib variables defined for a
particular system.
TL1 Craft Interface - WebNMS TL1 Craft Interface is used to provide TL1 Browsing and
related functions to users. TL1 Craft Interface allows the user to view and operate on the
data on a managed object through a TL1 agent e.g. a router.
CLIBrowser - The CLIBrowser is a full fledged GUI management application which supports
command line interface and can manage any CLI device.
Multi Protocol Browser - The Multi Protocol Browser is a debugging tool and is used to
verify management operations for Device Information Bases such as MIB, TL1 Command
Set, MO Classes and XML generated by screens to communicate with Management Server.
SNMP Agent Simulator - The SNMP Agent Simulator is used to simulate an SNMP agent
through configuration or by recording data from an existing SNMP agent. You can simulate
SNMP devices such as router, switch, and printer by loading the appropriate MIBs. With an
intuitive UI and powerful scripting language, you can customize the behavior of any device to
simulate its unique behaviour.
TL1 Agent Simulator - The TL1 Agent Simulator is used to simulate a TL1 agent through
configuration or by loading the appropriate TL1 Command Set files.
WebNMS Framework 5.2 SP1 :: Installation Guide
62
Zoho Corp.
Non UI Agent - Non-UI Agent allows you to control the starting and stopping of an agent
using the agent configuration file saved in SNMP or TL1 agent simulator.
TL1 Message Builder - The TL1 Message Builder is used to create and modify TL1
Command Set and Data Set definitions in the XML format. The TL1 Data Set definition file
will have possible values for each command defined in TCS.
Administrator Tools
Administrator tools includes the following
SNMP V3 Security - SNMP V3 Security tool takes care of User permission management
Status Viewer - Status Viewer displays the WebNMS server's status and performance.
Trap Parser - Trap Parsers helps to generate Events from the received SNMP traps. Trap
parser does the job of making the notifications readable to the user.
Event Parser - Event Parser helps to refine the message conveyed by the Events. Event
parser convert Events such as Threshold Events and Status Poll Events into a readable
format.
WebNMS Framework 5.2 SP1 :: Installation Guide
63
Zoho Corp.
Event Filter - Event Filters are used to perform automatic actions, such as sending an email,
suppressing the event, and generate traps, on the occurrence of an event. You can also
execute some classes (Custom Filter Action), when there is a generation of an Event.
Alert Filter - Similar to Event Filters, Alert Filters serve to execute user-specific actions
whenever Alerts are received with configurable matching criteria.
Reinitialize WebNMS
"Reinitialize WebNMS" displays a UI to reinitialize WebNMS database.
Utilities
Utilities tools include the following
Configuration File Checker - Checks the syntax of the configuration files and provides an
UI to rectify errors if any.
Menu Configurator - Helps you to create a new menu or menu item, associate a menu with
a device, customize an existing menu file, and view the source of any menu file.
I18N Editor - WebNMS uses English language of United States locale. Internationalization
can be done in WebNMS. With the help of I18N Editor, the users can replace the English
language words and phrases used extensively in WebNMS with the language of their choice.
Discovery Configurator - Helps you to configure discovery parameters related to General,
Protocol, Network Discovery, Node Discovery and Criteria.
WebNMS Framework 5.2 SP1 :: Installation Guide
64
Zoho Corp.
3.4.2 Starting WebNMS from Bin Directory
This document explains the various ways for starting WebNMS Server from the bin directory on
different platforms such as Windows, Linux and Solaris.
Starting WebNMS Server on Windows
To start the WebNMS server, invoke the batch file startnms.bat from <Web NMS Home>/bin
directory.
Starting WebNMS Server on Linux/Solaris
To start WebNMS server, invoke the shell script startnms.sh from the <Web NMS
Home>/bin directory.
The server has to be run as root in order to enable it to bind port 162 which is the standard
SNMP trap port. Otherwise WebNMS will not be able to receive traps.
WebNMS Framework 5.2 SP1 :: Installation Guide
65
Zoho Corp.
3.4.3 Starting WebNMS From Any Directory
To start WebNMS from any Directory
This document explains the steps to be followed in starting WebNMS from any directory in systems
using the communication protocols TCP and RMI. The procedure is the same for different platforms
though it varies depending upon the communication protocol.
Using TCP
Edit the NMS_HOME environment variable in setEnv.(bat/sh) file located in the
<WebNMS HOME> directory and set it to absolute <WebNMS Home>.
For example, if you have installed WebNMS in "c:/mydir/AdventNet/WebNMS"
directory and want to start WebNMS from "d:/test"directory, then the environment
variable in setEnv.(bat/sh) file should be edited as follows
NMS_HOME=c:/mydir/AdventNet/WebNMS
In startnms.(bat/sh) give the absolute path of the setEnv.(bat/sh) file. By default it is
given as, ./setEnv.(bat/sh). You must now give it as <absolute
path>/setEnv.(bat/sh).
Using RMI
If you want to start WebNMS using RMI connection, in addition to the above edit the
following file.
In startnms.(bat/sh) file located in the <WebNMS Home>/bin add the arguments
BE_FE RMI and change the NMS_BE_PORT from 2000 to 1099 in the NmsMainBE
process.
To Add Your Own Jar Files
To add your own jar files into WebNMS edit CODEBASE_LIST in <WebNMS Home>/setEnv.bat/sh.
(Windows uses http, while Linux uses file protocol). The jar file path is set relative to <WebNMS
Home> directory.
Note: The above change is required only if you are trying to run WebNMS from any other
directory other than the default directory, where WebNMS was installed.
WebNMS Framework 5.2 SP1 :: Installation Guide
66
Zoho Corp.
3.4.5 Starting FE Server
Procedure to start FE Server
o Starting FE Server on Windows
o Starting FE Server on Linux and Solaris
o Starting Standalone FE Server
o Starting FE Server in Application Server
Procedure to connect Client to FE Server
Procedure to shut down FE Server
Procedure to start FE Server
Starting FE Server on Windows
Run the startnmsFE.bat file from <WebNMS Home>/bin directory, to start WebNMS
FE server.
If the WebNMS Server is not running in the localhost, edit the batch file
startnmsFE.bat to specify the host name where WebNMS Server is running, to
connect it to the Back-end server.
Host can be the name of the machine where the WebNMS server is running or the IP
address of the machine.
Starting FE Server on Linux and Solaris
To start the WebNMS Framework Server, invoke the shell script startnmsFE.sh file
from the <WebNMS Home>/bin directory.
If the WebNMS Server is not running in the localhost, edit the shell script
startnmsFE.sh to specify the host name where WebNMS Server is running to
connect to the Back-end server.
Host can be the DNS name of the machine where the WebNMS server is running or
the IP address of the machine.
Starting Standalone FE Server
Open the <Web NMSFE HOME>/bin directory in machine "MachineFE" where the
standalone FE is installed and invoke startnmsFE.bat/sh to start the FE server.
WebNMS Framework 5.2 SP1 :: Installation Guide
67
Zoho Corp.
Starting FE Server in Application Server
The FE server components can be deployed in any of the Application Servers such
as WebLogic. Therefore, when the Application Server is started, the FE is also
started as an application.
Procedure to connect the Client to FE server
The application client can be invoked from either the standalone FE installation or combo installation
since the client application is bundled in both installations. To invoke the client from standalone FE
installation ("MachineFE"), invoke the startApplicationClient.bat file from the bin directory. To invoke
the client from BE-FE combo ("MachineBE"), invoke the startApplicationClient.bat file from the bin
directory.
To connect to the standalone FE installed on "MachineFE", enter the hostname as "MachineFE" or
"localhost" and 9090, the default port value. To connect to the FE in the BE-FE combo installed on
"MachineBE", enter the hostname as "MachineBE" and give the port number as 9090.
To connect the Client to FE, open a Java enabled web browser and specify the URL
http://localhost:9090.
Multiple Clients can be connected simultaneously on different system by specifying the URL
http://server_name:9090 (where server_name depends on the name of the machine where
NMS FE server runs).
Procedure to shut down Standalone FE Server
Invoke shutdownFE.bat/.sh file under <WebNMS FE HOME>/bin directory of "MachineFE". Enter
the user name and password and press Enter. A popup window confirms the shutdown status of the
FE server.
WebNMS Framework 5.2 SP1 :: Installation Guide
68
Zoho Corp.
3.4.6 Starting Application Client
The Application Client and Java UI of the browser have the same functions. The Application Client is
much faster than Java applet UI as it is an applet that is loaded in the browser and it takes time to
load compared to the Application Client which is a standalone EXE file.
Starting the WebNMS Application Client on Windows
The Application client can be started on Windows, by invoking the startApplicationClient.bat file
from the <Web NMS Home>/bin directory. Alternatively, it can be started by clicking the Application
Client icon in the WebNMS Launcher.
Starting the WebNMS Application Client on inux/Solaris
The Application client can be started on Linux/Solaris, by invoking the startApplicationClient.sh file
from the <WebNMS Home>/bin directory. Alternatively, it can be started by clicking the Application
Client icon in the WebNMS Launcher.
Note: By default the Application Client takes the localhost as the host where the BE/FE server
is running. The default user name and password are 'root' and 'public' respectively.
WebNMS Framework 5.2 SP1 :: Installation Guide
69
Zoho Corp.
3.4.7 Reinitializing WebNMS
The process of reinitializing WebNMS database is referred to as reinitializing WebNMS. WebNMS
maintains data and configuration details in a relational database. The database tables used for storing
configuration information is referred to as configuration tables and those created for storing data are
referred to as data tables. Database tables are created both when WebNMS server is started and at
runtime. On reinitializing WebNMS, all the data tables and configuration tables are dropped from the
database. You can reinitialize the database either through the user interface or command line mode.
Reinitializing Database Through UI Mode
To reinitialize the database through the UI Mode,
Run the script reinitialize_nms.bat/sh present in <WebNMS HOME>/bin without any
arguments.
The Reinitialize WebNMS Database dialog box prompts you to confirm if you want to reinitialize the
database. Clicking on the Yes button will drop all the data and configuration details stored in the
database.
Reinitializing Database Through Command Mode
Database can be reinitialized by invoking the following script:
reinitialize_nms.bat/sh MODE <Parameter>
where Parameter should be ALL
When you try to reinitialize the database, a check is made to ascertain whether the WebNMS server is
running. If it is running, the database will not be reinitialized. The database will be reinitialized only
WebNMS Framework 5.2 SP1 :: Installation Guide
70
Zoho Corp.
when WebNMS is not running. When the WebNMS server is running with TCP as the mode of
communication between BE and FE, the database can not be reinitialized through the
reinitialize_nms.sh/bat script.
Internationalization Support
To Internationalize Reinitialize NMS UI, edit the file ReinitializeNmsResources.properties present in
the <WebNMS Home>/html directory. The values for the keys should be substituted by new values.
WebNMS Framework 5.2 SP1 :: Installation Guide
71
Zoho Corp.
3.4.8 Shutting Down WebNMS Server
The WebNMS ShutDown process shuts down all the sub-processes and properly releases all the
system resources. It is necessary that the shutdown process be properly executed to make sure that
the system does not leave any operation incomplete in addition to leaving the database information in
a consistent state. The NMS server can be shutdown only by authenticated users and it is
recommended that the NMS server be shutdown using one of the standard ways.
The following is the sequence of operations which take place during the NMS Server shutdown
process,
1. Stop all the schedulers
2. Notify the registered shutdown observers
3. Unbind all RMI registry objects
4. Shutdown all the sub processes (sub-modules), which will execute specific tasks
5. Shut down the rmiregistry process (if started by WebNMS)
6. Disconnect all database connections
7. Stop pgsql (if started by WebNMS)
8. Shutdown the webserver (if started by WebNMS)
9. Exit (the main process)
The WebNMS BE Server can be shut down by any of the following ways,
Sending a ShutDown request to the BE server through the TCP socket on which it is listening
for connections from FE (the BE_PORT parameter). This is usually the preferred way of
shutting down the BE server.
Executing the ShutDown servlet in the webserver corresponding to the BE Server. This
servlet invokes the ShutDown process in the BE server. This ShutDown process can not be
invoked if the web server is not running in the BE server host.
Executing the corresponding ShutDownAPI method from remote (using RMI). The
ShutDownAPI will be bound in the RMI registry of the BE Server host. The ShutDown
process can not be invoked if the RMI rmi registry process is not running in the BE Server
host.
The shutdown process checks for the authenticity and the permissions of the user invoking the
shutdown operation and allows only if the user has proper permissions.
A standalone application is provided, which uses the above mentioned methods to ShutDown the
WebNMS server. First it tries through the TCP mode. If it fails, it uses the servlet mode. If the servlet
mode also fails, it uses the RMI mode. The user name, password, host name and the ports (TCP,
Web Server, RMI) are configurable in the application.
WebNMS Framework 5.2 SP1 :: Installation Guide
72
Zoho Corp.
The WebNMS Server can be shut down
By invoking the standalone application "Shutdown NMS Server" from the WebNMS Launcher
By invoking the script shutdown.bat/sh from <WebNMS Home>/bin
From the HTML Client
Through Command Line mode
Running the scripts from remote machine
Automatically when the database connection is lost
Shutting down WebNMS Server through the WebNMS Launcher
Run WebNMSLauncher.bat/sh file from<WebNMS Home>. Choose the application "Shutdown NMS
Server". Right click on the icon and choose the "Run"option. A dialog box "Shut Down NMS Server"
comes up for you to type in your password. Click on the OK button for the WebNMS Server to shut
down.
By invoking the script shutdown.bat/sh from <WebNMS Home>/bin
In Windows
Run the ShutDown.bat from <WebNMS Home>/bin. This invokes a UI which prompts the
user to enter the password. On clicking "Settings", you can view your port where the
WebNMS is running, the RMI Registry Port and TCP Port. Click "OK" to successfully shut
down.
In Linux and Solaris
Invoke : sh ShutDown.sh. This invokes a UI which prompts the user to enter the password.
On clicking "Settings", you can view your port where the WebNMS is running, the RMI
Registry Port and TCP Port. Click "OK" to successfully shut down
Shutting down WebNMS Server from HTML UI
To shutdown WebNMS Server from HTML UI, choose the System Administration panel or choose
"File -> System Admin" from the tools menus. Choose the "Shut Down Server" option from the
HTML page displayed. This opens up a new HTML page with the message "Are you sure you want to
ShutDown the server". On clicking "Yes", the WebNMS server will be shutdown.
Note: Only the users with REALM admin, are allowed to shutdown the WebNMS Server.
WebNMS Framework 5.2 SP1 :: Installation Guide
73
Zoho Corp.
Shutting down WebNMS Server through Command Line mode
WebNMS Server can be shutdown through command line
In Windows
Invoke :ShutDown.bat [User Name] [Password]
In Linux and Solaris
Invoke : sh ShutDown.sh [User Name] [Password]
You have to edit the script to meet specific requirements. The script that executes the Java program
StandAloneShutDown has the following arguments.
Host: Host can be the DNS name of the machine where the WebNMS server is running or its
IP address.
Port: The port on which WebNMS is running.
UserName: This is the user name registered with WebNMS, who is authorized to shut down
the WebNMS server. The default username is 'root'.
Password: The password for the above mentioned user. The default password is 'public'.
Running the scripts from remote machine
The script can also be run from a remote machine to shut down the Web NMS server. In order to do
that, the following steps has to be followed.
1. Create a temporary directory say WebNMSShutDown/ on the remote machine.
2. Copy the ShutDown.bat/sh script to this directory.
3. Copy the <WebNMS Home>/classes/StandAloneShutDown.class to this directory.
4. Edit the classpath to point to the current working directory.
5. Edit the script to pass the correct arguments to the StandAloneShutDown class.
Note: You cannot shutdown the WebNMS server, if you accidentally execute
ShutdownWebSvr.bat/sh that is present in <WebNMS Home>/apache, which is used to
shutdown the Web Server. In this case, you have to execute the StartWebSvr.bat/sh file
under <WebNMS Home>/apache directory to restart the Web Server and then execute the
ShutDown.bat/sh to shutdown WebNMS server.
WebNMS Framework 5.2 SP1 :: Installation Guide
74
Zoho Corp.
Internationalization Support
To Internationalize Shutting down WebNMS UI, edit the
ShutDownNmsServerResources.properties file present in <WebNMS Home>/HTML directory. The
values for the keys should be substituted by new values.
Shutdown Automatically When the Database Connection is Lost
Please refer to Automated Shutdown for detailed description.
WebNMS Framework 5.2 SP1 :: Installation Guide
75
Zoho Corp.
3.5 Packages Bundled
3.5.1 Package Structure
The directory structure of WebNMS and the files that are bundled with the product are given below. All
the files are extracted under the <WebNMS Home> directory.
List of directories packaged with WebNMS
Directory Name Description
<WebNMS Home>/_uninst Contains the executable to invoke the
uninstaller.
<WebNMS Home>/ancillary Contains locale specific resource files.
<WebNMS Home>/apache
Contains files and directories related to
Apache Server that is bundled along with
WebNMS.
<WebNMS Home>/bin
<WebNMS Home>/bin/admintools
<WebNMS Home>/bin/backup
<WebNMS Home>/bin/browsers
<WebNMS Home>/bin/developertools
<WebNMS Home>/bin/developertools/build_scripts
<WebNMS Home>/bin/provisioning
Contains the various batch/shell files present
in the WebNMS Web NMS to run various
Applications and Tools.
<WebNMS Home>/bsh-scripts Contains bean shell scripts for provisioning
filters.
<WebNMS Home>/builder_template
<WebNMS Home>/builderconf
<WebNMS Home>/builderdata
Contains Bean Builder template, configuration,
and data files.
<WebNMS Home>/ccs Contains CLI Command Set and Data Set for
generating CLI commands.
<WebNMS Home>/classes Contains most of the essential WebNMS JAR
files, in addition to class files.
<WebNMS Home>/conf
Contains a set of configuration files. The
database configuration files are present in the
respective sub directories within this directory.
<WebNMS Home>/configtasks Contains default tasks for different Protocols
related to Configuration Management.
<WebNMS Home>/data Contains files that are needed for TL1 protocol.
WebNMS Framework 5.2 SP1 :: Installation Guide
76
Zoho Corp.
Directory Name Description
<WebNMS Home>/dbutil Contains database utility files.
<WebNMS Home>/defaultconf
<WebNMS Home>/defaultconf/conf
<WebNMS Home>/defaultconf/html
Contains the default widgets and dashboards
configuration files.
<WebNMS Home>/default_impl
Contains the list of examples that illustrates
the customization features of WebNMS
(default implementation.)
<WebNMS Home>/examples Contains examples for the customization
features of WebNMS
<WebNMS Home>/genTrap Contains files for generating traps.
<WebNMS Home>/help Contains the help directories for WebNMS in
HTML Format.
<WebNMS Home>/html
<WebNMS Home>/html/defaultsToAllUsers
<WebNMS Home>/html/defaultsToNewUsers
<WebNMSHome>/html/defaultsToNewUsers/SASusers
Contains the list of .html and menu files used
in HTML UI browser client of WebNMS.
<WebNMS Home>/icons Contains icon files (.png, .jpg, .ico extension)
used to represent the icons used in WebNMS.
<WebNMS Home>/idls Contains all .idls files.
<WebNMS Home>/images Contains the list of image files (.png, .jpg, .ico
extension) used in WebNMS.
<WebNMS Home>/jre
This directory contains the default bundled jre.
By default all the applications are started using
this jre only.
<WebNMS Home>/jsp Contains a list of .jsp files used in the Web
Client browser client of WebNMS.
<WebNMS Home>/lib
Contains lib file used for native ping and
service file used for starting WebNMS as
service.
<WebNMS Home>/listmenus
Contains a list of .xml files required for the
menus in the Network Database panel of
WebNMS.
<WebNMS Home>/logs Contains the list of log files, generated by
WebNMS.
<WebNMS Home>/mapdata Contains list of .xml files required for the
menus in the Maps panel of WebNMS.
<WebNMS Home>/mibs Contains a list of mib files used to load in the
MIB Manager.
<WebNMS Home>/pgsql Third party software directory.
WebNMS Framework 5.2 SP1 :: Installation Guide
77
Zoho Corp.
Directory Name Description
<WebNMS Home>/NetMonitor Contains jar files that are used for configuring
data.
<WebNMS Home>/projects
Contains Builder Projects, Sources, screens,
and .proj files for the projects developed by the
Client. This directory is not required.
<WebNMS Home>/provisioningresults This directory stores provisioning results.
<WebNMS Home>/provisioningtemplates
Contains .xml files and patch scripts that
invoke the provisioning templates. It also
contains DTDs (Data Type Definitions) for xml
files.
<WebNMS Home>/reports Contains generated performance reports
<WebNMS Home>/servlets Contains all the servlet sources used in
WebNMS.
<WebNMS Home>/state
Contains the sub directory Traps, which
temporarily stores the traps in flat files when
the number of received traps exceed the
maximum capacity of the TrapBuffer. This is
the default directory for storing the flat files
related to traps. A different directory can be set
by modifying the value for SAVE_DIR from
state to the required name in
NMSProcessesBE.conf present under the
<WebNMS Home>/conf directory.
<WebNMS Home>/StudioTools/ClientBuilder
Contains files to run Client Builder tools such
as Chassis Wizard, Configuration Wizard,
Simulators, and Multi Protocol Browser.
<WebNMS Home>/stylesheets Contains stylesheet files for laying out
provisioning templates.
<WebNMS Home>/Themes Contains a list of theme files.
<WebNMS Home>/tutorials Contains various tutorials with the help
documents.
<WebNMS Home>/users Contains the list of users created.
<WebNMS Home>/webclient Contains files related to the Web Client.
<WebNMS Home>/WEB-INF Tomcat related directory.
WebNMS Framework 5.2 SP1 :: Installation Guide
78
Zoho Corp.
List of files under WebNMS
File Description
COPYRIGHT Contains all copyright information of WebNMS.
LICENSE_AGREEMENT This is a License Agreement file containing the terms and
conditions.
README.html ReadMe file contains basic information about WebNMS.
setEnv.bat/sh
The setEnv.bat file is to set the environmental variables
used by the scripts located under the <WebNMS
HOME>/bin. Changes included in this file will gets reflected
in all the shell files used under the <WebNMS HOME>/bin.
WebNMSLauncher.bat/sh Executing this file invokes the WebNMS Launcher.
Note:
On applying Service Pack, a directory named Patch is created, which contains the files
inf.xml and specs.xml.
On registering as Permanent User, a file REGKEY_DATA is created.
WebNMS Framework 5.2 SP1 :: Installation Guide
79
Zoho Corp.
3.5.2 Web NMS Jars
The Web NMS Java Archive Files (JAR) contain classes that are essential for executing the Web
NMS application. The following table list the JARs present in WebNMS and a short description of the
JARs.
Note
Available
Not Available
Need to be downloaded from the web site.
The files marked with this sign in following tables are packaged in a separate file and available
for download at http://webnms/webnms/tutorials/StandardWebNMSAgent.zip
After downloading StandardWebNMSAgent.zip which contains all the Simulator-related files,
extract them under <Web NMS Home>.
List of JARs present in the <Web NMS Home>/classes directory
JAR Name Description Professional
Edition
Free
Edition
AdventNetAboutDialog.jar
Classes for the common "About
Dialog" that will be shown
consistently across all tools.
AdventNetARUtils.jar Contains classes required for
code merging.
AdventNetAgentUIUtilities.jar Contains the UI components of
the Agent Tool kit.
AdventNetBeanBuilder.jar Classes for the functioning of the
BeanBuilder tool.
AdventNetBuilderDeployment.jar
Contains classes for the
invocation of Nar Packager from
within the Bean Builder.
AdventNetBuilderMigration.jar
Classes for the Bean Builder
Migration Wizard that is used to
convert projects from older
version to the latest version.
WebNMS Framework 5.2 SP1 :: Installation Guide
80
Zoho Corp.
JAR Name Description Professional
Edition
Free
Edition
AdventNetCCLLibrary.jar
Contains classes for various
components that form a part of
and are plugged into the Bean
Builder.
AdventNetCLI.jar
This jar provides a command line
interface. Using this we can
support Telnet Protocol.
AdventNetCLIClient.jar
Contains essential classes for
implementation of CLIClient UI in
Web NMSClient.
AdventNetCorbaSimulator.jar Contains classes for parsing IDLs.
AdventNetDMPModels.jar Contains classes for a special
model of the ProListView bean.
AdventNetIDLtoJObjects.jar
Contains classes that are used to
generate Source files for given
IDLs.
AdventNetIdlToXml.jar This jar is required only if Corba
Southbound is used.
AdventNetJmxAgent.jar
Contains AdventNet JMX Agent
APIs and essential classes for
implementation of JMX Agent.
AdventNetProBeans.jar
Provides feature enriched
components for rapid prototyping
of Graphical User Interfaces.
AdventNetProBeansBeanInfo.jar Contains Bean Info for the
AdventNetProBeans jar.
AdventNetSAS.jar Contains WebNMS SNMP Applet
Server APIs
AdventNetSnmp.jar
Contains WebNMS SNMP API.
These API can be used for
creating cross platform Java and
Web-based SNMP network
management applets and
applications.
AdventNetSnmpAgent.jar
Contains WebNMS SNMP Agent
APIs. WebNMS Agent is built on
these APIs.
WebNMS Framework 5.2 SP1 :: Installation Guide
81
Zoho Corp.
JAR Name Description Professional
Edition
Free
Edition
AdventNetSNMPAgentTools.jar Contains the UI components for
SNMP Agent Tools.
AdventNetSnmpDistributedAPI.jar Contains WebNMS SNMP,RMI
and CORBA APIs.
AdventNetSnmpV3USM.jar Contains the WebNMS SNMP v3
settings APIs.
AdventNetSUMClient.jar Contains classes for dynamic
upgradation of clients.
AdventNetSUMServer.jar
Contains classes for the smart
update mechanism that
automatically upgrades the FE
Server and the Application Client
deployments on installation of a
Service Pack just on the BE
Server. This feature is known as
Smart Update Manager (SUM).
AdventNetTftp.jar
Contains TFTP APIs which
provide functionalities to perform
file transfer related operations.
AdventNetThemeManager.jar Contains classes that are used to
created or modify themes.
AdventNetTL1.jar
Contains WebNMS TL1
APIs. These APIs can be used to
build network management
products to manage networks that
support TL1.
AdventNetTL1Agent.jar Contains the classes for building a
TL1 Agent.
AdventNetTL1AgentTools.jar Contains the UI components for
TL1 Agent Tools.
AdventNetTL1Tools.jar
Contains the class files of TL1
tools like TL1CraftInterface, TL1
Message Builder.
AdventNetUI.jar
Contains User Interface bean
components like Bargraph,
Linegraph, Led, Piechart etc.
AdventNetUIBeanInfo.jar
Contains bean infos for the
corresponding User Interface
bean components like Bargraph,
WebNMS Framework 5.2 SP1 :: Installation Guide
82
Zoho Corp.
JAR Name Description Professional
Edition
Free
Edition
Linegraph, Led, Piechart etc. This
jar is not mandatory.
AdventNetUpdateManagerInstaller.jar
Contains classes for Update
Manager tool which is used to
install or uninstall Service Packs.
AdventNetUtils.jar Contains Utility classes for
BeanBuilder.
AdventNetUtilsBeanInfo.jar The BeanInfos for the Utility
Beans. This jar is not mandatory.
AdventNetWebNmsAgent.jar Contains the classes to run Web
NMS Agent.
ApiUtils.jar
Contains set of utility
classes used by the project built
using Bean Builder.
BeanBuilderClasses.jar
Contains the Bean Builder
Classes, an IDE to develop and
customize Client projects.
ClientExamples.jar Contains all client side examples.
ManagementClient.jar
The Management Client is a
generic light-weight , protocol
neutral API using which
transactions like request-
response, polling, events can be
done for any protocol like SNMP,
TL1, etc through
ManagementServer.
ManagementServer.jar
The Management Server is a
generic protocol neutral
API using which transactions
such as request-response, polling,
events can be done for any
protocol like SNMP, TL1, etc.
NarPackager.jar
NarPackager archive. Contains
Builder classes some of which are
used for Nar Utilities.
NmsClientClasses.jar Contains classes related to NMS
client.
WebNMS Framework 5.2 SP1 :: Installation Guide
83
Zoho Corp.
JAR Name Description Professional
Edition
Free
Edition
SNMPConfigurationTool.jar
Contains classes that are used for
inputting parameters into the
SNMP V3 database, which is
used for discovery and time
synchronization.
SNMPDebugger.jar Contains the classes for the
logging framework.
SwingImages.jar
Contains the Images for the
Swing Beans to be loaded in the
BeansPalette of the Bean Builder.
xmojo.jar Contains classes related to JMX.
AdventNetSnmpBeanInfo.jar Contains Bean Info classes for
AdventNetSnmp.jar
AdventNetJavaAgentComponent.jar Contains classes that are required
to run the NMS JMX Agent.
AdventNetRuntimeUtilities.jar Contains classes that are required
to run the NMS JMX Agent.
AdventNetTcsToXmlConvertor.jar Contains classes for converting
TL1 .tcs file to PNIB XML format.
AdventNetToolsUtilities.jar
Contains classes used by studio
tools to show Tool Tips, Help,
etc.
NmsServerClasses.jar Contains classes related to NMS
server.
List of EJB JARs bundled in WebNMS. It is present in
<Web NMS Home>/ejb_jars directory
JAR Name Description Professional
Edition Free Edition
AlertEJB.jar
This contains EJB classes specific to
Alert module that can be deployed in
JBoss Application Server.
ConfigEJB.jar
This contains EJB classes specific to
Configuration module that can be
deployed in JBoss Application Server
EventEJB.jar This contains EJB classes specific to
Event module that can be deployed in
WebNMS Framework 5.2 SP1 :: Installation Guide
84
Zoho Corp.
JAR Name Description Professional
Edition Free Edition
JBoss Application Server
MapEJB.jar
This contains EJB classes specific to
Map module that can be deployed in
JBoss Application Server
PerfEJB.jar
This contains EJB classes specific to
Performance module that can be
deployed in JBoss Application Server
TopoEJB.jar
This contains EJB classes specific to
Topology module that can be deployed
in JBoss Application Server
List of JARs present in the <Web NMS Home>/NetMonitor/build directory
Contains utils classes which will be used in the sources generated using Studio.
JAR Name Description Professional
Edition Free Edition
AuthMain.jar Contains classes for security
administration.
ConfigPanel.jar Contains classes which are used for batch
configuration.
RuntimeConfigFrame.jar Contains classes for configuring data
during run time configuration.
PerformanceGraphs.jar Contains classes related to performance
graphs
List of JARs present in the <WebNMS Home>/StudioTools/ClientBuilder/Jars
directory
JAR Name Description Professional
Edition Free Edition
AdventNetAgentSimulator.jar Contains the core Simulator
classes.
AdventNetAgentSimulatorRuntime.jar Contains the Agent Simulator
runtime classes.
AdventNetSimulatorImages.jar Contains the images of Agent
Simulator.
WebNMS Framework 5.2 SP1 :: Installation Guide
85
Zoho Corp.
JAR Name Description Professional
Edition Free Edition
AdventNetSimulatorUtils.jar Contains the Agent Simulator
utilities classes.
AdventNetSimulatorUIUtils.jar Contains the UI components of
the Agent Simulator.
AdventNetBuilderXMLFramework.jar
Contains utility classes required
for converting MIBs to PNIB XML
format.
AdventNetMibToXMLConverter.jar Contains classes for converting
MIB files to PNIB XML format.
AdventNetMowToXMLConvertor.jar
Contains classes for converting
ManagedObject classes to PNIB
XML format.
AdventNetMSBeans.jar Contains run time bean classes
for Configuration.
AdventNetMSBeansBeanInfo.jar Contains Bean Info classes for
AdventNetMSBeans.jar.
AdventNetSimulatorDB.jar
Contains database utility classes
required for SNMP & TL1 Agent
Simulator.
AdventNetSnmpBeanInfo.jar Contains Bean Info classes for
AdventNetSnmp.jar
AdventNetTcsXmlConvertor.jar Contains classes for converting
TL1 .tcs file to PNIB XML format.
GenVarPanel.jar Contains run time bean classes
for Chassis Wizard.
AdventNetJavaAgentComponents.jar
List of JARs present in the <WebNMS Home>/StudioTools/Studio/Jars
directory
JAR Name Description Professional
Edition Free Edition
WebNMSEclipsePlugin.jar Contains plugin classes used by Eclipse.
WebNMS Framework 5.2 SP1 :: Installation Guide
86
Zoho Corp.
3.5.3 Third Party Software
In addition to WebNMS's other products such as Bean Builder, TL1 API, SNMP API, CLI API and
Agent Simulator, third party softwares are also bundled with WebNMS to provide additional
enhancement to the product. The following table lists the databases and packages bundled with
WebNMS. Please see the COPYRIGHT file available under <WebNMS Home> folder for details about
the copyright of the third party software and the respective License Agreement.
Databases and Packages bundled with WebNMS
Package / Jar Name Version License Information
activation.jar
(JavaBeans Activation
Framework)
Version 1.0.2 Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
Mail.jar (JavaMail) Version 1.3.1 Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
JRE
Linux- Version 1.6.0
Solaris - Version 1.6.0
Windows -
Version 1.6.0
Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
Tomcat Version 5.5.20 Covered under the Apache Software License
Version 1.1
XML
jaxp.jar
crimson.jar
xalan.jar
Note: By default, WebNMS
Standard Edition is bundled
with JRE 1.6.0.
JRE 1.4.0 and above
versions contain the crimson,
jaxp, and xalan JARS.
Hence, these JARs are not
available in the WebNMS
Standard Edition. Also these
JARs are used by WebNMS
Developer Tools only.
Version 1.1
Covered under the Sun Microsystems, Inc.
Binary Code License Agreement and the
Apache Software License Version 1.1
jfreechart.jar
jcommon.jar Version 1.0.0
Covered under the GNU Lesser General Public
License.
WebNMS Framework 5.2 SP1 :: Installation Guide
87
Zoho Corp.
Package / Jar Name Version License Information
jta.jar
(Java Transaction API) Version 1.0.1a
Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
AdventNetJta.jar
(Java Telnet Application) -
Commercially licensed by AdventNet from the
developers.
JimiProClasses.jar
(JIMI Software Development
Kit)
Version 2.0 Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
PostgreSQL Database
Linux-9.0.1 -1.i386
(Client and Server)
Solaris-9.0.1
Windows-9.0.1
PostgreSQL Database is bundled with
WebNMS for development purposes only.
Distribution of PostgreSQL with Customer's
developed applications requires a license from
PostgreSQL, which is not granted with the
WebNMS license. Licensee shall contact
PostgreSQL (http://www.postgresql.org/) for a
license to distribute PostgreSQL..
PostgreSQL
(JDBC Driver)
Linux-PostgreSQL 9.0
JDBC4
Solaris-PostgreSQL 9.0
JDBC4
Windows-PostgreSQL
9.0 JDBC4
Covered under the GNU Lesser General Public
License.
OpenORB
openorb_tools-1.2.0.jar
openorb-1.2.0.jar
Note: These are available
only in WebNMS
Professional Edition.
Version 1.2 Covered under the OpenORB License (BSD
like License).
bsh-1.2b3.jar Version 1.2 Covered under the GNU Lesser General Public
License.
comm.jar Version 2.0 Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
Jython
jython.jar Version 2.1 Covered under the Jython Software License.
jcvs.jar - Covered under the GNU Lesser General Public
License.
ftp.jar - Covered under the GNU Lesser General Public
License.
Java Web Start Developer
Pack Version 1.2
Covered under the Sun Microsystems, Inc.
Binary Code License Agreement.
WebNMS Framework 5.2 SP1 :: Installation Guide
88
Zoho Corp.
Package / Jar Name Version License Information
jnlp.jar
jasperreports.jar - Covered under the Jasper Reports License.
Struts Version 1.1 Covered under the Apache Software License
Version 1.1
itext-1.02b.jar - Covered under MOZILLA PUBLIC LICENSE
p6spy.jar 1.3 Covered under p6spy software license version
1.1
Log4j.jar 1.2.12 Covered under Apache Software License
version 1.1
j2ssh-common.jar,
j2ssh-core.jar j2ssh0.2.7
Covered under the GNU Lesser General Public
License
Wrapper Services
wrapper.jar Version 3.2.3 Covered under MIT license.
jgroups-all.jar Version 2.6.3.CR2 Covered under the GNU Lesser General Public
License.
json.jar - Covered under the BSD license.
ehcache-1.2.3.jar Version 1.0 Covered under Apache Software License
version 2.0
commons-fileupload-1.1.1.jar Version 2.1.1 Covered under Apache Software License
version 2.0
ant.jar Version 1.7.0 Covered under Apache Software License
version 2.0
antlr-2.7.6.jar Covered under the JGuru Software License.
ant-antlr-1.6.5.jar Version 1.6.5
Covered under Apache Software License
version 2.0
commons-beanutils.jar Version 1.6 Covered under Apache Software License
version 2.0
commons-collections.jar Version 2.1.1 Covered under Apache Software License
version 2.0
commons-digester.jar Version 1.8 Covered under Apache Software License
version 2.0
taglibs-mailer.jar - Covered under Apache Software License
version 1.1
cglib-2.1.3.jar - Covered under Apache Software License
version 1.1
WebNMS Framework 5.2 SP1 :: Installation Guide
89
Zoho Corp.
Package / Jar Name Version License Information
commons-logging-1.0.4.jar Version 1.0.4 Covered under Apache Software License
version 1.1
asm-attrs.jar Version 1.5.3 Covered under the France Telecom Software
License.
asm.jar Version 1.5.3 Covered under the France Telecom Software
License.
c3p0-0.9.1.jar Version 0.9.1 Covered under the GNU Lesser General Public
License
hibernate3.jar Version 3.2.6.ga Covered under the GNU Lesser General Public
License
dom4j-1.6.1.jar - Covered under the MetaStuff Software
License.
js/jquery-1.7.2.min.js
js/jquery-ui-
1.7.2.custom.min.js
- Covered under the MIT License.
calendar-en.js
calendar-setup.js
calendar.js
Version 0.9.6
Covered under the GNU Lesser General Public
License
smslib-3.5.2.jar Version 3.5.2 Covered under Apache Software License
version 2.0
commons-net.jar Version 1.4.1 Covered under Apache Software License
version 2.0
ganymed-ssh2-build210.jar Version 1.0 Covered under Swiss Federal Institute of
Technology (ETH Zurich)
RXTXcomm.jar Version 1.0 Covered under the GNU Lesser General Public
License
dwr.jar Version 3.0 RC 2 Covered under Apache Software License
version 2.0
Highcharts Version 2.3.3 Covered under Highsoft OEM License
terminal-web.jar
terminal.jar
terminal-ssh-maverick.jar
Version 2.0.8 Covered under OEM License
virtualsession.jar Version 2.0.0 Covered under OEM License
WebNMS Framework 5.2 SP1 :: Installation Guide
90
Zoho Corp.
Package / Jar Name Version License Information
maverick-all.jar Version 1.4.35 Covered under OEM License
bootstrap.jar Version 1.0 Covered under Apache Software License
version 2.0
dojo - Covered under The Dojo Foundation license
select2 Version 3.2 Covered under Apache Software License
version 2.0
Gson.jar Version 2.2.4
Covered under Apache Software License
version 2.0
Asynchbase-1.5.0.jar Version 1.5.0 Covered under BSD style License
Zookeepr-3.3.6 Version 3.3.6 Covered under Apache Software License
version 2.0
Suasync-1.4.0 Version 1.4.0 Covered under 3-clause BSD license
Sl4j-api-1.7.7 Version 1.7.7 Covered under MIT license
Protobuf-java-2.5.0 Version 2.5.0 Covered under New BSD License
Objenesis-1.3 Version 1.3 Covered under Apache Software License
version 2.0
Netty-3.9.0 Version 3.9.0 Covered under Apache Software License
version 2.0
Cloudera Component Jars
(Hadoop, HBase, HDFS,
yarm, mapreduce, yarn, kite,
impala, hive/hcatalog,
zookeeper)
Version 5.1.1 Covered under Apache Software License
version 2.0
Gwt-user-2.6.0 Version 2.6.0 Covered under Apache Software License
version 2.0
Tsdb-2.0.0 Version 2.0.0 Covered under Apache Software License
version 2.0
Jackson-core-2.1.1 Version 2.1.1 Covered under Apache Software License
version 2.0
Jackson-databind-2.1.5 Version 2.1.5 Covered under Apache Software License
version 2.0