Installing Service Pack



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.

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.

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.


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.

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.

  1. 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.

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 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.

  1. 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


[-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]


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>

Viewing the Details of a Service Pack


There are two ways in which the Service Pack details can be viewed.

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.


The steps to view the details of a Service Pack are as follows.


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.


Viewing the Details of a Service Pack Through Command Line

Single command Usage :


sh UpdateManager.sh  -u  conf  -c  -option  v  -h   <Product HOME directory>


  1. Note: The Product HOME directory should be specified if the Update Manager is being invoked external to your product.

  1. 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.


Copyright © 2013, ZOHO Corp. All Rights Reserved.