Determining the firmware image to download

Depending on the platform, firmware images are available from IBM® Fix Central or IBM Entitled Registry

  • IBM Fix Central provides multiple firmware images for each DataPower® product, except when the platform is docker.
    • Because tenant firmware images differ from landlord firmware images, make sure that you download a tenant-specific firmware image.
    • Unless you are an IBM Business Partner who requires Application Specific Licensing (ASL) images, do not download packages that state For ASL Partners.
    Therefore, you must know which firmware images to download for products in your environment.
  • When the platform is docker, images are available from IBM Entitled Registry. For more information, see Pulling images from the IBM Entitled Registry.
Depending on the DataPower product, the image file name is in one of the following formats. These images are encrypted and signed for secure installation.
  • productVRMF.type.licenses.scrypt3
  • productVRMF.type.licenses.scrypt4
The file name includes the following variables and keywords.
product
Identifies the DataPower product.
idg
Indicates a DataPower product except when the platform is linux or docker.
idg_lx
Indicates a DataPower product when the platform is linux.
VRMF
Indicates the full version of the firmware image as version, release, maintenance, and fix. A file name with a VRMF of 10000 is a 10.0.0.0 firmware image (version 10, release 0, maintenance 0, fix 0).
type
Indicates the delivery type.
  • Long-term support (LTS) releases are intended for customers who demand the highest levels of stability. Updates during the support period contain fixes to identified problems and vulnerabilities.
  • Continuous delivery (CD) update packages add new functions on a regular cadence. These CD update packages are intended for customers who want to take advantage of the newest features and capabilities without waiting for the next LTS release. Each CD update package contains fixes to identified problems and vulnerabilities. Only the most recent CD upgrade package is supported.
For more information, see IBM DataPower Gateways Firmware Support Lifecycle.
licenses
Indicates feature-specific libraries in the firmware image. To determine whether you require feature-specific libraries in your firmware image, see Identifying features with feature-specific libraries.
oradco
Indicates an image with the library that supports the Extended Oracle support for the Database Connectivity feature.
tibco
Indicates an image with the library that supports the TIBCO EMS feature.
tenant
Indicates a tenant-specific image.
After you pick your product on the Fix Central website, you are presented with up to four choices based on which feature-specific libraries you require.
  • No license value
  • The oradco license value
  • The tibco license value
  • The tibco.oradco license value

The installation fails when the image you download and install contain feature-specific libraries and a feature is not enabled.

scrypt3
Indicates an image in the scrypt3 format. These images are for a physical product.
scrypt4
Indicates an image in the scrypt4 format. These images are for a virtual edition product except when the platform is docker.
The following examples are complete firmware image names for physical DataPower Gateway products.
idg10000.lts.scrypt3
Indicates the 10.0.0.0 image for DataPower Gateway with support for all features, except the TIBCO EMS and Extended Oracle support for the Database Connectivity (DCO-Oracle) feature features. When one or more feature-specific libraries are not supported, the upgrade operation does not install these libraries.
idg10000.lts.oradco.scrypt3
Indicates the 10.0.0.0 image for DataPower Gateway with support for all features, except the TIBCO EMS feature. When one or more feature-specific libraries are not supported, the upgrade operation does not install these libraries.
idg10000.lts.tibco.scrypt3
Indicates the 2018.4.1.0 image for DataPower Gateway with support for all features, except the Extended Oracle support for the Database Connectivity feature. When one or more feature-specific libraries are not supported, the upgrade operation does not install these libraries.
idg10000.lts.tibco.oradco.scrypt3
Indicates the 10.0.0.0 image for DataPower Gateway with support for all features. When one or more feature-specific libraries are not supported, the upgrade operation does not install these libraries.