IBM WebSphere Update Installer for WebSphere Software

Readme


Note

Before using this information, be sure to read the general information under Appendix A. Notices.

Compilation date: 02 Mar 2005
Copyright International Business Machines Corporation 2004, 2005. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents

How to send your comments
Applying service
install.txt
Location of the response file
Installing silently
Response file user entry validation
Usage notes
Example install.txt file
Uninstalling service
uninstall.txt
Location of the response file
Uninstalling silently
Response file user entry validation
Usage notes
Example uninstall.txt file
Logging
Logs created when installing service
Logs created when uninstalling service
Indicators of success
Known problems and workarounds for the update command
Known problems in Version 6.0.0.2
Workarounds
Product uninstall
Appendix A. Notices
Appendix B. Trademarks and service marks

How to send your comments

Your feedback is important in helping to provide the most accurate and highest quality information.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you.

Applying service

This topic describes how to use the IBM Update Installer for WebSphere Software to install interim fixes, fix packs, and refresh packs. The Update Installer for WebSphere Software is also known as the update installer program, the UpdateInstaller program, and the Update installation wizard.

Use the proper authorizations to successfully install product updates. Use the update installer program as a user profile with *ALLOBJ special authority.

The Update Installer wizard is an InstallShield for Multiplatforms wizard that runs in silent mode with or without a response file. When you omit the response file in silent mode, the wizard installs the last maintenance package that you downloaded to the default maintenance directory.

The following descriptions contain reference information about installing interim fixes, fix packs, and refresh packs on WebSphere Application Server products:

Overview of the installation procedure
To install an interim fix:
  1. To update an existing copy of the update installer, back up and delete the updateinstaller directory of the existing update installer before downloading the new ZIP file into the install_root directory.
  2. Download the most current version of the update installer, fix pack, or refresh pack ZIP file from the Support site into the install_root directory.
  3. Unpack the ZIP file that you downloaded to create the updateinstaller directory and several subdirectories, including the maintenance directory.
  4. Interim fix only: Download the interim fix from the Support Web site into the maintenance directory.
  5. Use the update installer to install the interim fix, fix pack, or refresh pack. The update installer creates a backup file in the install_root/properties/version/update/backup directory. IBM does not support user modifications to backup files.

Updating existing profiles in WebSphere Application Server products
The update installer updates the core product files in a WebSphere Application Server product. Service in a maintenance package might update the following files in the installation root directory:

Maintenance packages do not update existing profiles.

Viewing the fix level of the WebSphere Application Server install
You can use the versionInfo command in the install_root/bin directory to display the exact fix and version level of the product. However, do not use the versionInfo command while installing or uninstalling a maintenance package.

Updating cluster members

Apply the same maintenance packages to all of the WebSphere Application Server installations in a cluster. When all of the cluster members are not at the same service level, the following exception can occur:

DRSCacheApp   E DRSW0008E: 
   Exception is: com.ibm.disthub.impl.jms.JMSWrappedException: 
   {-1361012295|unknown|java.io.OptionalDataException|} 

This error can cause memory replication to not function properly.

Do not launch multiple copies of the Update Installer wizard at one time: Concurrent launches of the update installer program are not supported. Performing more than one update at the same time can produce unpredictable results, which might include a failed or faulty installation.

Important:
See Known problems and workarounds for the update command for information about known problems and workarounds.

The following procedure describes how to install a maintenance package. See Uninstalling service for a description of how to remove a maintenance package.

  1. Log on as a user profile with *ALLOBJ special authority.
  2. Install the product that you intend to update.

    You have very likely already installed the software that you are now updating. But if not, install the software now.

  3. Back up and delete any older copy of the update installer before downloading the current update installer. To use a newer version of the update installer, you must first remove the older version.
    1. Back up any files and subdirectories in the install_root/updateinstaller/maintenance directory, if necessary.
    2. Delete the install_root/updateinstaller/maintenance directory and all of its subdirectories.
  4. Refresh packs and fix packs only: Download the fix pack or refresh pack ZIP file from the Support site into the installation root directory.

    The zip file for a refresh pack or fix pack contains the update installer and the the maintenance package.

    For example, download the refresh pack or fix pack to one of the following directories in a Version 6 environment:

  5. Interim fixes only: Download the update installer from the Support site into the installation root directory.

    For example, download the Update Installer to one of the following directories in a Version 6 environment:

  6. Unpack the ZIP file.

    Use the jar command from Qshell to extract the contents of the ZIP file as follows:

    1. STRQSH
    2. cd /QIBM/ProdData/WebSphere/AppServer/V6/edition
      where edition is Base or ND depending on the product installed.
    3. jar -xf filename.zip

    You may also use WinZip or some other zip utility to unpack the ZIP file to your iSeries server from a mapped driver.

  7. Unpacking the ZIP file creates the following directory structure:
    install_root
       /updateinstaller
          /framework
          /lib
          /maintenance
          /responsefiles

    Version information is stored in the version.txt file in the updateinstaller directory.

    Always download and use the latest version of the Update Installer wizard when installing an interim fix.

  8. Interim fixes only: Download the maintenance package *.pak file from the Support Web site into the install_root/updateinstaller/maintenance directory.
    Tip:
    Do not attempt to unzip or unpack the *.pak file.
  9. Stop all processes that use the WebSphere Application Server product.

    Before installing or uninstalling interim fixes, fix packs, and refresh packs on a machine, stop all Java processes on the machine that use the WebSphere Application Server product.

    WebSphere Application Server processes include:

    See the following documentation for more information, Stop the WebSphere Application Server environment.

  10. Verify that the following prerequisite conditions are met:
  11. Use the update installer to install the maintenance package.

    Install the maintenance package on the deployment manager node before installing the maintenance package on each application server node that you intend to update.

    Issue one of the following commands to use the silent interface:

    Table 3. Update installer commands for installing in silent mode
    Command example Type of installation Description
    update Silent mode Installs the maintenance package with the most recent time stamp to update the software that is installed in the parent directory.
    update -W prereqsfailedpanelInstallWizardBean.active= "false" Silent mode that bypasses prerequisites checking Installs the maintenance package with the most recent time stamp to update the software that is installed in the parent directory. Bypasses prerequisites checking.
    update -W maintenance.package="install_root/updateinstaller/maintenance/PQ20029.pak" Silent mode By default, the wizard installs the maintenance package with the most recent date stamp and time stamp.

    Use the package override to install another maintenance package. You do not need a response file. The default software is the software installed in the parent directory.

    update -options "responsefiles/file_name" Silent mode with an options file Overrides all default values with values that you specified in the options response file.

    If you omit either value from the response file, the default maintenance package is the one with the most recent date stamp and time stamp. The default software is the software installed in the parent directory.

    update -W product.location="install_root" Silent mode Updates the WebSphere software specified in the command with the maintenance package that has the most recent date stamp and time stamp. The silent installation does not refer to a response file.
    update
    -W product.location="install_root" -W maintenance.package="install_root/updateinstaller/maintenance/PQ20029.pak"
    Silent mode Updates the WebSphere software specified in the command with the maintenance package specified in the command. The silent installation does not refer to a response file.

This procedure results in installing maintenance packages to update WebSphere software.

After installing a maintenance package, continue to use your WebSphere software.

install.txt

This topic describes the response file for installing service using the Update Installer for WebSphere Software.

Install an update silently using the options response file.

The install.txt file has one directive that identifies the backup file for installing a service update. Comments in the file describe how to set the string value.

The following command uses a copy of the options file named myresponsefile.txt for a silent installation:

./update -options "responsefiles/myresponsefile.txt"

Location of the response file

The sample options response file is named install.txt. The file is in the install_root/updateinstaller/responsefiles directory after you unzip the Update Installer for WebSphere Software into the installation root directory of the WebSphere software product.

Installing silently

The options file supplies the values to the Update installer wizard when installing silently. The following command uses a copy of the options file named myresponsefile.txt for a silent installation:

update -options "myresponsefile.txt"

Response file user entry validation

In a silent installation, response file validation is coded into the installation. If the validation does not pass, the failure is recorded in the log files in the install_root/logs/update/tmp directory.

Location of the maintenance package to be installed
Default directive setting
-W maintenance.package=""
Valid setting
You can set this directive to the location of the PAK file. For example,
/QIBM/ProdData/WebSphere/AppServer/V6/Base/updateinstaller/maintenance/PQ20029.pak
Error identifiers:
  • Maintenance package maintenance_package_name is already installed on the system.
  • Selected product is not supported.
  • Configuration failed. The config action that failed was: configuration_action.
  • Install the following prerequisite APARs before installing the current maintenance to the target product: list_ of_ prerequisite_ maintenance_ packages_ to_ install
  • Install the following prerequisite maintenance packages before installing the package you are currently attempting to install: list_ of_ prerequisite_ maintenance_ packages_ to_ install
  • Uninstall the following APARs before applying the current maintenance to the target product: list_ of_ prerequisite_ maintenance_ packages_ to_ uninstall
  • Uninstall the following maintenance packages before applying the current maintenance to the target product: list_ of_ prerequisite_ maintenance_ packages_ to_ uninstall
  • Unable to locate the correct version of the_update_installer. Looking for version version_identifier.
  • Maintenance_package is not a valid maintenance package.
Alternate product location

Although applying maintenance to another product is possible, always use the Update installer wizard within the directory structure of the product that you are updating. Do not use this directive unless absolutely necessary.

Default directive setting
-W product.location=""
Valid setting
You can set this directive to the installation root directory of the alternate product. For example,
/QIBM/ProdData/WebSphere/AppServer/V6/ND
Error identifiers:
  • Maintenance package maintenance_package_name is already installed on the system.
  • Selected product is not supported.
  • Configuration failed. The config action that failed was: configuration_action.
  • Install the following prerequisite APARs before installing the current maintenance to the target product: list_ of_ prerequisite_ maintenance_ packages_ to_ install
  • Install the following prerequisite maintenance packages before installing the package you are currently attempting to install: list_ of_ prerequisite_ maintenance_ packages_ to_ install
  • Uninstall the following APARs before applying the current maintenance to the target product: list_ of_ prerequisite_ maintenance_ packages_ to_ uninstall
  • Uninstall the following maintenance packages before applying the current maintenance to the target product: list_ of_ prerequisite_ maintenance_ packages_ to_ uninstall
  • Unable to locate the correct version of the_update_installer. Looking for version version_identifier.
  • Maintenance_package is not a valid maintenance package.
  • Alternate_product_directory could not be validated as an existing directory.

Usage notes

Example install.txt file

Edit the version of the file that is included in the Update Installer for WebSphere Software ZIP file. The following example is not guaranteed to be an accurate representation of the actual file.

################################################################################
#
# This is the silent install response file for installing maintenance packages
# using the update installer.
# 
# A common use of an options file is to run the wizard in silent mode. This lets
# the options file author specify wizard settings without having to run the
# wizard in graphical or console mode. To use this options file for silent mode
# execution, *uncomment* and modify the parameters defined within.
#
# Use the following command line when running the wizard from the update 
# installer directory:
# 
#    update -options responsefiles/install.txt -silent
#
################################################################################


################################################################################
#
# Used to input the maintenance package full filename specification to be installed. 
# Edit as appropriate.
#
# ie. -W maintenance.package="C:\Program Files\WebSphere\AppServer\
#          updateinstaller\maintenance\PQ20029.pak"
#
# Note: If no package is specified, a default of the last downloaded maintenance 
# package will be used (based on timestamp).
#
#-W maintenance.package=


################################################################################
#
# Used to modify the product install location that will be updated. 
# This value should be left commented out if the Update Installer is 
# being run from the recommended location
#
# ie. -W product.location="C:\Program Files\WebSphere\AppServer"
#
# Note: If no location is specified, the parent directory to update installer 
# will be used as default
#
#-W product.location=""



################################################################################
#
# Do not edit these values.
#
#
-W update.type="install"

Uninstalling service

This topic describes how to use the Update Installer for WebSphere Software to uninstall interim fixes, fix packs, and refresh packs. The Update Installer for WebSphere Software is also known as the update installer program, the updateInstaller program, and the Update installation wizard.

Use the proper authorizations to successfully uninstall product updates. Use the update installer program as a user profile with *ALLOBJ special authority.

The Update Installer wizard is an InstallShield for Multiplatforms wizard that runs in silent mode with or without a response file.

Important:
See Known problems and workarounds for the update command for information about known problems and workarounds.

The following descriptions contain reference information about uninstalling interim fixes, fix packs, and refresh packs on WebSphere Application Server products:

Overview of the uninstall procedure
To uninstall a maintenance package:
  1. Use the update installer to install the maintenance package, which creates a backup file in the install_root/properties/version/update/backup directory. IBM does not support user modifications to backup files.
  2. Use the update installer program to remove the maintenance package as described in this topic.

Viewing the fix level of the node
You can use the versionInfo command in the install_root/bin directory to display the exact fix and version level of the product. However, do not use the versionInfo command while installing or uninstalling a maintenance package.

Do not launch multiple copies of the Update Installer wizard at one time: Concurrent launches of the update installer program are not supported. Performing more than one update at the same time can produce unpredictable results, which might include a failed or faulty installation.

The following procedure describes how to uninstall a maintenance package.

  1. Log on as a user profile with *ALLOBJ special authority.
  2. Change directories to the updateinstaller directory in the installation root directory.

    For example, change directories to one of the following directories in a Version 6 environment:

  3. Stop all processes that use the WebSphere Application Server product.

    Before installing or uninstalling interim fixes, fix packs, and refresh packs on a machine, stop all Java processes on the machine that use the WebSphere Application Server product.

    WebSphere Application Server processes include:

    See the following documentation for more information, Stop the WebSphere Application Server environment.

  4. Verify that the following prerequisite conditions are met:
  5. Use the update installer to uninstall the maintenance package.

    Uninstall the interim fix on each application server node in a cell before uninstalling the maintenance package from the deployment manager node.

    Issue one of the following commands to use the silent interface:

    Table 6. Update installer commands for installing in silent mode
    Command example Type of installation Description
    update -W update.type="uninstall" Silent mode Uninstalls the maintenance package with the most recent date stamp and time stamp to update the software that is installed in the parent directory.
    update -W product.location="/QIBM/ProdData/WebSphere/AppServer/V6/Base" -W update.type="uninstall" Silent mode Overrides the default location of the WebSphere software to update. The default maintenance package to uninstall is the most recently installed maintenance package for that software.
    update -W backup.package="PQ20029.pak" -W update.type="uninstall" Silent mode Overrides the interim fix field with the name of the maintenance package to uninstall.
    update -W product.location="/QIBM/ProdData/WebSphere/AppServer/V6/ND" -W backup.package="PQ20029.pak" -W update.type="uninstall" Silent mode Overrides the location of the WebSphere software to update and the name of the maintenance package to uninstall.
    update -options "responsefiles/file_name" Silent mode with an options file Overrides all default values with values that you specified in the options response file.

    If you omit either value from the response file, the default maintenance package is the installed package with the most recent date stamp and time stamp. The default software is the software installed in the parent directory.

This procedure results in uninstalling maintenance packages to update WebSphere software.

After uninstalling maintenance packages, you can continue to use the WebSphere software.

uninstall.txt

This topic describes the response file for uninstalling service using the Update Installer for WebSphere Software.

Uninstall an update silently using the options response file.

The uninstall.txt file has one directive that identifies the backup file for uninstalling a service update. Comments in the file describe how to set the string value.

The following command uses a copy of the options file named myresponsefile.txt for a silent uninstall:

./update -options "responsefiles/myresponsefile.txt"

Location of the response file

The sample options response file is named uninstall.txt. The file is in the install_root/updateinstaller/responsefiles directory after you unzip the Update Installer for WebSphere Software into the installation root directory of the WebSphere software product.

Uninstalling silently

The options file supplies the values to the Update installer wizard when uninstalling silently. The following command uses a copy of the options file named myresponsefile.txt for a silent uninstall:

update -options "myresponsefile.txt"

Response file user entry validation

In a silent uninstall, response file validation has been coded into the installation. If the validation does not pass, the failure is recorded in the log files in the install_root/logs/update/tmp directory.

Location of the maintenance package to be uninstalled
Default directive setting
-W backup.package=""
Valid setting
You can set this directive to the location of the backup file. The backup file reverses the application of the maintenance. For example,
install_root/properties/version/update/backup/maintenance_package_to_uninstall
Error identifiers:
  • The maintenance package cannot be uninstalled. Uninstalling the maintenance would break the following superseding maintenance packages. Uninstall the superseding maintenance packages first: list_of_superseding_maintenance_packages
  • This maintenance package cannot be uninstalled. The following maintenance packages are dependent on the package that you are attempting to uninstall: list_of_dependent_maintenance_packages
  • This maintenance package cannot be uninstalled. The following maintenance packages are dependent on the APARs you are attempting to uninstall: list_of_dependent_maintenance_packages
  • No installation backup packages are available for uninstalling maintenance.
Alternate product location

Although uninstalling maintenance from another product is possible, always use the Update installer wizard from the directory structure of the product that you are updating. Do not use this directive unless absolutely necessary.

Default directive setting
-W product.location=""""
Valid setting
You can set this directive to the installation root directory of the alternate product. For example,
/QIBM/ProdData/WebSphere/AppServer/V6/ND
Error identifiers:
  • The maintenance package cannot be uninstalled. Uninstalling the maintenance would break the following superseding maintenance packages. Uninstall the superseding maintenance packages first: list_of_superseding_maintenance_packages
  • This maintenance package cannot be uninstalled. The following maintenance packages are dependent on the package that you are attempting to uninstall: list_of_dependent_maintenance_packages
  • This maintenance package cannot be uninstalled. The following maintenance packages are dependent on the APARs you are attempting to uninstall: list_of_dependent_maintenance_packages
  • No installation backup packages are available for uninstalling maintenance.

Usage notes

Example uninstall.txt file

Edit the version of the file that is included in the Update Installer for WebSphere Software ZIP file. The following example is not guaranteed to be an accurate representation of the actual file.

################################################################################
#
# This is the silent install response file for uninstalling maintenance packages
# using the update installer.
# 
# A common use of an options file is to run the wizard in silent mode. This lets
# the options file author specify wizard settings without having to run the
# wizard in graphical or console mode. To use this options file for silent mode
# execution, *uncomment* and modify the parameters defined within.
#
# Use the following command line when running the wizard from the update 
# installer directory:
# 
#    update -options responsefiles/uninstall.txt -silent
#
################################################################################


################################################################################
#
# Used to input the maintenance backup package filename to be uninstalled. 
# This is the same filename as the package that was originally installed.
# A maintenance package can only be uninstalled if a backup package exists.
#
# ie. -W backup.package="PQ20029.pak"
#
# Note: If no package is specified, a default of the last installed maintenance 
# package will be used.
#
#-W backup.package=""


################################################################################
#
# Used to modify the product install location that will be updated. 
# This value should be left commented out if the Update Installer is 
# being run from the recommended location
#
# ie. -W product.location="C:\Program Files\WebSphere\AppServer"
#
# Note: If no location is specified, the parent directory to update installer 
# will be used as default
#
#-W product.location=""



################################################################################
#
# Do not edit these values.
#
-W update.type="uninstall"

Logging

The following sections describe logging that occurs when installing and uninstalling service.

Logs created when installing service

If no installation log file exists, refer to the temporary log file in the install_root/logs/update/tmp directory. If all validations pass, the installation occurs.

Then the update installer program creates the install_root/logs/update/maintenance_package.install directory.

Within the directory are the updatelog.txt file, the compressed updatetrace.log.gz file, and the compressed updateconfig.log.gz file. The updateconfig.log.gz file exists only when the installation of service uses the internal configuration manager utility to run ANT scripts.

Logs created when uninstalling service

If no log file exists after uninstalling an interim fix, refer to the temporary log file in the install_root/logs/update/tmp directory. If all validations pass, the uninstall procedure occurs.

Then the update installer program creates the install_root/logs/update/maintenance_package.uninstall directory.

Within the directory are the updatelog.txt file, the compressed updatetrace.log.gz file, and the compressed updateconfig.log.gz file. The updateconfig.log.gz file exists only when the removal of service uses the internal configuration manager utility to run ANT scripts.

Indicators of success

The log file includes an indicator of success:

INSTCONFSUCCESS
The current operation was successful. You do not need to review the log file any further.
INSTCONFPARTIALSUCCESS
The current operation was partially successful. System should still be in a usable state, however some non-critical actions have failed. Consult the log file to determine what has failed and how to recover from the failure, if possible.
INSTCONFFAILED
The current operation failed. The system is no longer in a usable state. Consult the log file for more information.

Known problems and workarounds for the update command

This topic describes known problems and issues associated with the Update Installer for WebSphere Software program.

The update installer program version information is stored in the version.txt file in the updateinstaller directory.

A new version might ship to correspond to any new fix. Information in the version.txt file is recorded in the updatelog.txt file.

Always download and use the latest version of the Update installer wizard when installing an interim fix.

Known problems in Version 6.0.0.2

The following table describes known problems and when the problems were resolved. See the Workarounds section that follows the table for more information.

Table 11.
Description of problem Workaround Version with resolution
Product uninstall does not remove the updated product correctly. Product uninstall Current problem

Workarounds

The following section describes workarounds for current problems.

Product uninstall

Problem: The product uninstaller for Version 6.0.x.x cannot delete all files and directories that exist after installing a refresh pack or a fix pack.

Description: If you apply a refresh pack or a fix pack using the update installer program and then uninstall the whole product using the Version 6.0.0.0 product uninstaller program, many files are left on the system.

Cause: The product uninstaller program will be fixed in a later release.

Customer action: Two workarounds exist. Use either of the following workarounds to circumvent the problem:

Appendix A. Notices

References in this publication to IBM products, programs, or services do not imply that IBM intends to make these available in all countries in which IBM operates. Any reference to an IBM product, program, or service is not intended to state or imply that only IBM's product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any of IBM's intellectual property rights may be used instead of the IBM product, program, or service. Evaluation and verification of operation in conjunction with other products, except those expressly designated by IBM, is the user's responsibility.

IBM may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:

    IBM Director of Licensing
    IBM Corporation
    500 Columbus Avenue
    Thornwood, New York  10594 USA

Appendix B. Trademarks and service marks

For trademark attribution, visit the IBM Terms of Use Web site (http://www.ibm.com/legal/us/).