IBM Support

Install and Manage WebSphere Application Server with IBM Installation Manager on IBM i

News


Abstract

Install and Manage WebSphere Application Server with IBM Installation Manager on IBM i

Content

You are in: IBM i Technology Updates  > Web Integration on i News of Web Integration on IBM i > Install and Manage WebSphere Application Server with IBM Installation Manager on IBM i

This article introduces IBM Installation Manager tool and how to use the tool to install and manage the WebSphere Application Server on IBM i platform. From version 8.0, WebSphere Application Server adopt IBM Installation Manager for installing. The latest version of the WebSphere Application Server product is V9.0.

Overview of IBM Installation Manager
IBM Installation Manager (For short: IM) is a tool to install and maintain software packages which runs on a range of computer systems (eg IBM i, z/OS, Window, Linux, Unix) and is used by many products of IBM such as WebSphere and Rational. It can install, modify(add or remove feature), update, roll back, or uninstall your IBM products through command line, GUI interface, interactive console mode or a response file in XML format to direct the performance of tasks in silent mode.

The Installation Manager GUI interface is not available on IBM i platform. All interaction with Installation Manager on IBM i platform can be done through command line, console mode or response file. For the console mode, it is not supported by all products. The WebSphere Application Server on IBM i can only install and manage through command line or response file. The basic steps of WebSphere Application Server installation and management on IBM i are as the following:
image-20200117111314-1
Figure 1 Basic steps of WebSphere Application Server installation and management

Install/uninstall/update IBM Installation Manager
The Installation Manager package can be obtained from physical media or IBM Fix Central . The latest recommended version of Installation Manager is V1.9.x for the IBM i OS. For WebSphere Application Server V8.5 and WebSphere Application Server V9.0, the required minimum Installation Manager is V1.8.7.   IBM advises all IBM i clients to stay on version 1.9.x in order to upgrade to future releases of the IBM i OS.  If you upgrade to version 1.10.x, a rollback to version 1.9.x may be required.

1) Install
Extract the compressed Installation Manager install package and upload the files to a directory on IBM i system. Prompt to the directory to install the Installation Manager tool. You can install the tool in admin mode or non-admin mode.
  • Admin mode
  • ./installc –acceptLicense
  • If you’ve installed the Installation Manager in admin mode, then only user who has admin privileges: *ALLOBJ & *SECADM can use the tool.
  • Non-Admin mode
  • ./userinstc –acceptLicense
  • If you’ve installed the Installation Manager in non-admin mode, then only the initial user who installed the tool can use it.
The common directory information of Installation Manager on IBM i is shown as Table.1. Installation directory is where the Installation Manager tool is installed. Agent Data directory is used to store history, log and etc information of installed packages.

Table 1 Common directory information of Installation Manager
Admin Mode Non-Admin Mode
Installation  /QIBM/ProdData/InstallationManager /home/userProfile/IBM/InstallationManager
Agent Data /QIBM/UserData/InstallationManager   /home/userProfile/var/ibm/InstallationManager
imcl, imutilsc /QIBM/ProdData/InstallationManager /eclipse/tools /home/userProfile/IBM/InstallationManager /eclipse/tools
Uninstallc /QIBM/UserData/InstallationManager /uninstall/ /home/userProfile/var/ibm/InstallationManager /uninstall/
log /QIBM/UserData/InstallationManager /logs/ /home/userProfile/var/ibm/InstallationManager /logs/
  • 2) uninstall
  • If you want to uninstall the Installation Manager from the system, you must uninstall all packages installed by Installation Manager and then run command uninstallc under the Agent Data directory.
  • 3) Update
  • If you want to update the Installation Manager on the system to a higher version, you can download the higher version installer packages to the local system and install the Installation Manager to the high version.
  • You can also update Installation Manager from the Internet in condition your system has the Internet access with the following command:
  • ./imcl install com.ibm.cic.agent
  • Note in any case, there can be only one Installation Manager instance running. When Installation Manager is running, a .imlock file is generated under Agent Data directory.
Prepare product repositories

All product materials that will be installed with IBM Installation Manager are stored in repositories. A repository contains one or more product packages or product maintenance, such as fix pack or interim fixes. You can install the product or updates from any accessible repository which can be on local system or remote. WebSphere Application Server repository file can be with following types:
  • diskTag.inf: diskTag.inf indicates to Installation Manager that the files are from a disk image. It cannot be used from remote server which can only be accessed on local system.
  • repository.config: repository.config is obtained from the repository files. It can be accessed from both local and remote system.
  • .zip file: .zip files that contain repository.config. Files larger than 2.2GB in size must be extracted.
You can use IBM Packaging Utility tool to manage repositories and packages. This tool can be used to copy multiple packages or multiple versions of product into one repository, copy packages from disk images resides on local machine and delete packages from repository that are no longer needed. By copy multiple packages that share components into one repository it can save lots of disk space as only one copy of the shared components is kept in the repository. Repository file created by Packaging Utility is repository.config which can be used in both local and remote servers. More information can be referred from IBM Product Utility Info Center.

Prepare response file

If you are to install or manage WebSphere Application Server in silent mode, you should prepare the response file.

  • Introduction of response file

A response file is an XML file that contains data required to complete installation operations silently with Installation Manager. Following gives you a sample response file with some underlined explanations of the commands and attributes for WebSphere Application Server version 8.5 product installation from local repository on IBM i.

<?xml version='1.0' encoding='UTF-8' ?>

<!--Response attributes: The attribute default value for clean and temporary is false. When clean=’true’, it means IM only use the repository and preferences specified in the response file. Otherwise, IM uses the repository and preferences both in response file and existing set in IM. When temporary='false', the preferences that are set in your response file persist to IM set. When temporary='true', the preferences that are set in the response file do not persist. In this sample, it means for this installation we only use the repositories and preferences specified in this file and sets in this file do not persist.-->

<agent-input clean='true' temporary='true'>

<server>

<!—Specify local or remote repository files or the directory directly containing the repository files. -->

<repository location='/home/builds/was85' />

</server>

<!—Profile id is a unique name for an installation which can be identified by IM. The offering profile value in install must be the same with this profile id. The id can be used for the management of this installation.-->

<profile id='IBM WebSphere Application Server V8.5 Base' installLocation='/QIBM/ProdData/WebSphere/AppServer/V85/Base'> <!—Product install path-->

<data key='eclipseLocation' value='/QIBM/ProdData/WebSphere/AppServer/V85/Base' />

<data key='was.install.os400.profile.location' value='/QIBM/UserData/WebSphere/AppServer/V85/Base' /> <!—This data key is required for IBM i platform-->

<data key='user.import.profile' value='false' />

<data key='cic.selector.nl' value='en' /> <!—Specify the language to be installed and separate the values with commas. For example:en,zh,ja-->

</profile>

<install modify='false'>

<!—For the offering id and version info can be obtained by command: imcl listAvailablePackages -repositories /home/builds/was85 –long. The version number is optional and IM installs the latest packages for the offering id if version is not specified. Attribute installFixes is optional too and the value can be none, all or recommended. If you specify a version for the offering, the installFixes default value is none. If you do not specify a version for the offering, the default value for installFixes is all. Features can be optionally specified by a comma-delimited list. If no feature IDs are specified, the default features are installed. For WebSphere Application Server, core.feature is the default.-->

<offering id='com.ibm.websphere.BASE.v85' version=’ 8.5.0.20120501_1108’ features='core.feature,ejbdeploy,thinclient,embeddablecontainer' profile='IBM WebSphere Application Server V8.5 Base' installFixes='none' />

</install>

<!—eclipseCache is specified for the shared resources directory. This directory is created in the first package installation of IM and can’t change in later installation.>

<preference name='com.ibm.cic.common.core.preferences.eclipseCache' value=/QIBM/UserData/InstallationManager/IMShared' />

<preference name='com.ibm.cic.common.core.preferences.connectTimeout' value='30' />

<preference name='com.ibm.cic.common.core.preferences.readTimeout' value='45' />

<preference name='com.ibm.cic.common.core.preferences.downloadAutoRetryCount' value='0' />

<preference name='offering.service.repositories.areUsed' value='true' />

<preference name='com.ibm.cic.common.core.preferences.ssl.nonsecureMode' value='false' />

<preference name='com.ibm.cic.common.core.preferences.http.disablePreemptiveAuthentication' value='false' />

<preference name='http.ntlm.auth.kind' value='NTLM' />

<preference name='http.ntlm.auth.enableIntegrated.win32' value='true' />

<preference name='com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts' value='true' />

<preference name='com.ibm.cic.common.core.preferences.keepFetchedFiles' value='false' />

<preference name='PassportAdvantageIsEnabled' value='false' />

<preference name='com.ibm.cic.common.core.preferences.searchForUpdates' value='false' />

<preference name='com.ibm.cic.agent.ui.displayInternalVersion' value='false' />

<preference name='com.ibm.cic.common.sharedUI.showErrorLog' value='true' />

<preference name='com.ibm.cic.common.sharedUI.showWarningLog' value='true' />

<preference name='com.ibm.cic.common.sharedUI.showNoteLog' value='true' />

</agent-input>

For more details about the response file you can refer to Installation Manager Info Center
  • Record response file with windows Installation Manager GUI
You can manual create a response file for the installation on IBM i or modify a recorded file from GUI interface on windows platform. The Installation Manager GUI interface on windows can be used to easily record a response file by going through the wizard. By the following command Installation Manager instance is launched as Fig.2 to record the installation without installing the product.
IBMIM.exe -record response.xml(response file to be recorded) -skipInstall D:/IM_shared (Directory to write Installation Manager data)
On the launched GUI interface, you can add the repository and go through each wizard to record the corresponding response file, such as install, update, modify, roll back or uninstall.
image-20200117111330-2
Figure 2 Record response file with GUI interface on windows

Example response file recorded from windows Installation Manager :

<?xml version="1.0" encoding="UTF-8"?>

<agent-input acceptLicense='true'>

<server>

<repository location='D:\Myfile\tmp\was85'/>

</server>

<profile id='IBM WebSphere Application Server V8.5' installLocation='C:\Program Files (x86)\IBM\WebSphere\AppServer'>

<data key='eclipseLocation' value='C:\Program Files (x86)\IBM\WebSphere\AppServer'/>

<data key='user.import.profile' value='false'/>

<data key='cic.selector.os' value='win32'/>

<data key='cic.selector.ws' value='win32'/>

<data key='cic.selector.arch' value='x86'/>

<data key='cic.selector.nl' value='en'/>

</profile>

<install modify='false'>

<offering id='com.ibm.websphere.BASE.v85' version='8.5.0.20120501_1108' profile='IBM WebSphere Application Server V8.5' features='core.feature,ejbdeploy,thinclient,embeddablecontainer,liberty,com.ibm.sdk.6_64bit' installFixes='none'/>

</install>

<preference name='com.ibm.cic.common.core.preferences.eclipseCache' value='C:\Program Files (x86)\IBM\IMShared'/>

<preference name='com.ibm.cic.common.core.preferences.connectTimeout' value='30'/>

<preference name='com.ibm.cic.common.core.preferences.readTimeout' value='45'/>

<preference name='com.ibm.cic.common.core.preferences.downloadAutoRetryCount' value='0'/>

<preference name='offering.service.repositories.areUsed' value='true'/>

<preference name='com.ibm.cic.common.core.preferences.ssl.nonsecureMode' value='false'/>

<preference name='com.ibm.cic.common.core.preferences.http.disablePreemptiveAuthentication' value='false'/>

<preference name='http.ntlm.auth.kind' value='NTLM'/>

<preference name='http.ntlm.auth.enableIntegrated.win32' value='true'/>

<preference name='com.ibm.cic.common.core.preferences.preserveDownloadedArtifacts' value='true'/>

<preference name='com.ibm.cic.common.core.preferences.keepFetchedFiles' value='false'/>

<preference name='PassportAdvantageIsEnabled' value='false'/>

<preference name='com.ibm.cic.common.core.preferences.searchForUpdates' value='false'/>

<preference name='com.ibm.cic.agent.ui.displayInternalVersion' value='false'/>

<preference name='com.ibm.cic.common.sharedUI.showErrorLog' value='true'/>

<preference name='com.ibm.cic.common.sharedUI.showWarningLog' value='true'/>

<preference name='com.ibm.cic.common.sharedUI.showNoteLog' value='true'/>

</agent-input>

You need to modify some fields in the recorded response file to use it in IBM i platform.

For the directory path in the recorded example response file which is in bold, you should modify them to the path on IBM i platform. Besides, there are some data keys which are different from windows. Delete the following three data keys which are not needed on IBM i:

<data key='cic.selector.os' value='win32'/>

<data key='cic.selector.ws' value='win32'/>

<data key='cic.selector.arch' value='x86'/>

And add a new data key for IBM i platform: 

<data key='was.install.os400.profile.location' value='/QIBM/UserData/WebSphere/AppServer/V85/Base' />

For other field in the response file, you can leave what they are. 
Install the product
  • After you have installed the Installation Manager on your system and have access to the product repositories, there are two methods on IBM i to perform the actual WebSphere Application Server product installation with Installation Manager.
  • 1) Response file
  • After you have a response file, execute the command in QShell to perform the installation:
  • ./imcl -acceptLicense input /home/response.xml –log /home/install.log -keyring /home/keyring -password xx
  • Note, if the repositories you specified in the response file can be accessed without authentication, the keyring is not needed. Otherwise, you should firstly create a keyring for the installation using command:
  • ./imutilsc saveCredential –url repository_location -userName xx -userPassword
xx -keyring /home/keyring -password xx -verbose
If you have more than one repository locations needs authentication with different user and password, put the authentication info into the same keyring file by the creating keyring command.

2) Command line
  • You can install WebSphere Application Server product by adding the attributes in the IM command line. Following gives an example:
  • ./imcl install com.ibm.websphere.BASE.v85_8.5.0.20120501_1108,core.feature,samples
  • -repositories https://host/repository_location
  • -installationDirectory /QIBM/ProdData/WebSphere/AppServer/V85/Base
  • -properties was.install.os400.profile.location=/QIBM/UserData/Websphere/Appserver/V8/ Base
  • -sharedResourcesDirectory /QIBM/UserData/InstallationManager/IMShared
  • -keyring /home/keyring -password password
  • -acceptLicense
In the command line, the parameter ‘com.ibm.websphere.BASE.v85_8.5.0.20120501_1108’ is the package id_version. You can get this information with Installation Manager command ‘imcl listAvailable –repositories https://host/repository_location -long’ (For more detailed information of Installation Manager command, please refer Installation Manager useful commands). The version is optional. When version is not set, Installation Manager will install the latest version and all interim fixes are installed together in default. If version is set, Installation Manager will install the specified version and no interim fix is installed in default. By ‘-installFixes’ parameter, you can directly set the interim fixes installation with value all, none or recommended.

The parameter ‘core.feature’ is the default feature of WebSphere Application Server. For other optional features, separate them by commas. For WebSphere Application Server V8.0, the optional features are such as ejbdeploy, thinclient, embeddablecontainer, samples. For V8.5, an additional feature liberty is added.

For WebSphere Application Server product install with response file or command line, you can get more info from WAS information center.

Manage the product
Besides the product installation, you can also use IM to update, modify, uninstall or roll back the product. Following introduces you the useful Installation Manager commands to manage WebSphere Application Server and the detail management operations.
  • Installation Manager useful commands
Following shows you the useful command of Installation Manager to manage the product. You can also read the file /QIBM/UserData/InstallationManager/installed.xml to get the installed packages information.

1. View installed packages and features
  • ./imcl listInstalledPackages -features –long
  • What you get from the command is in format: install_location: packageID_version: display_name: display_version: featureId_a,featureId_b,featureId_c as shown in Fig.3.
  • image-20200117111343-3
  • Figure 3 View installed packages and features
  • For WebSphere Application Server, the installed packages may contain product and interim fixes. From above figure, you can see that a WebSphere Application Server V8.0.0.3 ND is installed under directory /QIBM/ProdData/WebSphere/AppServer/V8/ND and an interim fix ‘8.0.0.3-WS-WAS-TFPM59935’ is installed on it.
2. View installation directories, shared resources directory, package id and translations.
  • ./imcl listInstallationDirectories –long
  • What you get from the command is in format as shown in Fig.4:
  • * : shared_resources_directory
  • installation_directory : package_id : installed_translations
  • image-20200117111351-4
  • Figure 4 View installation directories
  • This listInstallationDirectories command is supported from Installation Manager V1.4.4.
3. View available packages, features in repositories
  • ./imcl listAvailablePackages -repositories repository_locations –features –long
  • If you are using a remote repository which needs authentication to access, add the keyring in the end of the command. repository_locations are separated with commas. What you get from the command is in format as shown in Fig.5:
  • repository_location: packageID_version: display_name: display_version: featureId_a,featureId_b,featureId_c
  • image-20200117111359-5
  • Figure 5 View available packages, features
  • Before you install the package, you can use this command to find the package id, version and features information.
4. View available fixes in repositories
  • ./imcl listAvailableFixes packageID_version –repositories repository_locations -long
  • In this command, the packageID_version is must be provide as the fixes is only available for specified level. What you get from the command is in format as shown in Fig.6:
  • repository_path: fixName_version: recommended=[true|false]
  • image-20200117111407-6
  • Figure 6 View available fixes
  • Update
For an installed WebSphere Application Server product, you can install fix pack to update the product to a new level or install interim fixes to fix specific known problems of the product.

Install interim fix with following command:
  • ./imcl install fixName_version
  • -installationDirectory product_installation_location
  • -repositories repository_URL
  • -keyring keyring_file
  • -password xx
For the fixName_version you can get it from the listAvailableFixes command.

The fix pack installation is similar to the product just fix pack is installed to update an existing installation.
  • Modify
You can use following command to modify the features of a WebSphere Application Server product:
  • ./imcl modify com.ibm.websphere.EXPRESS.v80
  • -installationDirectory product_installation_location
  • -addFeatures samples
  • -removeFeatures thinclient,ejbdeploy,embeddablecontainer
  • -repositories repository_URL
  • -installationDirectory product_installation_location
  • -keyring keyring_file
  • -password xx
  • Uninstall
You can uninstall the interim fixes on the WebSphere Application Server installation or uninstall the whole installation from the system.

Uninstall interim fixes:
  • ./imcl uninstall fixName_version
-installationDirectory product_installation_location
Uninstall installation:

After the WebSphere Application Server installation is installed on the system, there generates a uninstall.xml file in product_installation_location/uninstall directory. You can use the uninstall.xml file to perform the product un-installation:
./imcl input product_installation_location /uninstall /uninstall.xml
You can also create a response file to do the un-installation.
  • Roll back
If you have installed fix pack to update a WebSphere Application Server product, you can roll back the installation to history version with following command line.

Rollback with command line:
  • ./ imcl rollback com.ibm.websphere.Express.v80_8.0.0.20101025_2108 -installationDirectory /QIBM/ProdData/WebSphere/AppServer/V8/Express -acceptLicense
If version (8.0.0.20101025_2108) is not specified, the installation rolls back to the previously installed version. Otherwise, the installation rolls back to the specified earlier version of the offering.

Summary
In above, this article has introduced you the WebSphere Application Server product installation and management with Installation Manager on IBM i platform. For more information about IM, you can refer to the IBM Installation Manager Knowledge Center. For more info about WebSphere Application Server, you can refer to the WebSphere Application Server Knowledge Center.

[{"Business Unit":{"code":"BU070","label":"IBM Infrastructure"},"Product":{"code":"SWG60","label":"IBM i"},"Component":"","Platform":[{"code":"PF012","label":"IBM i"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB68","label":"Power HW"}}]

Document Information

Modified date:
06 February 2025

UID

ibm11170376