Licensing Installation Instructions for WebLM 4.6

Transcription

1 Licensing Installation Instructions for WebLM 4.6 TABLE OF CONTENTS 1 Release Details Files WebLM Server WebLM.war Documentation Licensing Installation Instructions Licensing Release Notes Release Installation Installing and configuring the WebLM server Hardware Pre-requisites Installation Using InstallShield Pre-Installation steps for the Windows operating system Pre-Installation steps for the Linux operating system Modes of installation using InstallShield Wizard WebLM installer steps for Windows operating system in the GUI mode WebLM installer steps for Linux operating system in the GUI mode WebLM installer steps for Windows operating system in the silent mode WebLM installer steps for Linux operating system in the silent mode (Recommended for co-resident WebLM in Proactive Contact) Installation Using Manual Instructions Pre-Installation steps for the Windows operating system Pre-Installation steps for the non-windows operating system Manual Installation Procedure for Windows operating system Manual Installation Procedure for non-windows operating system Enable HTTPS WebLM Configuration Installation using RPM Dependencies Pre-requisites Mandatory Optional Installation Installation Verification Accessing WebLM WebLM Server Uninstallation Uninstallation using InstallShield Uninstallation using InstallShield (Windows) Uninstallation using InstallShield (Linux) Manual Uninstallation Un-installation using RPM Mandatory pre-requisites Un-installation Un-installation Verification steps WebLM upgrade The steps to migrate to a new WebLM version, from WebLM 4.5.x to WebLM Restoring WebLM configuration after re-installation Migration From WebLM 4.5.x to WebLM Page 1 of 59

2 1 Release Details This section lists down the contents of the deliverable. 1.1 Files Following files are delivered with this release: WebLM Server The WebLM server is the web application that manages licenses for Avaya products. This is delivered as a web archive file which can be deployed in a Tomcat servlet container WebLM.war This is the server module developed and built in JDK 1.5.0_07 and Tomcat environment Documentation Following documents are released along with this release: Licensing Installation Instructions This document describes the detailed information with respect to how to install WebLM components Licensing Release Notes This document provides detailed information on what is fixed in a given release and who is the intended audience for this release. 2 Release Installation This section describes the detailed installation instructions for various WebLM server module. 2.1 Installing and configuring the WebLM server To install WebLM server, you must perform the following steps: Verify the existence of the hardware pre-requisites Perform the Pre-Installation steps Perform the installation steps Hardware Pre-requisites Page 2 of 59

3 The WebLM server has some hardware pre-requisites. For a new installation of WebLM or an upgrade of earlier releases of WebLM to a new release using any one of the installation methods, the mentioned pre-requisites must be satisfied. Therefore, before you install WebLM server on a system verify the existence of the following hardware pre-requisites. CPU Pentium II or equivalent, 750 MHz speed recommended Memory Minimum 256 MB RAM Disk Minimum 1 GB Hard disk When all the pre-requisites are satisfied on your system, install the WebLM server. The WebLM server can be installed using any one of the following methods: (a) Installation Using InstallShield Installer includes all three modules i.e. JRE, Tomcat and WebLM. (b) Installation Using Manual Instructions All three modules i.e. JRE, Tomcat and WebLM need to be installed manually. (c) Installation Using RPM This is supported only for Linux platform. RPM would install WebLM and require JRE and Tomcat to be already installed. Note: If this is an upgrade scenario, refer to WebLM upgrade on page Installation Using InstallShield To install the WebLM server, it is necessary to perform the Pre-Installation steps. The Pre- Installation steps for the Windows operating system vary from that of the Linux operating system. Identify and perform the correct steps as per your operating system. Notes If tomcat is already installed using a non core services tomcat assembly on the system on which WebLM needs to be installed, the user must follow the manual installation instructions for WebLM installation (refer to Installation Using Manual Instructions). The WebLM installer does not support this. If tomcat is not already installed, the InstallShield wizard can be used for WebLM installation Pre-Installation steps for the Windows operating system Perform the following pre-installation steps on a system with Windows operating system: 1. Verify whether an entry for the local host IP address exists in the hosts file of your system. For a Windows system, the hosts file is usually located under C:\WINNT\system32\drivers\etc folder. The entry in the file should read as follows: <Localhost_IP_address> localhost 2. If tomcat is already installed using a core services tomcat assembly and if the tomcat service is running, ensure to stop tomcat before running the WebLM installer. Note: All the applications deployed in the tomcat container will stop responding on stopping of the tomcat service. Page 3 of 59

4 Pre-Installation steps for the Linux operating system Perform the following pre-installation steps on a system with Linux operating system: 1. Verify that the following utilities/packages are installed over the base OS for the InstallShield assemblies to be functional: bc X Window System Use the which bc command to verify if bc is installed: Use the which X command to verify if X Window System is installed: If these utilities/packages are not already installed, install them before installing WebLM using the InstallShield wizard. Note: X-Window System is not required if one is planning to execute the installer in silent mode. 2. Verify whether an entry for the local host IP address exists in the hosts file of your system. For a Linux system, the hosts file is usually located under /etc folder. The entry in the file should read as follows: <Localhost_IP_address> <Machine_Name> localhost.localdomain localhost 3. If tomcat is already installed using a core services tomcat assembly and if the tomcat service is running, ensure to stop tomcat before running the WebLM installer. Note: All the applications deployed in the tomcat container will stop responding on stopping of the tomcat service Modes of installation using InstallShield Wizard You can use the WebLM installer in any one of the following modes to install and configure a WebLM server: GUI mode Graphical User Interface (GUI) mode Silent mode In the GUI mode, the WebLM installer displays and accepts inputs from a user through its dialogs in an interactive manner. The steps to install WebLM server in the GUI mode, vary with the Page 4 of 59

5 operating system. Depending upon your operating system, perform any one of the following set of steps: Silent mode WebLM installer steps for Windows operating system in the GUI mode WebLM installer steps for Linux operating system in the GUI mode Important: When an adopting product house uses the WebLM assemblies in their product Installer, the product house can decide whether to configure SSL Port using a dialog box, SSL Port dialog box, or not. If the product house decides to use the SSL Port dialog box, they need to define a variable PromptPortWebLM in the PropertyManager of their product Installer as global and persisted and set the variable to True. If the PromptPortWebLM variable is not set to true or is not defined, the SSL Port dialog box will not be displayed and the SSL port will have a default value of In the silent mode, the WebLM installer runs in a non-interactive mode without prompting for any input from the user. The steps to install WebLM server in the silent mode, vary with the operating system. Depending upon your operating system, perform any one of the following set of steps: WebLM installer steps for Windows operating system in the silent mode WebLM installer steps for Linux operating system in the silent mode(recommended for co-resident WebLM in Proactive Contact) WebLM installer steps for Windows operating system in the GUI mode The WebLM installer is available at the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Follow the steps below (with the snapshots) to install WebLM using the installer. Step 1: Copy the WebLM_Install_Product.exe to a local folder on Windows machine. Double click the file to start the installer. Note: Once the installer is executed, the user will notice a console that comes up. Do not close this console until the installation is over. The system displays the Welcome to the InstallShield Wizard for WebLM dialog box. Figure 1: Welcome to the InstallShield Wizard for WebLM dialog box Page 5 of 59

6 Step 2: Click on Next button. Page 6 of 59

7 The system displays the Change Directory Name dialog box. Note: WebLM is installed within a %CSBASE% folder. The default value of %CSBASE% is C:\opt\coreservices. Figure 2: Change Directory Name dialog box Page 7 of 59

8 Step 3: In the Change Directory Name dialog box, click Browse to change the product directory or click Next. Depending on the button you selected in the Change Directory Name dialog box, the system displays the Open dialog box or the Port Number dialog box. If you selected Browse, perform the following steps to change the installation directory: 1. In the Open dialog box, select the required directory where you want WebLM product files to be installed. Click Open. 2. In the Change Directory Name dialog box, click Next. The system displays the Port Number dialog box. Figure 3: Port Number dialog box Page 8 of 59

9 Step 4: The default HTTPS port is If you have configured HTTPS on a different port, enter the port number. Note: As per the Licensing Conformance Requirements [ M-850], licensed products shall utilize port for HTTPS communication with WebLM server. Click on Next button. The system displays the Summary dialog box. Figure 4: Summary dialog box Page 9 of 59

10 Step 5: Click on Install button. The system displays the Installation Progress dialog box. Let the installation complete Figure 5: Installation Progress dialog box Page 10 of 59

11 Step 6: The system displays the Completed dialog box once the installation is complete. Figure 6: Completed dialog box Step 7: Click Finish to complete the installation program. Step 8: Clicking on Finish button would result in opening the WebLM Configurator. The system displays the Welcome dialog box for WebLM Configurator. At this point of time, WebLM is installed. Use the WebLM Configurator only if there is a need to change the default values of the WebLM server properties. For information on configuring WebLM, see Using the WebLM Configurator to set the WebLM server properties for Windows operating system else click Cancel to exit the WebLM Configurator. Page 11 of 59

12 Using the WebLM Configurator to set the WebLM server properties for Windows operating system You can configure WebLM immediately after installing WebLM or at a later time. To configure WebLM later, execute the WebLM Configurator, config.exe that exists within the %CSBASE%\WebLM\product folder of the WebLM installation directory. To configure WebLM, perform the following actions: Step 1: If you are configuring WebLM immediately after the installation, click Finish in the Completed dialog box of the WebLM Installer. The system displays the Welcome dialog box for WebLM Configurator. Figure 7: Welcome dialog box for WebLM Configurator Page 12 of 59

13 Step 2: Click Next. The system displays the WebLM Configuration Properties dialog box. Figure 8: WebLM Configuration Properties dialog box Change the default values as required. In the Log File Location field, enter the path of the folder within which you want to save the WebLM log file. In the Log File Maximum Backup Index field, enter the number of WebLM log files that can be created. You can enter any number within the range of 1 through 5. In the Log File Maximum File Size (in MB) field, enter the maximum file size of the WebLM log file. You can enter any number within the range of 1 through 10. In the License Allocation Backup File Size (in MB) field, enter the maximum file size of the License allocation backup file. You can enter any number within the range of 1 through 10. Page 13 of 59

14 Step 3: Click Next. The system displays the Configuration Summary dialog box. Figure 9: Configuration Summary dialog box Page 14 of 59

15 Step 4: Click Configure. The system displays the Configuration Completed dialog box when configuration is complete. Figure 10: Configuration Completed dialog box Step 5: Click Finish to complete the configuration program and exit the WebLM Configurator. The installation and configuration of the WebLM server on a Windows operating system is now complete. To access WebLM, see Accessing WebLM. Page 15 of 59

16 WebLM installer steps for Linux operating system in the GUI mode The WebLM installer is available at the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Follow the steps below (with the snapshots) to install WebLM using the installer. Step 1: From the above location, copy the installer file WebLM_Install_Product.bin on the Linux machine. Step 2: Execute the following command to su to root: su - Step 3: Change to the directory location where the WebLM installer is located. Assign executable permissions to the installer. Example: chmod 755 WebLM_Install_Product.bin Step 4: Using the following command, execute the WebLM installer as root:./weblm_install_product.bin The system displays the Welcome to the InstallShield Wizard for WebLM dialog box. Figure 11: Welcome to the InstallShield Wizard for WebLM dialog box Page 16 of 59

17 Step 5: Click on Next button. The system displays the Change Directory Name dialog box. Note: WebLM is installed within a $CSBASE folder. The default value of $CSBASE is /opt/coreservices Figure 12: Change Directory Name dialog box Page 17 of 59

18 Step 6: In the Change Directory Name dialog box, click Browse to change the product directory or click Next. Depending on the button you selected in the Change Directory Name dialog box, the system displays the Open dialog box or the Port Number dialog box. If you selected Browse, perform the following steps to change the installation directory: 1. In the Open dialog box, select the required directory where you want WebLM product files to be installed. Click Open. 2. In the Change Directory Name dialog box, click Next. Page 18 of 59

19 The system displays the Port Number dialog box. Figure 13: Port Number dialog box Step 7: The default HTTPS port is If you have configured HTTPS on a different port, enter the port number. Note: As per the Licensing Conformance Requirements [ M-850], licensed products shall utilize port for HTTPS communication with WebLM server. Click on Next button. The system displays the Summary dialog box. Figure 14: Summary dialog box Page 19 of 59

20 Step 8: Click on Install button. The system displays the Installation Progress dialog box. Let the installation complete Figure 15: Installation Progress dialog box Page 20 of 59

21 Step 9: The system displays the Completed dialog box once the installation is complete. Figure 16: Completed dialog box Page 21 of 59

22 Step 10: Click on the Finish button. The system displays the Logout dialog box. If you decide not to log out immediately, click on Finish. Page 22 of 59

23 Ensure to log out and log back in before starting tomcat. Figure 17: Logout dialog box Step 11: Clicking on Finish button would result in opening the WebLM Configurator. The system displays the Welcome dialog box for WebLM Configurator. At this point of time, WebLM is installed. Use the WebLM Configurator only if there is a need to change the default values of the WebLM server properties. For information on configuring WebLM, see Using the WebLM Configurator to set the WebLM server properties for Linux operating system else click Cancel to exit the WebLM Configurator Using the WebLM Configurator to set the WebLM server properties for Linux operating system You can configure WebLM immediately after installing WebLM or at a later time. To configure Page 23 of 59

24 WebLM later, execute the WebLM Configurator, config.bin that exists within the $CSBASE/WebLM/product folder of the WebLM installation directory. To configure WebLM, perform the following actions: Step 1: If you are configuring WebLM immediately after the installation, click Finish in the Completed dialog box of the WebLM Installer. If you are configuring WebLM after the WebLM installation at a later time, change to the directory location $CSBASE/WebLM/product and execute the following command:./config.bin The system displays the Welcome dialog box for WebLM Configurator. Figure 18: Welcome dialog box for WebLM Configurator Step 2: Click Next. The system displays the WebLM Configuration Properties dialog box. Figure 19: WebLM Configuration Properties dialog box Page 24 of 59

25 Change the default values as required. In the Log File Location field, enter the path of the folder within which you want to save the WebLM log file. In the Log File Maximum Backup Index field, enter the number of WebLM log files that can be created. You can enter any number within the range of 1 through 5. In the Log File Maximum File Size (in MB) field, enter the maximum file size of the WebLM log file. You can enter any number within the range of 1 through 10. In the License Allocation Backup File Size (in MB) field, enter the maximum file size of the License allocation backup file. You can enter any number within the range of 1 through 10. Step 3: Click Next. The system displays the Configuration Summary dialog box. Figure 20: Configuration Summary dialog box Page 25 of 59

26 Step 4: Click Configure. The system displays the Configuration Completed dialog box when configuration is complete. Figure 21: Configuration Completed dialog box Page 26 of 59

27 Step 5: Click on the Finish button. The system displays the Logout dialog box. Figure 22: Logout dialog box Page 27 of 59

28 Step 6: Click Finish to complete the configuration program and exit the WebLM Configurator. Please log out and log back in before proceeding further. The installation and configuration of the WebLM server on a Linux operating system is now complete. To access WebLM, see Accessing WebLM WebLM installer steps for Windows operating system in the silent mode The WebLM installer is available at the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Page 28 of 59

29 Follow the steps below to install WebLM using the installer in the silent mode. Step 1: Copy the WebLM_Install_Product.exe to a local folder on Windows machine. Follow steps 2, 3 and 4 only if there is a need to change the default values of WebLM server properties, else move to step 5. Step 2: Verify that the coreservices installation base directory exists. The %CSBASE% Environment Variable points to the coreservices installation base directory. The default value of %CSBASE% is C:\opt\coreservices which will be set by the installer. If the coreservices installation base directory does not exist, create the directory in the path specified in the Environment Variable. Note: The coreservices installation base directory must exist if you have already installed any Core Services product on your computer. Step 3: In the coreservices installation base directory i.e. %CSBASE%, create a file, current.conf. Note: If the current.conf file already exists in the coreservices installation base directory, continue with step 4. Step 4: In the current.conf file, define and set the following four variables: BACKUPFILESIZE=10 MAXBACKUPINDEX=1 MAXFILESIZE=10 WebLMLogLocation=C:\\opt\\coreservices\\tomcat-5.5.9\\webapps\\WebLM\\data\\log Note: The values of the variables mentioned here are the default values. Change the values as required. Step 5: Open command prompt and change to the directory where you have copied the WebLM installer i.e. WebLM_Install_Product.exe. Step 6: Run the WebLM installer by executing the following command: WebLM_Install_Product.exe silent Step 7: Once the installation is complete, to access WebLM, see Accessing WebLM WebLM installer steps for Linux operating system in the silent mode (Recommended for co-resident WebLM in Proactive Contact) The WebLM installer is available at the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Follow the steps below to install WebLM using the installer in the silent mode. Step 1: Copy the installer file WebLM_Install_Product.bin to a local folder on Linux machine. Step 2: Execute the following command to su to root: su - Page 29 of 59

30 Step 3: Change to the directory location where the installer is located. Assign executable permissions to the installer. Example: chmod 755 WebLM_Install_Product.bin Follow steps 4, 5, 6 and 7 only if there is a need to change the default values of WebLM server properties, else move to step 8. Step 4: Verify that the coreservices installation base directory exists. The $CSBASE Environment Variable points to the coreservices installation base directory. The default value of $CSBASE is /opt/coreservices which will be set by the installer. If the coreservices installation base directory does not exist, use the following command to create the directory: mkdir $CSBASE Note: The coreservices installation base directory must exist if you have already installed any Core Services product on your computer. Step 5: In the coreservices installation base directory, i.e. $CSBASE, create a file, current.conf. Note: If the current.conf file already exists in the coreservices installation base directory, continue with step 6. Step 6: In the current.conf file, define and set the following four variables: BACKUPFILESIZE=10 MAXBACKUPINDEX=1 MAXFILESIZE=10 WebLMLogLocation=/opt/coreservices/tomcat-5.5.9/webapps/WebLM/data/log Note: The values of the variables mentioned here are the default values. Change the values as required. Step 7: Change to the directory where you have copied the WebLM installer, WebLM_Install_Product.bin. Step 8: Run the WebLM installer by executing the following command:./weblm_install_product.bin silent Step 9: Once the installation completes, to access WebLM, see Accessing WebLM Installation Using Manual Instructions This section describes the manual steps to install WebLM server Pre-Installation steps for the Windows operating system This section will describe the set of steps that must be taken before this release is installed. 1. Install JRE 1.5.0_07 on the machine where WebLM will be deployed. Please ensure to install the correct version as per the operating system (on which WebLM will be running). 2. Install Tomcat on the machine where WebLM will be running. Please ensure to install the correct version as per the operating system (on which WebLM will be running). 3. Set the following System Environment Variables on your system: - JAVA_HOME: Ensure that this variable points to JRE 1.5.0_07 install location. - PATH: Ensure that this variable points to %JAVA_HOME%\bin. - CATALINA_HOME: Ensure that this variable points to Tomcat install location. Page 30 of 59

31 Note: If the Environment Variables do not exist on your system, do the following to create and set the variables: a. In the Desktop, right-click My Computer. The system displays the System Properties dialog box. b. In the System Properties dialog box, click the Advanced tab. c. In the Advanced tab page, click Environment Variables. The system displays the Environment Variables dialog box. d. In the Environment Variable dialog box, click New below System Variables. The system displays the New System Variable dialog box. e. Specify the required variable name in the Variable name: field. f. Specify the required directory path in the Variable value: field. g. Click OK. The system displays the new system variable in the System Variables list. h. Click OK and close the System Properties dialog box. 4. Ensure that tomcat is stopped. Note: If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat. 5. Ensure that on the machine on which WebLM will be deployed has an entry for the local host IP address in the hosts file. E.g. in case of Windows, the file is usually located under C:\WINNT\system32\drivers\etc folder by the name hosts. The entry in this file should look like: <Localhost_IP_address> localhost 6. Ensure that the user name using which tomcat is installed has read-write permissions for: C:\temp folder Pre-Installation steps for the non-windows operating system This section will describe the set of steps that must be taken before this release is installed. 1. Install JRE 1.5.0_07 on the machine where WebLM will be deployed. Please ensure to install the correct version as per the operating system (on which WebLM will be running). 2. Install the Tomcat version on the machine where WebLM will be running. 3. Set the following Environment Variables on your system in /etc/profile: - JAVA_HOME: Ensure that this variable points to JRE 1.5.0_07 install location. - PATH: Ensure that this variable points to $JAVA_HOME/bin. - CATALINA_HOME: Ensure that this variable points to Tomcat install location. Note: If the Environment Variables do not exist in /etc/profile, do the following to create and set the variables: 1. Enter the commands in /etc/profile in the following format: export <variable name>=<value to be set> where: - <variable name>: Name of the variable to be created. - <value to be set>: Value to be set to the variable. Example: export JAVA_HOME=/usr/java/jre1.5.0_07 Page 31 of 59

32 export PATH=$JAVA_HOME/bin:$PATH export CATALINA_HOME=/usr/bin/jakarta-tomcat After setting the environment variables, execute /etc/profile using the command:. /etc/profile. Note: Verify that java binary is available in your current path. You can use the "which" command to verify if java is in your search path and the java pertains to Sun s JVM and not to gcc. Following is the syntax of the "which" command: [root@pucs06 dss]# which java <installed path of the JDK>/bin/java 4. Ensure that tomcat is stopped. Note: If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat. 5. Ensure that on the machine on which WebLM will be deployed has an entry for the local host IP address in the hosts file. E.g. in case of Linux, this file is located under /etc folder by the name hosts. Entry in this file should look something like below: <Localhost_IP_address> <Machine_Name> localhost.localdomain localhost 6. Ensure that the user name using which tomcat is installed has read-write permissions for: /var/tmp folder Manual Installation Procedure for Windows operating system Step 1: Get the deliverable Get the valid version of WebLM server (WebLM.war) from the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Step 2: Copy the deliverable Copy the WebLM.war file from the location as specified above to the webapps folder of Tomcat. The folder webapps is located under %CATALINA_HOME%. %CATALINA_HOME% refers to Tomcat s installed folder (which normally ends with:..\apache Software Foundation\Tomcat 5.5 path) Step 3: Make the WebLM folder. Make an empty directory WebLM in webapps folder Step 4: Unzip the WebLM.war Open WebLM.war using WinZip and extract the contents of WebLM.war to newly created WebLM folder. Step 5: Enable HTTPS This is the mandatory step to access WebLM. This requires editing the %CATALINA_HOME%\conf\server.xml file. Follow the steps described in Enable HTTPS section below in the document. Step 6: Update WebLM server properties Page 32 of 59

33 WebLM server has default values set in the configuration file. If there is a need, update these properties before starting the tomcat. Refer section WebLM Configuration below in the document to update the properties. To access WebLM, see Accessing WebLM Manual Installation Procedure for non-windows operating system Step 1: Get the deliverable Get the valid version of WebLM server (WebLM.war) from the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Step 2: Copy the deliverable Copy the WebLM.war file from the location as specified above to the webapps folder of Tomcat. The folder webapps is located under $CATALINA_HOME. $CATALINA_HOME refers to Tomcat s installed folder (which normally ends with:../jakarta-tomcat path) Step 3: Make the WebLM folder Make an empty directory WebLM in webapps folder using command: mkdir WebLM Step 4: Unzip the WebLM.war Unzip the contents of WebLM.war into WebLM folder using command: unzip WebLM.war -d WebLM Step 5: Enable HTTPS This is the mandatory step to access WebLM. This requires editing the $CATALINA_HOME/conf/server.xml file. Follow the steps described in Enable HTTPS section below in the document. Step 6: Update WebLM server properties WebLM server has default values set in the configuration file. If there is a need, update these properties before starting the tomcat. Refer section WebLM Configuration below in the document to update the properties. To access WebLM, see Accessing WebLM Enable HTTPS To enable HTTPS, perform the following actions: 1. Locate the server.xml file normally located under the <tomcat installation directory>/conf folder. 2. Open this file using any editor (e.g. Notepad, Textpad, vi based on OS used). 3. Search for the exact (case matching and the full) text port="8443". 4. Uncomment this entire <Connector> tag. I.e. remove tag <!--" before the start of <Connector> tag and also remove tag --> after the end of <Connector> tag. 5. Change the value for attribute port from 8443 to i.e. change port= 8443 to port= Note: As per the Licensing Conformance Requirements [ M-850], licensed products shall utilize port for HTTPS communication with WebLM server. 6. At the end of <Connector> tag, sslprotocol= TLS could be seen. Add following three attributes to enable https: - keystorefile=./webapps/weblm/web-inf/weblmserver.p12 - keystoretype= PKCS12 - keystorepass= password Page 33 of 59

34 Thus, the <Connector> tag now should end with something like below : clientauth="false" sslprotocol="tls" keystorefile="./webapps/weblm/web- INF/weblmserver.p12" keystoretype="pkcs12" keystorepass="password" /> Please note that in the above step the - between WEB and INF which is separated over two lines is not a line separator. The folder name is WEB-INF. Please do not treat - as a line separator. 7. For the Connectors on port 8080 and 8009, update the value of attribute redirectport from 8443 to WebLM Configuration WebLM server configuration is defined in the file weblmserver.properties which is located in the <tomcat installation directory>/webapps/weblm/data folder. Any changes to this file will require WebLM to be restarted to have the changes effective. Some important properties defined in this file are defined in the table below. Property Name WebLM.LicenseAllocation.Backup.FileSize log4j.appender.rflogger.file log4j.appender.rflogger.maxfilesize log4j.appender.rflogger.maxbackupindex WebLM.log4j.properties.use.classpath Description This property specifies the size of the license allocation backup file size in MB. Ensure to allocate an integer to this property (e.g. 1, 10 etc.). A decimal value like 1.5 is invalid. Default value is 10 MB. This property lets WebLM user specify the location where weblmserver.log should be saved. Please ensure to enter the path that exists followed by file name i.e. weblmserver.log. Default value is weblmserver.log (it is located in $CATALINA_HOME/webapps/WebLM/data/log) E.g. On non-windows /usr/bin/weblmserver.log (assuming /usr/bin exists) On Windows: C:\\folder\\weblmserver.log (assuming C:\\folder exists) This property will set the size of the log file in which WebLM server logs the messages. Again, ensure to allocate an integer to this property (e.g. 1, 10 etc.). A decimal value like 1.5 is invalid. Default value is 10MB. This lets the WebLM admin specify the number of log files to be backed up once it reaches the max size as specified in property: log4j.appender.rflogger.maxfilesize Default value is 1. This property allows WebLM to decide where to pick up WebLM s log4j properties from. If this property is set to "Y", then WebLM will look for log4j.properties file in classpath and read WebLM's log4j properties from that file. If this property is set to "N", then WebLM will look for WebLM's log4j properties in its own weblmserver.properties file. Page 34 of 59

35 2.1.4 Installation using RPM This is applicable to Linux OS only. Also, note that this installation will not support any WebLM configuration (like updating the <tomcat installation directory>/webapps/weblm/data weblmserver.properties file) Dependencies 1) A valid JRE version needs to be installed. As per WebLM requirements, JRE 1.5.0_07 needs to be installed. 2) A valid Tomcat version needs to be installed. As per WebLM requirements, Tomcat needs to be installed Pre-requisites Some of the pre-requisites are mandatory while some are optional as specified below Mandatory 1) The user should be logged in as root user to install WebLM using rpm. 2) Ensure that an environment variable CATALINA_HOME is set pointing to Tomcat install location. 3) Ensure that an environment variable JAVA_HOME is set pointing to JRE 1.5.0_07 install location 4) Ensure that tomcat is stopped. Note: If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat Optional 1) Environment variable WEBLM_OWNER should be set to the user-name which would be the owner of WebLM.war file and WebLM directory that will be deployed in the $CATALINA_HOME/webapps directory. To set environment variable, use the following command: export WEBLM_OWNER= someuser If this environment variable is not set then the RPM will use tomcat5 as the default username. 2) Environment variable WEBLM_GROUP should be set to the group-name that WebLM.war file and WebLM directory (which will be deployed at $CATALINA_HOME/webapps) belong to. To set this environment variable, use the following command: export WEBLM_GROUP= somegroup If this environment variable is not set then the RPM will use tomcat5 as the default groupname. Page 35 of 59

36 Installation Step 1: Download the RPM file from the Avaya WebLM Research and Development Home Web page, under Proactive Contact 4.2 Step 2: Run the following command to install WebLM rpm: - rpm -i <Abstract path of the directory where local copy of RPM has been saved>/<name of the rpm file> E.g. suppose the name of the RPM is: cs-licensing i386.rpm and if it is copied/saved to directory /tmp/weblm then the command for installation should be: rpm -i /tmp/weblm/cs-licensing i386.rpm Note: If for any reason rpm fails to install then one can use RPM --force option in the command to force the installation as shown below: rpm -i --force /tmp/weblm/cs-licensing i386.rpm Step 3: Once the installation completes, to access WebLM, see Accessing WebLM Installation Verification Followings steps would help verify if WebLM is installed successfully. 1) Verify that WebLM.war file has been deployed to the $CATALINA_HOME/webapps directory with following privileges: Owner: User specified by the WEBLM_OWNER environment variable and if not, then tomcat5. Group: Group specified by the WEBLM_GROUP environment variable and if not, then tomcat5. Permissions: 644 2) Verify that WebLM.war file has been inflated to the directory $CATALINA_HOME/webapps/WebLM. The WebLM directory and its sub-directories should have the following privileges: Page 36 of 59

37 Owner: User specified by the WEBLM_OWNER environment variable and if not, then tomcat5. Group: Group specified by the WEBLM_GROUP environment variable and if not, then tomcat5. Permissions: 755 3) Verify that WebLM.war file is present in /opt/coreservices/weblm directory and has following privileges: Owner: User specified by the WEBLM_OWNER environment variable and if not, then tomcat5. Group: Group specified by the WEBLM_GROUP environment variable and if not, then tomcat5. Permissions: 644 4) Verify that the server.xml file located at $CATALINA_HOME/conf directory has the following entries: - The value of redirectport attribute within connector tag for port 8080 and 8009 is The connector tag having port attribute with value is not commented and has following three attribute entries: Attribute keystorefile keystoretype keystorepass Value./webapps/WebLM/WEB-INF/weblmserver.p12 PKCS12 password Page 37 of 59

38 5) Verify that WebLMRPMUninstall is present in /opt/coreservices/weblm/rpm/scripts directory and has execute permission Accessing WebLM After installing and configuring WebLM you can access the WebLM server. To access the WebLM server, perform the following actions: Note: To avoid conflicts in log4j jars - In case of adopting products writing their own installers or using RPMs, if WebLM is deployed in the same Tomcat container as some other CS module used by the adopting product, then there is a possibility of the log4j jar being present in two locations, i.e. in $CATALINA_HOME/shared/lib and in $CATALINA_HOME/webapps/WebLM/WEB- INF/lib folder. This can lead to conflicts between the two log4j jars leading to errors. To avoid this, if a log4j jar is present in the $CATALINA_HOME/shared/lib folder, then the log4j jar present in $CATALINA_HOME/webapps/WebLM/WEB-INF/lib must be deleted. Step 1: Start Tomcat. Ensure that tomcat is started as a service. For Windows operating system, double click on tomcat5.exe present in %CATALINA_HOME%\bin folder to start tomcat. For Linux operating system, use the following command to start tomcat: service tomcat5 start Step 2: In the Web browser, enter the URL of the WebLM server in the following format: The system displays the certificate dialog box. The dialog box informs you that the application is running over HTTPS (secured HTTP). Click Yes to accept the certificate. From this point, all the communication between the browser and the server will be over https. Step 3: On the index page, enter the username as admin. Step 4: Enter the password as weblmadmin. Since this is your first log in, you will be prompted to change the password. The system displays the Change Password page. Step 5: After changing the password, the system prompts you to log in again, with the new password. Log in to WebLM server with the new password and start using the server. Page 38 of 59

39 3 WebLM Server Uninstallation Uninstalling WebLM will result in removing all the installed licenses, the product configurations and the entire WebLM application directory itself. Please note that once WebLM is uninstalled, it will not be possible to retrieve any WebLM application product configuration or license files. Thus, one should think carefully before executing this step. The steps to uninstall a WebLM server vary depending upon whether the WebLM Installer/RPM was used to install the server or the server was manually installed. If WebLM server is installed using InstallShield, it is mandatory to uninstall WebLM using InstallShield. Similarly, if the WebLM server is installed manually, WebLM should be uninstalled manually while if WebLM is installed using rpm, then use rpm command to uninstall WebLM. Choose the appropriate uninstallation steps as mentioned below depending on the procedure used during installation of WebLM: 3.1 Uninstallation using InstallShield To uninstall on Windows, click here or to uninstall on Linux, click here Uninstallation using InstallShield (Windows) Notes: Ensure that tomcat service is stopped before going ahead with the uninstallation. If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat. Step 1: Change the directory to the product directory (e.g. %CSBASE%\WebLM\product) and double click on uninstaller.exe present in this directory. Step 2: Click on Next button. Figure 23 Page 39 of 59

40 Step 3: Select Uninstall option. Figure 24 Page 40 of 59

41 Step 4: On selecting the Uninstall option, a dialog box comes up asking you to confirm if you want to continue with the uninstallation. Click on Yes button and then click on Next button. Figure 25 Page 41 of 59

42 Step 5: Click on the Uninstall button. Figure 26 Page 42 of 59

43 Step 6: Let the uninstallation complete. Figure 27 Page 43 of 59

44 Step 7: Click on Finish button to complete the uninstallation procedure. Figure 28 Page 44 of 59

45 3.1.2 Uninstallation using InstallShield (Linux) Notes: Ensure that tomcat service is stopped before going ahead with the uninstallation. Page 45 of 59

46 If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat. Step 1: Change the directory to the product directory (E.g. $CSBASE/WebLM/product) and run the uninstaller using the command./uninstaller.bin. Step 2: Click on Next button. Figure 29 Step 3: Select Uninstall option. Figure 30 Page 46 of 59

47 Step 4: On selecting the Uninstall option, a dialog box comes up asking you to confirm if you want to continue with the uninstallation. Click on Yes button and then click on Next button. Page 47 of 59

48 Figure 31 Step 5: Click on Uninstall button. Figure 32 Page 48 of 59

49 Step 6: Let the uninstallation complete. Step 7: Click on Finish button to complete the uninstallation procedure. Page 49 of 59

50 Figure Manual Uninstallation Follow the steps below to uninstall WebLM manually for both Windows and Linux systems. Step 1: Stop Tomcat. Note: If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat. Step 2: Browse to CATALINA_HOME/webapps folder. Step 3: Delete WebLM folder recursively. Step 4: Delete the WebLM application file WebLM.war (if present). Page 50 of 59

51 3.3 Un-installation using RPM Mandatory pre-requisites 1) The user should be logged in as root user to uninstall WebLM using rpm. 2) Ensure that an environment variable CATALINA_HOME is set pointing to Tomcat install location. 3) Ensure that an environment variable JAVA_HOME is set pointing to JRE 1.5.0_07 install location. 4) Ensure that tomcat is stopped. Note: If there are other applications deployed in the same tomcat container, these applications will stop responding on stopping tomcat Un-installation To uninstall WebLM using rpm command, run command: rpm -e cs-licensing Un-installation Verification steps Following steps would help verify if WebLM is un-installed successfully. 1) Following files/directories should not be present: WebLM within $CATALINA_HOME/webapps $CATALINA_HOME/webapps/WebLM.war $CATALINA_HOME/webapps/WebLM WebLM folder within rpm /opt/coreservices/weblm If /opt/coreservices/weblm directory contains any other file(s)/folder(s) than the WebLM.war and rpm then only they will get deleted. Page 51 of 59

52 2) Verify that server.xml located at $CATALINA_HOME/conf directory does contain commented connector tag with port attribute having 8443 as value. This check will have to be done manually. First step, Browse to Tomcat s conf using command: cd $CATALINA_HOME/conf Next step, run command: more server.xml Now, verify within the output of more command that the 8443 tag is commented like below 4 WebLM upgrade Upgrading WebLM involves replacing a WebLM server release that is already installed, configured and running with a newer version of WebLM server. WebLM 4.6 supports manual upgrade only. Irrespective of whether WebLM was installed using the InstallShield wizard, manual instructions, or RPM, the steps to upgrade WebLM would need to be performed manually. The manual steps to upgrade WebLM would further vary depending upon the version of the existing WebLM server and the new WebLM release to be installed. 4.1 The steps to migrate to a new WebLM version, from WebLM 4.5.x to WebLM Restoring WebLM configuration after re-installation An assumption is made that the WebLM user has WebLM running. There is also some configuration that the user has done (for the installed product) that user would like to retain after re-installing the same version of WebLM. The set of files/folders that user might want to retain are shown in the table below. File/Folder File location Required Description Users.xml File $CATALINA_HOME/webapps/WebLM/admin Yes, if any users are added that are to be retained. Product_folder Folder This file contains the list of users. $CATALINA_HOME/webapps/WebLM/data/ Yes The product folder that contains the configuration files. Page 52 of 59

53 License file (.xml) File usagehistory.properties File weblmserver.properties File $CATALINA_HOME/webapps/WebLM/licenses Yes The installed license file. $CATALINA_HOME/webapps/WebLM/data Yes* The usage history information. $CATALINA_HOME/webapps/WebLM/data Yes, if WebLM configuration properties have been modified. The server properties file. Following are the set of generic steps one would needs to follow: 1. Before uninstalling/removing WebLM, back up the set of files as described in the table above. 2. Uninstalling WebLM requires removing the WebLM folder from $CATALINA_HOME/webapps folder (ensure that Tomcat is stopped before uninstalling). 3. Re-install the same version of WebLM. 4. This installation will result in creating a new WebLM folder in $CATALINA_HOME/webapps folder. Note: Ensure that the value of keystorepass has been updated to password in server.xml located under $CATALINA_HOME/conf folder. It is also suggested to refer the appropriate installation instructions document (as per the release being used) for any specific configuration steps/changes. 5. Before restoring the above set of files, ensure that tomcat is stopped. 6. Restore/Overwrite the above set of files in the respective file/folder location. 7. Start Tomcat & access WebLM Migration From WebLM 4.5.x to WebLM 4.6 An assumption is made that the WebLM user has WebLM 4.5.x release running. There is also some configuration that the user has done (for the installed product) that user would like to retain while moving to WebLM 4.6 release. This document also assumes that the upgrade is happening between the same type of license file (i.e. from SLF to SLF or ELF to ELF). The set of files/folders that user might want to retain are shown in the table below. File/Folder File location Required Description Users.xml File $CATALINA_HOME/webapps/WebLM/admin Yes, if any users are added that are to be retained. <Product_folder> Folder This file contains the list of users. $CATALINA_HOME/webapps/WebLM/data/ Yes The product folder that contains the configuration files. Page 53 of 59

54 License file (.xml) File usagehistory.properties File weblmserver.properties File $CATALINA_HOME/webapps/WebLM/licenses Yes The installed license file. $CATALINA_HOME/webapps/WebLM/data Yes* The usage history information. $CATALINA_HOME/webapps/WebLM/data Yes, if WebLM configuration properties have been modified. The server properties file. * Applicable only if the installed license file is of type ELF Following are the set of generic steps one would need to follow to upgrade from WebLM 4.5.x to WebLM Before uninstalling/removing WebLM 4.5.x release, back up the set of files as described in the table above. 2. To uninstall WebLM 4.5.x, refer to the Uninstallation procedure as described in Licensing Installation Instructions document available under documentation section of Proactive Contact 4.2 on the Avaya Support site. a. Please refer to the correct document based on the release of WebLM that is being uninstalled. b. Based on the method that was employed to install the WebLM 4.5.x release, refer to the appropriate uninstallation steps in the document i.e. if WebLM 4.5.x was installed using InstallShield Wizard, WebLM must be uninstalled using the InstallShield Wizard, if WebLM 4.5.x was installed using RPM, WebLM must be uninstalled using the RPM command for uninstallation, etc. 3. Install new WebLM release (4.6) as per the Licensing Installation Instructions document available under documentation section of Proactive Contact 4.2 on the Avaya Support site.this installation will result in creating a new WebLM folder in $CATALINA_HOME/webapps folder. 4. Before restoring the above set of files, ensure that tomcat is stopped. 5. Restore/Overwrite the above set of files in the respective file/folder location. 6. Start Tomcat & access WebLM. 7. This step is applicable only for Master WebLM servers. Assuming that there was an Enterprise License File (ELF) installed which has been restored along with the corresponding product folder during the upgrade to WebLM 4.6, and that there are one or more local WebLM s added, run a Validate Connectivity request for each of the added local WebLM servers. This is to ensure that the scheduled periodic operations (if any) such as periodic allocations and periodic usage query, run successfully after the upgrade. Notes: To run a Validate Connectivity request, go to Configure Local WebLMs link under the installed enterprise product. Select the added local WebLM s using checkbox and click on the Validate Connectivity button. The above step has to be performed for each added local WebLM for each installed enterprise license file. Page 54 of 59