Updating WebSphere DataPower XC10 appliance

Updating WebSphere DataPower XC10 appliance

Contents

Updating the firmware
Using the Update Installer to install maintenance packages
Install fix packs using IBM Installation Manager

Install fix packs with GUI
Install fix packs with scripts
Install fix packs using a response file

Uninstall fix packs using IBM Installation Manager

Uninstall fix packs with GUI
Uninstall fix packs with scripts
Uninstall fix packs with response files

Updating WebSphere DataPower XC10 appliance

To apply maintenance to your WebSphere DataPower XC10 appliance environment, first apply any firmware updates. Then, we can apply updates to the WXS client installations.

1. Updating the firmware

We can upgrade the IBM WebSphere DataPower XC10 appliance software by using firmware updates. Download new firmware versions from the Fix Central website and update your appliance software.
You must be assigned the Appliance administration permission to perform these steps.
Check to ensure that all active jobs are complete before starting the firmware update process. The firmware update process interrupts any jobs that are actively running, which can cause the data to become inconsistent. Ensure that you have planned for this behavior before beginning the update process.
If we are installing the firmware for the first time on a new appliance, run the clear-all command on the appliance after the firmware update completes.
We can update the firmware of the appliance by downloading a new firmware update from IBM and updating your appliance with the new firmware. We can run the firmware update in the user interface or on the command line.
If your appliances are in a collective, you must complete the firmware upgrade process on one appliance before starting the process on another appliance within the collective. If you attempt to update the firmware on multiple appliances in the collective simultaneously, data loss might occur.
After you upgrade either 9235-92X or 7199-92X appliance types with Version 2.0.0.x firmware, we cannot roll back to Version 1.0 firmware. We can roll back and upgrade between Version 2.0.0.x or firmware levels freely.

Download the firmware upgrade:

Navigate to IBM Fix Central and download a firmware update to your local file system. From the Fix Central page, select WebSphere as the Product Group and WebSphere DataPower XC10 appliance from the list of products. Download the firmware upgrade that is appropriate for your appliance hardware type:

Appliance firmware updates for Appliance type 9235-92X are a single file with .scrypt2 extension.
Appliance firmware updates for Appliance type 7199-92X are a single file with .scrypt3 extension.
These scrypt files are signed to ensure the integrity of update being run. If we are using the user interface to run the firmware upgrade, save this file on the computer that you use to access the user interface. If we are using the command-line interface to run the firmware upgrade, save this file on a server that we can access from the appliance.

To run the firmware update in the user interface:

Log on to the user interface.
Navigate to the Settings panel.

From the menu bar at the top of the appliance user interface, navigate to Appliance > Settings.
From the Home panel, click the Customize settings link in the Step 1: Set up the appliance section.

Expand Firmware. This section displays the level of firmware that is currently installed on the appliance.
Install a new firmware update.

Click Browse... to navigate the file system for the new firmware update file.
Select the new firmware update file and click OK.
Click Upgrade
The amount of time the firmware update takes to upload is dependent on your connection speed. A message is displayed when the upload has completed and the firmware update is starting. When the update begins the appliance is restarted, your screen does not indicate any progress or display any changes on the user interface. The changes are not displayed because the session ended when the appliance restarted and the user interface is not available during the upgrade process.
The appliance restarts several times during the firmware upgrade process. Do not interrupt the process or manually restart the appliance during the firmware upgrade.
To confirm the firmware update is complete, you must log in again when you expect the update is complete. The actual firmware update takes an average of about 10 minutes to 15 minutes after it starts but can possibly take longer. If we want to monitor the progress of the firmware upgrade, use the start-progress command in the command-line interface.

To run the firmware update in the command-line interface:

Connect to the appliance with the command line or through the serial console.
Put the .scrypt file on the appliance. From the command-line interface, run...
file get <url_to_scrypt_file> <firmware_file>

Where url_to_scrypt_file is the local server where you saved the .scrypt file from Fix Central, and firmware_file is the name of the .scrypt file to use on the appliance.
Install the firmware update. Run the following command:
firmware upgrade <firmware_file>

During the firmware upgrade process, the appliance restarts several times. Do not interrupt the process or manually restart the appliance during the firmware upgrade.
Run the start-progress command to monitor the progress of the appliance startup. When this command returns STARTED, the firmware upgrade is complete.

The appliance has the updated firmware version. To confirm the firmware upgrade was successful, we can view the current firmware level in the Firmware section of the Appliance > Settings panel. This panel also displays the appliance model type and appliance serial number. Repeat these steps for the other appliances in your collective.
If we are installing the firmware for the first time on a new appliance, run the clear-all command on the appliance after the firmware update completes. this command after the firmware update.

2. Using the Update Installer to install maintenance packages

Use the IBM Update Installer to update your WebSphere eXtreme Scale Client environment with various types of maintenance, such as interim fixes, fix packs, and refresh packs. Upgrade your appliance firmware before updating the WebSphere eXtreme Scale Client.
Use the IBM Update Installer to install and apply various types of maintenance packages for WebSphere eXtreme Scale Client. Because the Update Installer undergoes regular maintenance, use the most current version of the tool.

Stop all processes that are running in your environment.

To stop all processes that are running in your WebSphere Application Server environment, see Command-line utilities.

Download the latest version of the Update Installer. See Recommended fixes for more information.

Install the Update Installer. See Install the Update Installer for WebSphere Software in the WebSphere Application Server Information Center for more information.

Download into the updi_root/maintenance directory the maintenance packages that you intend to install. See the Support site for more information.

Use the Update Installer to install the interim fix, fix pack, or refresh pack. We can install the maintenance package by running the graphical user interface (GUI), or by running the Update Installer in silent mode.
Run the following command from the updi_root directory to start the GUI:

update.sh
update.bat

Run the following command from the updi_root directory to run the Update Installer in silent mode:

./update.sh -silent -options responsefile/file_name
update.bat -silent -options responsefile\file_name

If the installation process fails, see the temporary log file, which is in the updi_root/logs/update/tmp directory. The Update Installer creates the install_root/logs/update/maintenance_package.install directory in which the installation log files are located.

3. Install fix packs using IBM Installation Manager

Use IBM Installation Manager to update the product with the fix packs that are available for WebSphere eXtreme Scale Client product offerings. Fix packs can be installed from the GUI, the command line, or with response files.

3.1. Install fix packs with GUI

We can update WebSphere eXtreme Scale Client to a later version using the IBM Installation Manager wizard.
Upgrade your appliance firmware before updating the WebSphere eXtreme Scale Client. The most current information is available from the IBM Software Support Center and Fix Central.
IBM Installation Manager is used to apply product maintenance to the following product offerings:

WebSphere eXtreme Scale Client in a stand-alone environment
WebSphere eXtreme Scale Client forWebSphere Application Server Version 6.0
WebSphere eXtreme Scale Client for WebSphere Application Server Version 7.0
WebSphere eXtreme Scale Client for WebSphere Application Server Version 8.0

Make sure that the web-based or local service repository location is listed and checked or that the Search service repositories during installation and updates option is selected on the Repositories panel in your Installation Manager preferences. For more information on using service repositories with Installation Manager, read the IBM Installation Manager Version 1.5 Information Center.
Restriction: We cannot use the Installation Manager to upgrade an installation and add or remove the full WebSphere Application Server profile feature or the Liberty profile feature.

Stop all processes that are running in your environment.

To stop all processes that are running in your WebSphere Application Server environment, see Command-line utilities.

Log on to your system.

Stop all servers and applications on the WebSphere Application Server installation that is being updated.

Start Installation Manager.

Click Update.
Note: If we are prompted to authenticate, use the IBM ID and password that you use to access protected IBM software websites.

Select the package group to update.
If you select Update all, Installation Manager will search all of the added and predefined repositories for updates to all of the package groups that it has installed. Use this feature only if you have full control over which fixes are contained in the targeted repositories. If you create and point to a set of custom repositories that include only the specific fixes to install, you should be able to use this feature confidently. If you enable searching service repositories or install fixes directly from other live web-based repositories, then you might not want to select this option so that we can select only the fixes to install for each offering on subsequent panels.

Click Next.

Select the version to which we want to update under:

WebSphere eXtreme Scale Client in a stand-alone environment
WebSphere eXtreme Scale Client forWebSphere Application Server Version 6
WebSphere eXtreme Scale Client for WebSphere Application Server Version 7
WebSphere eXtreme Scale Client for WebSphere Application Server Version 8

Select any fixes to install.
Any recommended fixes are selected by default.
If there are recommended fixes, we can select the option to show only recommended fixes and hide non-recommended fixes.

Click Next.

Accept the terms in the license agreements, and click Next.

Select the optional features that we want in your updated installation.

Review the summary information, and click Update.

If the installation is successful, the program displays a message indicating that installation is successful.
If the installation is not successful, click View Log File to troubleshoot the problem.

Click Finish.

Click File > Exit to close Installation Manager.

3.2. Install fix packs with scripts

Use the IBM Installation Manager from the command line to update the product with the fix packs that are available for WebSphere eXtreme Scale product offerings.
Upgrade your appliance firmware before updating the WebSphere eXtreme Scale Client. The most current information is available from the IBM Software Support Center and Fix Central.
IBM Installation Manager is used to apply product maintenance to the following product offerings:

WebSphere eXtreme Scale Client in a stand-alone environment
WebSphere eXtreme Scale Client forWebSphere Application Server Version 6
WebSphere eXtreme Scale Client for WebSphere Application Server Version 7
WebSphere eXtreme Scale Client for WebSphere Application Server Version 8

Restriction: You cannot use the Installation Manager to upgrade an installation and add or remove the full WebSphere Application Server profile feature or the Liberty profile feature.
For a list of interim fixes and fix packs that are available forWebSphere eXtreme Scale 8.5 and specific information about each fix, perform the following actions.

Go to Fix Central.
Select WebSphere as the product group.
Select WebSphere eXtreme Scale as the product.
Select 8.5 as the installed version.
Select your operating system as the platform, and click Continue.
Select Browse for fixes, and click Continue.
Click More Information under each fix to view information about the fix.
Make a note of the name of the fix pack that you would like to install.
Update WebSphere eXtreme Scale Version 8.5 with the fix pack using the following procedure.
Download the file that contains the fix pack from Fix Central, and use local updating.
We can download a compressed file that contains the fix pack from Fix Central. Each compressed fix-pack file contains an Installation Manager repository for the fix pack and usually has a .zip extension. After downloading and extracting the fix-pack file, use Installation Manager to update WebSphere Application Server Version 8.x with the fix pack.
To download the fix pack, perform the following actions:

Go to Fix Central.
Select WebSphere as the product group.
Select WebSphere eXtreme Scale as the product.
Select 8.5 as the installed version.
Select your operating system as the platform, and click Continue.
Select Browse for fixes, and click Continue.
Select the fix pack to download, and click Continue.
Select your download options, and click Continue.
Click I agree to agree to the terms and conditions.
Click Download now to download the fix pack.
Transfer the compressed file in binary format to the system on which it will be installed.
Extract the compressed repository files to a directory on your system.
To install a fix pack from a downloaded file, perform the following actions:
Log on to your system.
Stop all processes that are running in your environment. To stop all processes that are running in your WebSphere Application Server environment, see Command-line utilities.
Change to the Installation_Manager_binaries/eclipse/tools directory, where Installation_Manager_binaries is the installation root directory for the Installation Manager.
Install the fix pack.
./imcl install offering_ID_offering_version,optional_feature_ID
       -installationDirectory product_installation_location
       -repositories location_of_expanded_files
       -acceptLicense
imcl.exe install offering_ID_offering_version,optional_feature_ID
         -installationDirectory product_installation_location
         -repositories location_of_expanded_files
         -acceptLicense
Tips:

The offering_version, which optionally can be attached to the offering ID with an underscore, is a specific version of the offering to install (8.5.0.20110503_0200 for example).

If offering_version is not specified, the latest version of the offering and all interim fixes for that version are installed.
If offering_version is specified, the specified version of the offering and no interim fixes for that version are installed.

The offering version can be found attached to the end of the offering ID with an underscore when we run the following command against the repository:
imcl listAvailablePackages -repositories source_repository

We can also specify none, recommended or all with the -installFixes argument to indicate which interim fixes we want installed with the offering.

If the offering version is not specified, the -installFixes option defaults to all.
If the offering version is specified, the -installFixes option defaults to none.

We can add a list of features that are separated by commas. If a list of features is not specified, the default features are installed.
Optional: List all installed packages to verify the installation:

./imcl listInstalledPackages -long

imcl.exe listInstalledPackages -long
3.3. Install fix packs using a response file

We can update WebSphere eXtreme Scale Client to a later version using IBM Installation Manager with a response file.
As an alterative to the procedure that is described in this article, Installation Manager allows us to use the updateAll command in a response file or on the command line to search for and update all installed packages. Use this command only if you have full control over which fixes are contained in the targeted repositories. If you create and point to a set of custom repositories that include only the specific fixes to install, you should be able to use this command confidently. If you enable searching service repositories or install fixes directly from other live web-based repositories, then you might not want to select this option so that we can select only the fixes to install using the -installFixes option with the install command on the command line or the installFixes attribute in a response file.
For a list of interim fixes and fix packs that are available for WebSphere eXtreme Scale Client Version 8.5 and specific information about each fix, perform the following actions.

Go to Fix Central.
Select WebSphere as the product group.
Select WebSphere eXtreme Scale Client as the product.
Select 8.x as the installed version.
Select your operating system as the platform, and click Continue.
Select Browse for fixes, and click Continue.
Click More Information under each fix to view information about the fix.
Recommendation: Make a note of the name of the fix pack that you would like to install.
Update WebSphere eXtreme Scale Client 8.5 with the fix pack using the following procedure.
Download the file that contains the fix pack from Fix Central, and use local updating.
We can download a compressed file that contains the fix pack from Fix Central. Each compressed fix-pack file contains an Installation Manager repository for the fix pack and usually has a .zip extension. After downloading and extracting the fix-pack file, use Installation Manager to update WebSphere eXtreme Scale Client Version 8.5 with the fix pack.
To download the fix pack, perform the following actions:

Go to Fix Central.
Select WebSphere as the product group.
Select WebSphere eXtreme Scale Client as the product.
Select 8.5 as the installed version.
Select your operating system as the platform, and click Continue.
Select Browse for fixes, and click Continue.
Select the fix pack to download, and click Continue.
Select your download options, and click Continue.
Click I agree to agree to the terms and conditions.
Click Download now to download the fix pack.
Transfer the compressed file in binary format to the system on which it will be installed.
Extract the compressed repository files to a directory on your system.
Perform the following actions:
Log on to your system.
If the repository requires a username and password, create a keyring file to access this repository.
For more information on creating a keyring file for Installation Manager, read the IBM Installation Manager Version 1.5 Information Center.
When creating a keyring file, append /repository.config at the end of the repository URL location if the imutilsc command is unable to find the URL specified.
Change to the Installation_Manager_binaries/eclipse/tools directory, where Installation_Manager_binaries is the installation root directory for the Installation Manager.
Install the fix pack using a response file.
For example:
Administrator or non-administrator:
imcl.exe -acceptLicense 
         input C:\temp\update_response_file.xml 
         -log C:\temp\update_log.xml 
         -keyring C:\IM\im.keyring
Administrator:
./imcl -acceptLicense 
       input /var/temp/update_response_file.xml 
       -log /var/temp/update_log.xml 
       -keyring /var/IM/im.keyring
Non-administrator:
./imcl -acceptLicense 
       input $HOME/var/temp/update_response_file.xml 
       -log $HOME/var/temp/update_log.xml 
       -keyring $HOME/var/IM/im.keyring
4. Uninstall fix packs using IBM Installation Manager

Use IBM Installation Manager to rollback WebSphere eXtreme Scale Client product offerings to an earlier version. We can uninstall fix packs from the GUI, the command line, or with response files.

4.1. Uninstall fix packs with GUI

We can roll back WebSphere eXtreme Scale Client to an earlier version using the IBM Installation Manager GUI.
During the rollback process, Installation Manager must access files from the earlier version of the package. By default, these files are stored on your computer when you install a package. If you change the default setting or delete the saved files, Installation Manager requires access to the repository that was used to install the earlier version.
Restriction: We cannot use the Installation Manager to roll back an installation and add or remove a feature.

Stop all processes that are running in your environment.

To stop all processes that are running in your WebSphere Application Server environment, see Command-line utilities.

Start Installation Manager.

Click Roll Back.

Select the package group to roll back.

Click Next.

Select the version to which we want to roll back under.

Click Next.

Review the summary information, and click Roll Back.

If the rollback is successful, the program displays a message indicating that the rollback is successful.
If the rollback is not successful, click View Log File to troubleshoot the problem.

Click Finish.

Click File > Exit to close Installation Manager.

4.2. Uninstall fix packs with scripts

We can roll back WebSphere eXtreme Scale Client to an earlier version using IBM Installation Manager from the command line.
Restriction: In order to use this procedure, have Installation Manager Version 1.5 or later installed on your system.
During the rollback process, Installation Manager must access files from the earlier version of the package. By default, these files are stored on your computer when you install a package. If you change the default setting or delete the saved files, Installation Manager requires access to the repository that was used to install the earlier version.
Restriction: We cannot use the Installation Manager to roll back an installation and add or remove the full WebSphere Application Server profile feature or the Liberty profile feature.
Optional: If the repository requires a username and password, create a keyring file to access this repository.
For more information on creating a keyring file for Installation Manager, read the IBM Installation Manager Version 1.5 Information Center.
When creating a keyring file, append /repository.config at the end of the repository URL location if the imutilsc command is unable to find the URL specified.

Log on to your system.

Stop all processes that are running in your environment.

To stop all processes that are running in your WebSphere Application Server environment, see Command-line utilities.

Change to the eclipse/tools subdirectory in the directory where you installed Installation Manager.
Use the imcl command to roll back the product.
./imcl rollback offering_ID_offering_version
  -repositories source_repository 
  -installationDirectory installation_directory
  -preferences preference_key=value
  -properties property_key=value
  -keyring keyring_file -password password   -acceptLicense
imcl.exe rollback offering_ID_offering_version
  -repositories source_repository 
  -installationDirectory installation_directory
  -preferences preference_key=value
  -properties property_key=value
  -keyring keyring_file -password password   -acceptLicense
Tips:

The offering_version, which optionally can be attached to the offering ID with an underscore, is a specific version of the offering to which to roll back (8.5.0.20110503_0200 for example).

If offering_version is not specified, the installation rolls back to the previously installed version of the offering and all interim fixes for that version are installed.
If offering_version is specified, the installation rolls back to the specified earlier version of the offering and no interim fixes for that version are installed.

The offering version can be found attached to the end of the offering ID with an underscore in the Package section of the report that is generated when we run the historyInfo or genHistoryReport command from the app_server_root/bin directory.

For more information on using Installation Manager, read the IBM Installation Manager Version 1.5 Information Center.
Optional: List all installed packages to verify the roll back.
./imcl listInstalledPackages -long
imcl.exe listInstalledPackages -long
4.3. Uninstall fix packs with response files

We can roll back WebSphere eXtreme Scale Client to an earlier version using IBM Installation Manager with a response file.
During the rollback process, Installation Manager must access files from the earlier version of the package. By default, these files are stored on your computer when you install a package. If you change the default setting or delete the saved files, Installation Manager requires access to the repository that was used to install the earlier version.
Restriction: You cannot use the Installation Manager to roll back an installation and add or remove the full WebSphere Application Server profile feature or the Liberty profile feature.
Optional: If the repository requires a username and password, create a keyring file to access this repository.
For more information on creating a keyring file for Installation Manager, read the IBM Installation Manager Version 1.5 Information Center.
When creating a keyring file, append /repository.config at the end of the repository URL location if the imutilsc command is unable to find the URL specified.

Log on to your system.

Stop all processes that are running in your environment.

To stop all processes that are running in your WebSphere Application Server environment, see Command-line utilities.
Use a response file to roll back the product.
Change to the eclipse/tools subdirectory in the directory where you installed Installation Manager, and roll back the product.
For example:
Administrator or non-administrator:
imcl.exe
  input C:\temp\rollback_response_file.xml 
  -log C:\temp\rollback_log.xml 
  -keyring C:\IM\im.keyring
Administrator:
./imcl
  input /var/temp/rollback_response_file.xml 
  -log /var/temp/rollback_log.xml 
  -keyring /var/IM/im.keyring
Non-administrator:
./imcl
  input $HOME/var/temp/rollback_response_file.xml 
  -log $HOME/var/temp/rollback_log.xml 
  -keyring $HOME/var/IM/im.keyring
Note: The program might write important post-installation instructions to standard output.
For more information on using Installation Manager, read the IBM Installation Manager Version 1.5 Information Center.
Optional: List all installed packages to verify the roll back.

./imcl listInstalledPackages -long

imcl.exe listInstalledPackages -long
+
Search Tips | Advanced Search