[Version 5.0.2]The patch command

The patch command is the command-line interface to the IBM WebSphere Application Server patcher application.

The patcher utility corrects faulty history information that can occur when installing V5.0.0 Enterprise product features after installing interim fixes and fix packs. Installing features for other WebSphere Application Server products does not cause a problem.

Installing V5.0.0 Enterprise features can cause related components to regress. The patcher determines regressed components and corrects their history information.

You can prevent component regression when installing V5.0.0 Enterprise features as described in Warning: no string named [rins_installee50] found.. The patcher utility is a work-around for the scenario where you install a V5.0.0 feature without using the InstallEE50 command.

There are three known scenarios for the regression problem:

Scenario 1 - Installing features after installing Fix Pack 1

  1. Install the base WebSphere Application Server product, V5.0.0.
  2. Install the Enterprise product, V5.0.0.
  3. Install Fix Pack 1 to bring the base WebSphere Application Server product to V5.0.1.
  4. Install Fix Pack 1 to bring the Enterprise product to V5.0.1.
  5. Use the Enterprise product V5.0.0 CD-ROM to install an additional feature.

To correct scenario 1:

  1. List regressed components on a Linux or UNIX-based platform, for example:
    ./patch.sh install_root -disableFixPack was50_fp1_platform
    
  2. Repair regressed components on a Linux or UNIX-based platform, for example:
    ./patch.sh install_root -apply -disableFixPack was50_fp1_platform
    
  3. Optionally, use the InstallEE50 command to install additional V5.0.0 features that you require.
  4. Reapply Fix Pack 1 for the Enterprise product.

Scenario 2 - Installing features after installing Fix Pack 1 and Fix Pack 2

  1. Install the base WebSphere Application Server product, V5.0.0.
  2. Install the Enterprise product, V5.0.0.
  3. Install Fix Pack 1 to bring the base WebSphere Application Server product to V5.0.1.
  4. Install Fix Pack 1 to bring the Enterprise product to V5.0.1.
  5. Install Fix Pack 2 to bring the base WebSphere Application Server product to V5.0.2.
  6. Install Fix Pack 2 to bring the Enterprise product to V5.0.2.
  7. Use the Enterprise product V5.0.0 CD-ROM to install an additional feature.

Scenario 3 - Installing features after installing Fix Pack 2 only

  1. Install the base WebSphere Application Server product, V5.0.0.
  2. Install the Enterprise product, V5.0.0.
  3. Install Fix Pack 2 to bring the base WebSphere Application Server product to V5.0.2.
  4. Install Fix Pack 2 to bring the Enterprise product to V5.0.2.
  5. Use the Enterprise product V5.0.0 CD-ROM to install an additional feature.

To correct either scenario 2 or scenario 3:

  1. List regressed components on a Linux or UNIX-based platform, for example:
    patch.sh install_root
         -disableFixPack was50_fp1_platform
         -disableFixPack was50_fp2_platform
    
  2. Repair regressed components on a Linux or UNIX-based platform, for example:
    patch.sh install_root
         -apply
         -disableFixPack was50_fp1_platform
         -disableFixPack was50_fp2_platform
    
  3. Optionally, use the InstallEE50 command to install additional features that you require.
  4. Reapply Fix Pack 2 for the Enterprise product.

The platform placeholder in the fix pack name represents the target installation platform:

win
Windows platforms
aix
AIX platforms
sun
Solaris Operating Environment platforms
hpux
HP-UX platforms
linux
Linux platforms
linux390
Linux for S/390 platforms

For example, on a Linux or UNIX-based platform:

./patch.sh /opt/WebSphere/AppServer
     -apply
     -disableFixPack was50_fp1_sun
     -disableFixPack was50_fp2_sun

On a Windows platform:

patch.bat "c:/Program Files/WebSphere/AppServer"
     -apply
     -disableFixPack was50_fp1_win
     -disableFixPack was50_fp2_win

Stop all Java processes on the machine that use the IBM Developer Kit that WebSphere Application Server provides: Before using the patcher, stop all Java processes on the machine that use the IBM Developer Kit that WebSphere Application Server provides to support the Java 2 SDK on your operating system platform, such as the IBM Developer Kit for AIX, Java Technology Edition. Stop all application server processes, the nodeagent process, the deployment manager process, and all server processes, such as the jmsserver process. Features with server processes include the IBM HTTP Server and the embedded messaging feature. Stop all Java processes, if necessary. If you use the patcher while a WebSphere Application Server-related Java process runs, IBM does not guarantee that the product can continue to run successfully or without error.

Remove the WebSphere MQ tray icon if present On a Windows platform, remove the WebSphere MQ tray icon if it is present. The WebSphere MQ tray icon in the lower right corner indicates that a WebSphere MQ process (amqmtbrn.exe) is running. Right click the tray icon and click Hide to remove it.

Do not launch multiple copies of the patcher at one time The patcher cannot be launched concurrently with itself. Performing more than one update at the same time can lead to a failed or faulty installation.

Installation roots
The variable install_root represents the root directory for WebSphere Application Server. By default, this varies per product and operating system:

  • Base WebSphere Application Server product:
    • AIX platforms: /usr/WebSphere/AppServer
    • Other UNIX and Linux platforms: /opt/WebSphere/AppServer
    • Windows platforms: drive\Program Files\WebSphere\AppServer
  • Network Deployment product:
    • AIX platforms: /usr/WebSphere/DeploymentManager
    • Other UNIX and Linux platforms: /opt/WebSphere/DeploymentManager
    • Windows platforms: drive\Program Files\WebSphere\DeploymentManager
  • Enterprise product that extends the base product:
    • AIX platforms: /usr/WebSphere/AppServer
    • Other UNIX and Linux platforms: /opt/WebSphere/AppServer
    • Windows platforms: drive\Program Files\WebSphere\AppServer
  • Enterprise product that extends the Network Deployment product
    • AIX platforms: /usr/WebSphere/DeploymentManager
    • Other UNIX and Linux platforms: /opt/WebSphere/DeploymentManager
    • Windows platforms: drive\Program Files\WebSphere\DeploymentManager

Command name
patch.sh and patch.bat, command-line interfaces to the patcher.jar file.
Prerequisite environment settings

The JAVA_HOME environment setting. Set the environment variable or issue the appropriate command script, from the install_root/bin directory of the installation root:

Windows systems:

  1. Open a command prompt window.
  2. Change directories to the install_root\bin directory.
  3. Issue the setupCmdLine.bat command or the setupClient.bat command.
  4. Use the same command prompt window to start the update installer, as described in the appropriate procedure.

Linux and UNIX systems:

  1. Open a command shell window.
  2. Change directories to the /install_root/bin directory.
  3. Issue the . ./setupCmdLine.sh command or the . ./setupClient.sh command. Notice the space between the periods. The special format for this command sources the command to make the setting active for all processes started from the command shell.
  4. Use the same command shell window to start the update installer, as described in the appropriate procedure.

Source location for downloading
Download the patcher as part of the updateInstaller.zip from the WebSphere Application Server Support page, or as part of each fix pack ZIP file package.
Target location for downloading
The default location for unpacking the patcher is the install_root/update directory.

Copy the files into the directory containing V5.0.2.x of the update installer program (also known as the updateInstaller program or the update installation wizard). The installer.jar JAR file is required.

Files in the patcher utility
The patcher utility is packaged as the following files:
  • patcher.jar
  • patch.bat
  • patch.sh
  • patch.txt (similar to this description)

Syntax and parameters

Linux and UNIX-based platforms

patch.sh [ install_root ]
      [ -apply       ]
      [ -verbose     ]
      [ -usage       ]
      [ -help        ]
      [ -revision    ]

      [ -custom propertyFileName  ]

      [ -disableComponents                ]
      [ -enableComponent componentName  ]
      [ -enableComponents                 ]
      [ -disableComponent componentName ]

      [ -disableFixes               ]
      [ -enableFix fixId          ]
      [ -disableFix fixId         ]

      [ -disableFixPacks            ]
      [ -enableFixPack fixPackId  ]
      [ -disableFixPack fixPackId ]

Windows platforms

patch.bat [ install_root ]
      [ -apply       ]
      [ -verbose     ]
      [ -usage       ]
      [ -help        ]
      [ -revision    ]

      [ -custom propertyFileName  ]

      [ -disableComponents                ]
      [ -enableComponent componentName  ]
      [ -enableComponents                 ]
      [ -disableComponent componentName ]

      [ -disableFixes               ]
      [ -enableFix fixId          ]
      [ -disableFix fixId         ]

      [ -disableFixPacks            ]
      [ -enableFixPack fixPackId  ]
      [ -disableFixPack fixPackId ]

Typically, the patcher utility is invoked once without the -apply argument to display regressions, then, if needed, invoked a second time with -apply to perform corrections on history information.

The patcher utility scans the target installation directories to verify the installation, then scans installed components and installed updates (fix packs and interim fixes) for regressions. An update is regressed when the component build date is earlier than the update build date.

Parameters

Use the following parameters for the patch command:

install_root
The Enterprise product installation root directory.
-apply
Removes all regressed component updates and updates the update history (event.history). If the patcher removes all component updates of an interim fix or fix pack, the utility also removes the interim fix or fix pack.
-verbose
Provides verbose output.
-usage
Displays usage information and then exits.
-help
Displays help information and then exits.
-revision
Displays revision history and then exits.
-custom <propertyFileName>
Specifies a properties file containing customization directives. You can also specify customizations on the command line.

Specify -custom to use a properties file to force on or off component regressions and to skip particular updates, regardless of actual detected regressions.

The properties file supports these properties:

    enableComponents=true
    componentName=disable
    disableComponents=true
    componentName=enable

    disableFixes=true
    fixId=enableFix
    fixId=disableFix

    disableFixPacks=true
    fixPackId=enableFixPack
    fixPackId=disableFixPack
    

-disableComponents
Specifies component customizations.
-enableComponents
Specifies component customizations.
<componentName>= disable|enable
Specifies component customizations.

Using the patcher to update components

Use the patcher to enable or disable single components, or all components.

To enable all components but disable those components you specify, use these parameters:

enableComponents=true and componentName=disable

To disable all components but enable those components you specify, use these parameters:

-disableComponents=true and componentName=enable

If you use the disableComponents parameter, you must specify some enablement. Disabling all components halts all processing, and returns a success return code (0).

Specifying both enableComponents and disableComponents produces an error.

-disableFixes
Disables all interim fixes.
<fixId>=disableFix|enableFix
Specifies customizations to single interim fixes.

Updates for fix packs and interim fixes

You can disable single interim fixes or all interim fixes. You can enable single interim fixes.

-disableFixPacks
Disables all fix packs.
<fixPackId>=disableFixPack|enableFixPack
Specifies customizations to single fix packs.

Updates for fix packs

You can disable single fix packs or all fix packs. You can enable single fix packs.

Return codes

Patcher return codes are:

0
SUCCESS
-1
PARSE_ERROR
-2
BAD_CUSTOM
-3
BAD_TARGET
-4
RUN_ERROR


Related tasks
Installing interim fixes, cumulative fixes, and fix packs
Related reference
Warning: no string named [rins_installee50] found.



Searchable topic ID:   rins_patch
Last updated: Jun 21, 2007 8:07:48 PM CDT    WebSphere Business Integration Server Foundation, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.wasee.doc/info/ee/ae/rins_patch.html

Library | Support | Terms of Use | Feedback