IBM Support

Knowledge Collection: How to upgrade the firmware on an IBM WebSphere DataPower Gateway Appliance

Product Documentation


Abstract

Instructions on how to successfully upgrade the firmware on an IBM DataPower Gateway+ Appliance

Content

Follow these steps for a successful upgrade of the firmware on your appliance.


  • - Step 1. Read this Important Information.
    10.5.0 Upgrade/Migration Flow
    image-20221019161523-1
    It is not supported to use the 10.5.0 firmware on the 8436 IDG appliance type
    There is a migration only 10.5.0. firmware build if you need to use the secure restore process to migrate and IDG to an X3 (or X2 running 10.5.0) see this link for the migration steps to migrate an IDG to an X3 appliance
    The 8496 X3 appliance:
    The upgrade from the 10.5.0.0 level to 10.5.0.1 - 10.5.0.4 takes longer than normal (40 to 50 minutes).
    The upgrade from 10.5.0.4 to 10.5.0.5 or higher takes longer than normal (30 to 40 minutes)
    Do not reboot the appliance during this time!
    To watch the upgrade progress see below for upgrading using the serial connection.
    The 8441 X2 appliance:
    1. Must upgrade to the 10.0.1.9 (or newer) firmware before to upgrading to 10.5.0 firmware
      Note: This step applies only to the 8441 X2 appliance type and is NOT required to use the secure backup migration only 10.5.0.2 firmware for the 8436 IDG appliance type.
    2. Once the appliance has been upgraded to 10.5.0 it may only be downgraded to the 10.0.1.9 or newer 10.0.1 firmware before any further downgrades.
    3. The virtual appliances do not need to use the 10.0.1.9 upgrade step (see table below)
    4. If running a CD release such as 10.0.4.0 you can upgrade directly to 10.5.0.x.
      Note once at 10.5.0.x you may not roll back/downgrade to a CD release and as noted in #2 all downgrades must first go to 10.0.1.9 or higher.
    5. IMPORTANT!!
      If you are running any ITX (formerly WTX) maps in your configuration you must open a case with support and request the activator tool for the new ITX license.
      The ITX function was included in the Integration and B2B module licenses but was required to be moved to a separate license.
      *If you are currently using the ITX functions, you may request the ITX license activator tool for no cost by opening a case with support and include an error *report from one or your appliances to allow the support team to provide the activators as support must confirm the current ITX usage before providing the activator.
      *To confirm if you have ITX usage generate an error report and search for ".dpa" and look for a file in a service.
      *There only has to be active ITX usage on one appliance and only one case is needed to cover all your appliances.

      *If you do not activate this license before upgrading to 10.0.1.9 your ITX maps will fail, and you will need to perform one of the mitigations steps to recover your ITX configuration.
          a. If you only did one upgrade then roll-back the upgrade, apply the new license and then upgrade again.

          b. If you have done the "stepped" upgrade to 10.5.0 you will need to restore your ITX configuration files manually or from a previous backup.
    6. See this link for the steps to migrate an X2 appliance to an X3

      Notes
    • Much of the upgrade occurs while the network is not active so no progress monitor is available.
      If you would like to watch the upgrade progress, you may issue the upgrade command from the serial console after uploading the new firmware from the WebGUI.
      Example for the 10.5.0.1 firmware after uploading the image:
      idg# config
      idg# dir image: 
      idg(config)# dir image: (note the image name)
         File Name                st Modified                                     -------------   ----
         idg10501.scrypt3     2:30:03 PM          1338927656available to image:
      idg(config)# flash
      idg(config-flash)# boot image accept-license idg10501.scrypt3
       
    • Starting with the V10.x firmware the V10.0.x.x level will require current support contracts to be able to download from the Fix Central download site.
    • If you are running API Connect with your DataPower you must be at the same firmware level when running version 2018.4.x firmware levels.
      *Example: if you want to upgrade your DataPower appliance to 2018.4.1.7 you must also upgrade your APIC to the same fix pack level for API Connect of 2018.4.1.7 
      If running the 10.0.x firmware you must be withing + or - one release level.
      *Example: if you want to upgrade your DataPower appliance to 10.0.1.5 your APIC can be at 10.0.1.4, 10.0.1.5 or 10.0.1.6
      If running the 10.5.0.x firmware you must be at the APIC level of 10.0.5
    • The virtual appliance is supported by firmware level and as the 2018.4.1 firmware goes end of support 30 Apr 2023 you must upgrade your virtual appliances to a supported level of 10.0.1 or 10.5.0 to have the virtual appliance supported.

    Firmware Level Prerequisites:

    LTS (Long Term Support) Stream Firmware

    The firmware in this table is the Long-Term Support (LTS) Model

    • Long Term Support (LTS) Major release every 12 months
    • LTS releases are for customer seeking enhanced stability and do not want to upgrade on the CD schedule, while CD releases are intended for customers seeking the latest features.
    • LTS releases will be supported for a minimum of 2 years.
    • Example of LTS firmware image names on fix central: idg10.0.1.9.lts.scrypt3

    Appliance Type

    Target Firmware

    Minimum Pre-Req firmware

    8496 DataPower Gateway X3 V10.5.0.x V10.5.0.x
    8441 DataPower Gateway X2 V10.5.0.x 10.0.1.9
    8436 DataPower Gateway IDG

    V10.5.0 migration only firmware 
    Request migration firmware in a support case

    secure backup migration  firmware only.
    Not supported for any testing or production
    2018.4.1.x or 10.0.1.x
    DataPower Gateway Virtual edition V10.5.0.1 2018.4.1.x or 10.0.1.x
    Note: The 2018.4.1 goes end of support 30 Apr 2023 so you must upgrade your virtual appliances to a supported level of 10.0.1 or 10.5.0 to have the virtual appliance supported.
    DataPower Gateway Virtual on Linux V10.5.0 RPM available on your Passport Advantage download page will be a minimum of 10.5.0.2
    Red Hat(RHEL) version 8.4 or higher version 8
    Important Notes:
    • If you have existing DataPower gateways deployed on a lower Red Hat version they will no longer function if the Red Hat is upgraded to V8 and they cannot be directly upgraded to 10.5.0.x.
      For details see this technote for upgrading the Linux appliance to the 10.5 firmware
    • Deploy new DataPower Gateways on Red Hat 8.4 or higher version 8 and then upgrade to the final desired version of 10.5.0.x.
      See the Fix Packs for DataPower 10.5.0 for the current released fix packs and fix lists

    8441 DataPower Gateway X2

    V10.0.1.x

    7.6.0.18

    8436 DataPower Gateway IDG

    V10.0.1.x

    7.6.0.18

    8441 DataPower Gateway X2

    2018.4.1.x

    7.6.0.4

    8441 DataPower Gateway X2

    53X  model with HSM

    2018.4.1.7 or higher

    7.6.0.4

    8436 DataPower Gateway IDG

    2018.4.1

    7.1.0.x

    Virtual DataPower Gateway IDG

    2018.4.1

    7.0.0.x



     


    CD (Continuous Delivery) Stream Firmware

    The firmware in this table is the Continuous Delivery (CD) Model

    • CD releases approximately once per quarter
    • Only the most recent CD release is supported at a given time.
      *Example: the v10.0.2.0 CD firmware will no longer be supported when v10.0.3.0 CD  level is released
    • This may not be suitable for production environments, as new releases may contain new functions and behavior changes.
    • It is recommended to upgrade to the latest LTS firmware before upgrading to a CD firmware to allow for a rollback path if needed.
    • Once you upgrade to the next CD release (10.5.0.x) you cannot go back to the CD release without first downgrading to 10.0.1.9 or higher 10.0.1 firmware first then it will allow you to upgrade to the CD release such as 10.0.4.0.
    • CD stream releases are used for the base of the next LTS release:
      *Example: The 7.7.x CD release was the base for the 2018.4.1.x LTS release
    • See this page for details:  Firmware Lifecycle page

    Appliance Type

    Target Firmware

    Minimum Pre-Req firmware

    8496 DataPower no supported CD release 10.5.0.1

    8441 DataPower Gateway X2

    10.0.2.0 or higher

    7.6.0.18

    8441 DataPower Gateway X2 53X model with HSM

    10.0.3.0 or higher

    7.6.0.18

    8436 DataPower Gateway IDG

    10.0.2.0 or higher

    7.6.0.18

    Virtual DataPower Gateway IDG

    10.0.2.0 or higher

    7.6.0.18


    Critical Planning Information:

    Scope: This technote does not cover how to upgrade a DataPower appliance to add an optional feature. Please reference our technote on this topic. 

    Plan: Create a firmware upgrade plan with all the stakeholders which includes a test plan to make sure the appliance works as expected after the upgrade.
    Review the release notes for the target firmware and any intermediate major firmware releases for any new features or changes that may affect your environment.
    Supported firmware versions and recommended levels for IBM DataPower Gateways products.

    1. Critical Information: Please create a privileged user ID as a back up for the "admin" account on your appliances. This will allow you to restore the "admin" account password in case the "admin" account is locked out or the password is lost.
    2. Critical Fixes: Please read the list of critical updates documented by IBM Support in this flash: Critical updates for IBM WebSphere DataPower SOA appliances.
    3. Review Prerequisite Firmware Levels needed before upgrade


    Additional Firmware Information:
    • Determining the firmware level for your unique business solution: IBM publishes several technotes to help your team determine the appropriate firmware levels for your business solution
    • Supported firmware levels: Review the list of recommended, generally available firmware for IBM DataPower Gateway Appliances in this document: Supported Firmware.
    • Release notes: Release notes are available for the major releases from the WebSphere DataPower Library page under Product Documentation. The appliance has firmware. The firmware is IBM Proprietary information. The firmware is updated via one image to upgrade all features as purchased on the appliance
     

     

  • - Step 2. Identify The Firmware Image File Which Matches Your Appliance


    The DataPower firmware image file names have the following format or pattern:
    zzNNNN.licenses.scrypt{3/4}.

    • Using the information in this step you will resolve this pattern to the one image file name which matches your appliance.  For example:
      • Standard image file name without optional license:  idg10.0.1.x.scrypt3
      • Image filename with a Tibco license:  idg10.0.1.x.tibco.scrypt3 

    IMPORTANT:  For the V10.0.x.x firmware levels you must have current support contract in place to download from the fix central site

    The following steps will help you determine the firmware image file name which will work with your appliance.

    1. Determine the zz value in zzNNNN.licenses.scrypt{3/4}, which is the appliance model:
      1. You can use the DataPower WebGUI to obtain your appliance model. The DataPower model displays on the upper left of the banner on every WebGUI page as IDG, X2 or X3.
      2. The first 2 characters of the model are the "zz" in the image format. Using this example throughout this section, for an idg model appliance, the image file name would start with IDG: idgNNNN.licenses.scrypt{3/4}.
    2. The NNNN value in the firmware image file name is the firmware release level.
      1. To display the current firmware select Status, look under System and select Firmware Information, or scroll to the bottom of the WebGUI page. The firmware level and model are listed at the end of the selections. Or you can issue the "show version" CLI command
      2. Read this technote to determine which firmware level you want to install. Supported Firmware versions and recommended upgrade levels for IBM WebSphere DataPower SOA Appliances
      3. Next read the list of critical updates posted by IBM Support in this critical update flash to confirm your upgrade image choice has all critical updates included
      4. The firmware levels are listed in the form x.x.x.x, remove the '.', and this will be the "NNNN" in the firmware image. Using our example of idgNNNN.licenses.scrypt{3/4} , if you want to install 2018.4.1.16, NNNN would be 20184116. This would be idg20184116.licenses.scrypt{3/4} in our example.
    3. Determine if you need a scrypt3 or scrypt4 file. The scrypt{3/4} value is based on the machine type. To display the hardware generation (machine type), select Administration > Device > System Settings. In the Product ID value, the machine type is the first 4 numbers, for example, 844152X, is machine type or M/T 8441. Match the machine type or M/T:
      1. For virtual devices (for example M/T 5725), use scrypt of the form zzNNNN.licenses.scrypt4
      2. For physical devices (for example M/T 8441), use idgNNN.license.script3  
    4. Check the licenses you purchased on the appliance. This is the "licenses" value and you may have more than one license on the appliance.
      1. To display the license information select Status, look under System and select "Device Features". Note which features are enabled.
      2. Several licenses will appear. The licenses which affect your choice of image file name (depending on firmware level) are TAM, SQL/ODBC, and TIBCO. Make a note of which of these 4 licenses are displayed to use in the following steps, along with the machine type (M/T) and scrypt{2/3/4} you found. If you have other licenses, they will be updated as appropriate.
        1. If TIBCO or ORC do not appear, then zzNNNN.scrypt3/4 is the image file name pattern and you can proceed to step 5 "Here are examples....", to look at examples.

    With this information you can proceed to the next steps.

     

  • - Step 3. Download The Image Which Matches Your Appliance

    Important!! Starting with the 10.0.x.x firmware the V10.0.x.x level will require current support contracts to be able to download from the Fix Central download site.

    1. Go to the Fix Central website
    2. A user ID and password is now needed to access downloads on Fix Central. Here is our technote with more information.
    3. From the Product Group drop-down list, select WebSphere.
    4. From the Product drop-down list, select IBM DataPower Gateways.
    5. For the Installed Version, choose 2018.4.1 for example.
    6. Sign in with your IBM Account
    7. To limit the result to your DataPower model (IDG, virtual etc.), select the text radio button.
    8. In the text file field, use IDG to find all the IDG options
    9. Select the firmware level
    10. After you select Agree you will see a list of all the firmware files for an IDG or the files will be download. Using the information in step 2 you will have identified the one correct image file to use.
    11. Check the size of the file you downloaded. The file size should be close to the same size as on Fix Central. They will not be exact, but should be very close.
      If the image files appears as binary in your browser, please right-click and choose Save As from the browser,
      For help with accessing the Fix Central site, or suggestions to improve Fix Central, click the feedback button on the Fix Central web page.
     

     

  • - Step 4. Install The Firmware Image.



    When possible use the WebGUI for firmware upgrades as the WebGUI is easier than issuing several CLI commands. WebGUI/CLI commands are provided for each step where the command exists for both methods.

    1. IMPORTANT: Check the firmware on the appliance.
      From the WebGUI, under Status, look under System and select Firmware Information, or scroll to the bottom of the WebGUI page.
      From the CLI issue the show version command.
    2. Check if this will downgrade the appliance to an older major release level of firmware than currently installed.
    3. If you need to downgrade to a different major release such as from 10.0.x.x to 2018.4.1.x:. The only supported procedure is first reinitialize the appliance by following this technote Resetting an IBM DataPower Gateway Appliance to install the 2018.4.1.x image. A major release is identified by the first three points of the version such as: 2018.4.1 and 10.0.1 which are all separate major releases.
    4. Back up the appliance's configuration in a safe location off the appliance. Reference our technote on backup and import features of the appliance.
    5. Confirm you have a working "admin" user ID.
    6. IMPORTANT: Create or confirm you have a back up privileged user ID which can change the "admin" password if needed. See part 2 item 1 in our technote on lost passwords.
    7. Confirm the passwords for both user IDs have recently been changed and tested to ensure you can access the appliance with each user ID.
    8. IMPORTANT: Download and save to another computer any extra or unneeded files. You will want to delete the files from the appliance to make room for the upgrade.
      Freeing space and saving off unneeded files is important. When you upgrade the firmware the appliance creates a "roll back image" which includes the files (for example any logs you might be writing on the appliance), user IDs, passwords, etc. This will take up file space on the appliance. The appliance manages file space and you cannot determine all the file space used by a roll back image or other files which the appliance maintains.
      1. Read our technote: DataPower file system explained for more information. You will want to delete the files off the appliance to make room for the upgrade. This will also reduce your "rollback (boot switch) image size", Firmware upgrade process creates a boot switch image in case you want to return to previous configuration, firmware, and user files. You should remove unneeded files before an upgrade, thus allowing for more space in future upgrades. The amount of file system space needed to upgrade depends on the history of the appliance and previous firmware upgrades.
      2. Using the WebGUI File management option or CLI commands, remove any unneeded files you might have added from the local, store, and LogStore directories. The WebGUI will be easier to use for this step:
        1. In the WebGUI navigate to File Management. You can download and delete from the menu options. Click Help for more information.
        2. From the CLI, issue for each directory and each file to obtain output of the files:
          top
          config
          dir local:
        3. Review the output completely to determine what you can save then delete. See our technote on copying files to and from the appliance.
        4. After the files have been safely stored, remove the files from the appliance using the delete command. For example if you have a file called oldfile in the local directory, then the command issued in the configuration mode would be: delete local:\\\oldfile
      3. If you using the API Connect Gateway Service and do not have enough space after trying to upgrade:
        If gateway-peering persistence feature is enabled with the persistence location set to memory you should:
        1. temporarily disable the gateway-peering objects
        2. perform a shutdown reboot (to clear these files from memory)
        3. reattempt upgrade.
        4. after upgrading you can proceed to re-enable the gateway-peering object.
    9. Check if you have enough space.
      1. From the WebGUI select: "Status->Filesystem Information".
      2. Use the CLI: "show filesystem" command
    10. If you are not able to free up enough space by backing up or deleting unneeded files, double check again. You will need a backup of the appliance stored on a computer or server before using these options:
      1. From the CLI issue these commands to remove the rollback image to free up more space.
        config
        flash
        boot delete
      2. You can delete domains, and then import the back-up zip after you have upgraded, via the WebGUI which provides options on what to import.
      3. You can "reinit" the appliance. See: Our resetting an IBM WebSphere DataPower SOA Appliance technote. This will clear the appliance and upgrade the firmware image but all configuration would be lost.
    11. Save the configuration.
      1. In the WebGUI, use the “Save Config” option from the top pull-down.
      2. From the CLI: write mem
    12. IMPORTANT: Remove the appliance from the business solution or other environment, so that no traffic is flowing to the device and only the user who is performing the upgrade is logged on.
      1. Remove the appliance from load balancers or network environment to stop traffic from going to the appliance.
      2. Check that there is no traffic flowing on the interfaces.
        1. In the WebGUI, select Status > IP-Network > Ethernet Interfaces
        2. From the CLI:
          show int
          show int mode
        3. Quiesce the appliance to stop services from processing traffic
    13. Reboot the appliance to free up resources.
      1. In the WebGUI navigate to System Control, then under Shutdown reboot the system by setting the mode to Reboot system. Click the Shutdown button, read the pop-up prompts and click the appropriate button. Be sure to wait if the pop-up message informs you to wait before taking any actions.
      2. From the CLI. issue shutdown reboot
    14. Wait for the appliance to reboot.
    15. When the appliance reboots, completes, and you have access to the WebGUI, or CLI, upload the firmware image:
      1. In the WebGUI: navigate to System Control. Next in the Boot Image section click Upload or Fetch to load the image file to the appliance.
      2. From the CLI: use the best copy method to move the image file to the image directory. See our technote on copying files to and from the appliance.
    16. Make sure that the firmware image file is loaded and boot (install) the image:
      1. In the WebGUI, in the Boot Image section pull down and install the new Firmware by clicking on the "Accept License" check box and then click Boot Image, Read the pop-up prompts and click the appropriate button. Be sure to wait if the pop-up message informs you to wait before taking any actions. Do not click the Close button on the pop-up status notices. The status pop-up will change to a complete status, and you can then click OK.
      2. From the CLI:
        config
        dir image:
      3. if the image is found, then you can issue:
        flash
        boot image accept-license <image name>
    17. Wait for the appliance to reboot and for the appliance to restart.
    18. Verify the firmware upgrade was successful:
      1. In the WebGUI navigate to "version information".
      2. From the CLI, use the show version command.
    19. Un-quiesce the appliance to bring the services online
    20. Add the appliance back to the business solution (add back to the load balancer's or network environment).
    21. Test and verify the appliance operates correctly per your company's procedures.

    Note: If, for any reason, you need to go back to the previous firmware level and its configuration, you can toggle between releases by rolling back and forth between the current and the previous image. This includes rolling back between major releases.
    1. In the WebGui:
      1. from the Control Panel, choose System Control.
      2. in the Firmware Roll-Back section click the "Firmware Roll-Back" button to toggle between images.
    2. Using the CLI:
      top
      config
      flash
      boot switch
     

     

  • - Resolution To Common Problems


    If the firmware did not upgrade or you have experienced problems after upgrading. Review this information:

    1. Check the following first.
      1. If you are following all the steps in this technote using the WebGUI and the upgrade is still not successful, reboot the appliance, then upload the image via the WebGUI, and use the following CLI commands to upgrade the firmware. (Note: When uploading the firmware image you may rename it to make typing it into the CLI command easier.) If the upgrade fails, save any messages from this session to assist in troubleshooting the upgrade issue.
        top
        config
        flash
        boot image accept-license <image name>
    2. IMPORTANT: After any failed upgrade attempts, reboot (shutdown reboot) the appliance.
    3. Check that you followed each step in the section "Step 4. Install The Firmware Image". Perform a reboot (shutdown reboot) and try all the steps again.
    4. When upgrading the firmware on an appliance, make sure you wait until the firmware upgrade completes before entering other commands. In some cases the new major release
    5. If the upgrade is not working, check the throttle settings and turn them off temporarily while uploading the image file and upgrading the firmware in Objects -> System Settings-> Throttle Settings.
      1. Perform a shutdown reboot, then follow the steps in "Step 4. Install The Firmware Image".
    6. Memory and File space
      1. Memory: In step 4, there are steps to make sure the appliance is not being used, no traffic, domains disabled, only the person doing the upgrade is logged on, and various times were a reboot is required. This will reduce memory usage.
      2. File system space: In Step 4 there are suggestions on which directories to look at with all the stakeholders which use the appliance. There is a link to a technote on looking at file system use. With your team you can determine which files to store off the appliance or are no longer needed.
      3. For virtual appliances upgrading to some major releases you may not have the space to upload the new image and in this case contact support for a tool to expand the temporary space on the appliance.
    7. Did you receive an error message?
      1. "extracting firmware firmware parsing error":
        If you see a message indicating " extracting firmware firmware parsing error": Download the image file again. The file size should be close to the same size as on Fix Central. They will not be exact, but should be very close. Another possibility is that the WebGui session timed out before the firmware image was completely uploaded. Try increasing the WebGui time out and uploading the image file again.Perform a shutdown reboot, then follow the steps in "Step 4. Install The Firmware Image".
      2. "Error while processing Action ... Validate boot image failed "Validation Failed":
        If you see this message, the image file might not have downloaded completely from Fix Central. Download a new copy of the file. The file size should be close to the same size as on Fix Central. Another possibility is that the WebGui session timed out before the firmware image was completely uploaded. Try increasing the WebGui time out and uploading the image file again. Perform a shutdown reboot, then follow the steps in "Step 4. Install The Firmware Image".
      3. Warnings have been detected: Would you like to continue? Firmware does not contain supported feature '_____':
        This message indicates that the firmware image is not a match to the appliance. See section 2 "Step 2. Identify The Firmware Image File Which Matches Your Appliance". Download a matching image. Perform a shutdown reboot, then follow the steps in "Step 4. Install The Firmware Image".
      4. Upgrade failure in dynamic loader: Preserve user modified data failed The dynamic loader failed to upgrade the system (-1):
        If the upgrade did not work and you see this message, the resident loader will be used instead. Confirm that the firmware upgrade was successful by checking the appliance firmware level via the WebGUI or "show version" CLI command. This message is informational.
      5. Upgrade failure in dynamic loader: Switch active firmware failed The dynamic loader failed to upgrade the system (-1):
        If you see this message after upgrading, the resident loader will be used instead ...": Confirm that the firmware upgrade was successful by checking the appliance firmware level via the WebGUI or "show version" CLI command. This message is informational.
      6. Loading firmware failed: Preserve user modified data failed: Insufficient flash space available Could not install firmware image. The system will not reboot. ",
        There is not enough space available to upgrade the appliance. Follow the steps in "Step 4. Install the Firmware Image" which describe how to save files and free up space. Additional symptom: Preserve user modified data failed
      7. Wed Oct 15 2008 22:27:01 [crypto][error] certificate( yourcertname): tid(123): certificate 'pubcert:///yourcertname.pem' is expired":
        See this technote: Public certificates and the DataPower Gateway.
      8. % Loading firmware failed: Internal receive API error (3)
        The API error (3) is due to a timeout. The timeout happens when copying files for the rollback feature, when there is a large number of files to process. When the device reboots, the upgrade will continue and should be successful. Use the WebGUI or the CLI commands " show version" and "show license" to confirm upgrade was complete. If the upgrade is not successful, you might need more space. Perform a shutdown reboot, then follow the steps in "Step 4. Install The Firmware Image".
      9. % Loading firmware failed: Extract firmware failed: Archive extraction
        There is not enough space available to upgrade the appliance. Follow the steps in "Step 4. Install the Firmware Image" which describe how to save files and free up space.
    8. Objects not showing after an upgrade?
      1. Domains do not show:
        If after upgrading the firmware, the domains you have configured do not appear: From the WebGUI create each domain with the same name again. The domains and services previously configured should now appear. Otherwise follow these steps to contact IBM WebSphere DataPower SOA Appliance Support.
      2. Folders and files:
        Unable to access the folders/files on particular domain after upgrading firmware:
        While upgrading DataPower firmware, you might notice that the following message does not show up on a particular domain in an error report.
        For example, on the "yourTestDomainName" domain:
        [yourTestDomainName][mgmt][info] raid-volume(raid0): trans(12345): Installed storage volume access link logstore://ondisk
        This missing ondisk subdirectory is caused by an asynchronous issue due to a race condition during boot time. A work around method is to issue the 'shutdown reboot' command. The hard disk folders/files should be available after the appliance restarts.
    9. Connection Problems After Upgrade:
      1. Unable to connect using WebGUI or ssh after upgrading firmware:
        1. This can occur if you are using a custom cert or authentication for the management services, if any of the associated certs have expired. Expired certs are removed at upgrade time.
          The first step is to verify that the network is functioning correctly using these commands:
          top
          config
          show int
          show int mode
          show route
          
        2. These commands will show if there is any network activity as well as the connection details such as link speed. Once the network is confirmed the quickest way to recover the web management (WebGUI) and ssh services is to delete them and re-create them with the default settings using the serial console. These commands will reset the RBM's, ACL's, WebGUI and ssh services all to the default settings. Note: If the ssh is working you may omit any commands containing ssh.
          switch default
          top
          config
          web-mgmt
          no ssl
          exit
          write mem
          y
          no web-mgmt
          no ssh
          rbm
          reset
          exit
          acl web-mgmt
          reset
          exit
          acl ssh
          reset
          exit
          write mem   <----- this is a key step to remove the current settings
          y
          web-mgmt    <----- IP to listen on or 0.0.0.0 for all, the port to use default is 9090
          ssh         <----- IP to listen on or 0.0.0.0 for all, port to use default is 22
          write mem
          y
          Once complete, test the service and confirm you can now access the appliance. Then you may work to configure any custom certs or authentication settings wanted.
     

     

  • - Considerations when using scripts or programs

    1. If you are using scripts or programs to upgrade the appliance firmware, the programs should be designed to follow the same steps a person would perform to prepare the appliance for an upgrade. See Step 4 in this technote.
    2. See Step 4 for information on prerequisite firmware or other upgrade actions.

     

[{"Type":"SW","Line of Business":{"code":"LOB45","label":"Automation"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS9H2Y","label":"IBM DataPower Gateway"},"ARM Category":[{"code":"a8m50000000CdqiAAC","label":"DataPower-\u003EMGMT (MM)-\u003EFirmware Upgrade\/Downgrade"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Version(s)"}]

Document Information

Modified date:
12 September 2023

UID

swg27015333