IBM DataPower Operations Dashboard v1.0.16.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Firmware Upgrade Execution (Tasks)

This page describes how DPOD prepares the execution flow of a firmware upgrade plan (using tasks) and subsequently - how the tasks themselves are executed.

Task Creation Flow

General execution flow for a firmware upgrade plan:

  1. Verify that the system allows Firmware Upgrades to run. (See Configurable Parameters and Settings to learn how to enable or disable all firmware upgrade activities)
  2. Verify that the current system time is within the maintenance window timeframe defined for the plan
  3. Verify that the image repository path that was set in system parameters actually exist (See Configurable Parameters and Settings)
  4. Iterate over all the activities defined for the plan, and split them into executable tasks.
    For example: consider a plan with two activities, one to upgrade devices QA* and a second to upgrade device - TEST9.
    DPOD will create three tasks:
    a. Firmware upgrade task for device QA1
    b. Firmware upgrade task for device QA2
    c. Firmware upgrade task for device TEST9
    If all the created tasks are in "Skipped" state (because the devices are not available, or because no devices matched the input patterns) - the plan will stop
  5. If there are any tasks waiting to be executed - the Pre-Plan Script will be executed (if requested in the plan settings)
    .the plan will stop if the script's return code is higher than 0

Task Execution Flow

Only 2 firmware upgrade tasks will be executed in parallel

After the firmware upgrade tasks are created, they will start to execute. The following is the general execution flow for a task:

Firmware upgrade tasks will start to execute in the order they were created, which corresponds to the order which the activities were defined.

  1. Check that the image file's model type (IDG, XG, XI, XB) matches the device
  2. Verify that the image file is actually an upgrade, if it's a downgrade, DPOD will only allow downgrade to the same major release (if the user checked the "Allow Major Release Downgrade" option in the activity)
  3. Check that the same features appear in the image and device (Tibco-EMS and/or Dco-Oracle)
    If features present in the image but not in the device - stop
    If the features present in the device but not in the image - stop - unless the user checked the "Allow Features Incompatibility" option in the activity.
  4. Check that the image file's format matches the device (scrypt3 for physical devices or scrpyt4 for virtual devices)
  5. Verify that there is enough space in the encrypted and temporary file systems to upload the selected image file
  6. Check that there are no unsaved changes in any domains in the device
  7. Check that there are no quiesced domains in the device
  8.  Run the user's pre-script (if requested in the activity), the task will stop if the script return value is larger than 0
  9.  Issue a Quiesce domain/device SOMA (if requested for the activity
  10. Wait for the device or domain to finish quiescing. A timeout value may be specified for the Quiesce SOMA (see Configurable Parameters and Settings), 
    DPOD will cancel the task if the domain(s) are not yet quiesced 3 minutes after the specified timeout, and will issue an Unquiesce SOMA
  11. Restart the device (if requested for the activity
  12. After the device finished restarting, wait for the time that was defined in the activity's "Seconds to wait after restart" field
  13. DPOD will upload the firmware image to the monitored device
  14.  Issue a Quiesce domain/device SOMA - this step will always run, even if the user did not ask for a quiesce before the restart
  15. Once all the domains are quiesced - start the firmware upgrade
  16. Wait for the upgrade to finish,
    The maximum time that DPOD will wait for the upgrade to finish is defined in the activity's "Upgrade timeout in seconds" field,
  17. Run the user's post-task script (if requested in the activity

When all the plan's tasks completed execution, the post-plan script will be executed (if requested in the plan settings)


Firmware Upgrade Execution Results

The Plan Details page shows the 40 most recent plan execution results, 

The table outlines the following details for each plan execution

Column Name
Description
IDThe Plan Execution ID
Start TimeThe time the plan entered the execution queue
DevicesNumber of devices that were supposed to be upgraded. Both failed and successful upgrades are aggregated.
StatusThe current status of the plan
Successful TasksNumber of upgrade tasks that completed successfully for this plan execution
Failed TasksNumber of upgrade tasks that failed for this plan execution
Skipped TasksNumber of upgrade tasks that did not execute, e.g. because the device was not available
Error MessagePlan's Error message (If any)

*Click the red "Abort Pending Executions" to stop execution in status "WAITING_FOR_PRE_VALIDATION" that did not started yet.
**Click the status column to drill into the activities execution details page.


Column Name
Description
IDThe Activity Execution ID
Status TimeThe last time the status of the activity changed
Device PatternThe device name or pattern that was used for this firmware upgrade activity
Firmware ImageThe name of the image file selected for the upgrade
StatusThe current status of the activity
Successful Tasks

Number of upgrade tasks that completed successfully for this activity execution

Failed TasksNumber of upgrade tasks that failed for this activity execution
Skipped TasksNumber of upgrade tasks that were skipped for this activity execution


Click the status column to drill into the task execution details page

Column Name
Description
IDThe Task Execution ID
Status TimeThe last time the status of the task changed
Device Name

The Device being upgraded

Firmware BeforeThe firmware level of the device before the task run
Firmware After

The firmware level of the device after the task run or "Unchanged" if the device was not upgraded.
During the run, the column may show "Unchanged"
if a timeout occured while waiting the upgrade to complete, the column will show 'Unknown"

StatusThe current status of the task
Error MessageTask's Error message if any


Click the status column to drill into the downloaded files details page


IBM DataPower Operations Dashboard (DPOD) v1.0.16.0