Installing the firmware image

How to install a firmware image. When the platform is docker, you cannot install firmware images. A Docker image that contains the DataPower® Gateway version is selected with the FROM declaration in your Dockerfile.

Before you begin

Transfer the firmware or feature image to the image: directory.

About this task

Install the image by designating the image as the startup image. Installing a firmware image can be an upgrade or downgrade.
  • An upgrade is an action that installs a firmware image that is later than the currently installed version. For example, an upgrade would be the installation of version 10.5.0.0 on a DataPower Gateway that is running version 10.0.1.2.
    Attention: On 8496 appliances, you cannot install a firmware version earlier than 10.5.0.1.
  • A downgrade is an action that installs a firmware image that is earlier than the currently installed version. For example, a downgrade would be the installation of version 10.0.1.2 on a DataPower Gateway that is running version 10.5.0.0.
    • Firmware images within a major release differ in only the last digit of the image name. For example, 10.5.0.1 and 10.5.0.0 are in the same major release.
    • Firmware images across major releases differ in the first 3 digits of the image name. For example, 10.5.0.1 and 10.0.1.2 are across major releases.
    Use the downgrade procedure for firmware images within the same major release. For firmware images across major releases, you must reinitialize your DataPower Gateway and restore its configuration from the secure backup package that you created before you upgraded the firmware. To reinitialize, use the reinitialize command in Flash mode.

Instead of installing the image from the GUI, you can use the boot image command in Flash mode.

When the firmware image cannot be installed, the DataPower Gateway reports an error. In this case, the DataPower Gateway does not restart or restarts with the previously installed firmware image.

Procedure

  1. In the search field, enter system.
  2. From the search results, click System control.
  3. Locate the Boot image section.
  4. If the firmware image is not in the image: directory, click Upload or Fetch.
  5. From the Firmware file list, select the firmware image.
  6. Select the I accept the terms of the license agreements checkbox.
  7. Click Boot image.
  8. Follow the prompts.

Results

After the final confirmation, the DataPower Gateway loads the selected firmware image and restarts. The process can take up to 3 minutes. If the DataPower Gateway fails to start, see the troubleshoot topic about firmware management operations.