Update Manager

The Update Manager is a tool which is used for installing the service packs (.ppm file) over a product. The service pack may contain certain bug fixes and new feature additions for a particular release version of the product. The service pack can be classified to be either an ordinary without referring to any context of the product (Non - Context based) or it may be context based. This document explains about how to use the Update manager for installation of Software upgrades in AdventNet products. It can be also used by products developed over these products.

Context based patch implies that the patch will have the consolidated upgrades for all the different components of the same product. For example WebNMS FE & WebNMS Client are different contexts of the product WebNMS. The same patch can be used for updating any context of the product. The Update manager also provides a feature for having Mandatory context and Optional contexts. The Mandatory context can also be called compulsary context and will not be displayed at the time of installation. An Optional context is some additional upgrades, but is not absolutely necessary for the product to function.

The Update Manager also has some useful validation incorporated. This validation includes compatability checks. If a service pack is not compatable ie., service pack of one product is installed in other product , or service pack of one product version installed in other version , then update manager will not allow the user to install these types of service packs.

The UpdateManager also has patch integrity verification to ensure the patch file that is to be applied is not tampered. The contents of the patch file is digitally signed with a trusted certificate and during UpdateManager validation process, the integrity of the patch contents are verified with the help of the digital signature.

To open the Update Manager tool run the "UpdateManager.bat/sh" file present in the <product home>/bin directory.

The Update manager can be operated in two modes ie., UI and non-UI mode.

Update Manager in Command line or non-UI Mode

For starting the update manager in command line or non-UI mode, there are two ways.

1. Run the UpdateManager.bat/sh file with -c as a command line argument.
2. The user has to edit the script file ie., UpdateManager.bat or UpdateManager.sh depending on the OS. The change required is very simple, just an addition of one more argument -c (%JAVA_HOME%\bin\java -Xmx100m com.adventnet.tools.update.installer.UpdateManager -u conf -c).

The main features of the Update Manager command line are:

- To install the patch through command line.
- To uninstall a service pack using command line.

To install the patch through command line

- On invoking the update manager in command line mode, it will ask the user to select a option as shown in the image below:

- For installation enter i and press enter.
- Before installation, for patch integrity verification the public key certificate "latest.crt" should be downloaded from manageengine website and imported.Please check the steps here for importing certificate.
- The update manager will prompt for Service pack file name. Here enter the full path of the .ppm file.
- If Optional contexts are available in the Service pack the the Update manager will ask the user wether he/she wants to install them. On selecting to install the optional context , the list of contexts are printed in the console. Now one can select the contexts required.

Now the Update Manager will start the installation process.

To uninstall a service pack using command line

- On invoking the update manager in command line mode, it will as the user to select a option.
- For installation enter u and press enter.
- The tool will request to user to select the version to Uninstall. Here the user will have to enter the serial number of the version to be uninstalled.

Now the Update Manager will start the Uninstallation process.

Update Manger UI

The main features of the Update Manager UI are:

- To install the Service Pack.
- To view Installed Service Pack details
- To Uninstall a installed Service Pack.

To install the Service Pack.

Run the UpdateManager.bat/sh script without any arguments to invoke UpdateManager in UI mode. The UI will be displayed as shown below:

During the installation of a patch, the corresponding files related to bug fixes are updated inside the product installation directory according to the respective file locations.

- Before browsing for the patch file, for patch integrity verification the public key certificate "latest.crt" should be downloaded from manageengine website and imported.Please check the steps here for importing certificate.
- Use the browse button to give the service pack file (.ppm). The patch(.ppm) file will be validated and patch integrity will also be verified before the file will be given as input, then Readme button will get enabled.
- On clicking the Readme button the readme file related to this service pack is displayed in a seperate window.
- When install button is clicked a new panel is displayed giving details of service patch and progress in installation.

The tool will intimate the user on completion of the installation process.

To view Installed Service Pack details

The installed service packs are listed in the main window of the Update manager.

- The details can be viewed by selecting the service pack version and clicking the Details button. The following screen will be shown.

- A dialog pops-up displaying the General details about the patch in a tab. It contails the patch name, description, installed size and installation time.
- The installation files details are shown below these details.
- The other tab displays the README related to this Service pack.
- The details can also be viewed by double clicking the required service pack version.

To Uninstall a Service Pack

To uninstall the service pack:

- Select the version from the list shown. Then click on the Uninstall button. The following screen will be shown.

- This will bring up a dialog which shows the service pack to be uninstalled. It also lists all the related service packs that will be uninstalled.
- On clicking the Uninstall button the status screen is displayed, which shows the progress in uninstallation.

Steps for Importing Certificate for Patch Integrity Verification.

- For users with network connection, the public key certificate will be automatically downloaded from manageengine site and imported when UpdateManager is invoked.
- Proxy configurations can also be specified by the users if the manageengine site is unreachable with their network. The proxy configurations can be specified in a file named um_proxy.props placed inside <product home>/conf directory.
- The sample um_proxy.props file image is attached below

For users with no network connection, follow the below steps:

Import Certificate in Command Line or non UI Mode

- After invoking UpdateManager in command line mode, from the list of options provided select option c to import the certificate.
- It will ask the user to enter the path where the certificate was downloaded. Check the image below:

- As shown in the image, the certificate can be downloaded from the url "https://updates.manageengine.com/certificates/latest.crt" . After downloading, provide the certificate path and press Enter and the certificate will be imported successfully.

Import Certificate in UI Mode

- After invoking UpdateManager in UI mode, in the UpdateManager UI, click the Import Certificate button in the UpdateManager UI displayed.
- It will open up the ImportCertificate Dialog box as shown in image below:

- The certificate can downloaded by clicking hyperlink text here in the import certificate dialog. Then browse the certificate path and then press Import button and the certificate will be imported successfully.