boot image

This command manages the installed firmware and features.

Syntax

boot image [accept-license] file

Availability

All platforms, except Docker.

Parameters

accept-license
Indicates acceptance of the terms of the license agreements.
file
Specifies the name of the file that contains the management tool. The file must be in the image: directory.

Guidelines

The boot image command manages the installed firmware and features by processing the instructions in the file that contains the management tool.

Attention: On 8496 appliances, you cannot install a firmware version earlier than 10.5.0.1.
The boot image command processes the following firmware management actions.
  • Install a firmware image, and restart the DataPower® Gateway.
  • Activate, disable, or re-enable features in add-on modules, but does not restart the DataPower Gateway.
  • Run the integrity verifier tool, but does not restart the DataPower Gateway.

You can obtain all files at no cost from IBM® Fix Central, except the files to activate features in add-on modules. For files that activate features in add-on modules, you must purchase the tool from IBM Passport Advantage®.

When you use the boot image command, you must acknowledge the acceptance of the terms of the license agreements in one of the following ways. If you do not accept the license agreements, processing fails.
  • Include the accept-license keyword.
  • Have the empty temporary:///license.accepted file. Use this approach when you automate firmware management processes with scripts.

When you install a firmware image, it can contain different versions of component firmware. Examples of component firmware include, but is not limited to, the BIOS, BMC, and RAID controller for the DataPower Gateway. When the firmware image contains different versions of component firmware, the installation can take approximately 20 minutes. During this process, do not power off or restart the DataPower Gateway.

When you purchase and active features in add-on modules, you must restart the DataPower Gateway or install your current firmware image again. For only the following features and modules, you must install your current firmware image again to install their libraries.
  • Extended Oracle support for the Database Connectivity feature
  • TIBCO EMS Module

When you run the integrity verifier tool, it verifies the integrity of files that are part of the currently installed firmware. When files are different than the currently installed firmware image, this tool creates the temporary:///log/SysCheck.txt file. This file lists the files that are different. This tool is similar to running the verify-firmware command.

Examples

  • Restarts the DataPower Gateway with the FP3 file in the image: directory and acknowledges acceptance of the license agreements with the accept-license keyword.
    # boot image accept-license FP3
    …
    .....Firmware upgrade successful
    Device is rebooting now.
  • Restarts the DataPower Gateway with the FP3 file in the image: directory when an empty file temporary:///license.accepted exists.
    # boot image FP3
    …
    .....Firmware upgrade successful
    Device is rebooting now.
  • Activate the Integration Module and acknowledges acceptance of the license agreements with the accept-license keyword.
    # boot image accept-license IntegrationModule
    Invoking dynamic loader
    This scrypt will not perform a firmware upgrade
    ...
  • Run the integrity verifier tool and view results.
    # boot image accept-license verifier
    ...
    Starting the DataPower Integrity Verifier tool
    ...
    Examining files...
    Examined 1000 records, checked 955 files
    File store:AAAInfo.xml has changed
    ...
    Examined 7000 records, checked 5179 files
    Verification complete. Examined 6999 files
    Checked 5145 files, 1 changed
    ...
    
    # show file temporary:///log/SysCheck.txt