IBM DataPower Operations Dashboard v1.0.20.x

A newer version of this product documentation is available.

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

Firmware Upgrade Activity

Owned by Assaf Cohen (Deactivated)
Last updated: Jan 13, 2021 by Amit Munwes
4 min read

A Firmware Upgrade Activity defines which devices should be upgraded, to which versions, the pre/post actions and the error policy to use.

To add a new firmware upgrade activity, navigate to Mange→ Maintenance→ Firmware Upgrade, select the plan to add an activity to and click "Add Activity" from the Firmware Upgrade Plan Details Page.

The system will display "Add Firmware Upgrade Activity" page. Consult the screenshot and the table below in order to create a new activity in the system.

Uploading Firmware Image File to DPOD

Before DPOD can use a firmware image, it needs to be uploaded into the DPOD's path that was defined in the System Parameter "Firmware Upgrade - Repository Path".

You can use SCP/WinSCP or any other file transfer program to upload the file.

Add Activity Page

Attribute
Is Mandatory?
Description
Device (or Pattern)YesThe device(s) to upgrade. Enter a specific device, pattern with asterisk or a list of devices or patterns.
See Using Patterns for Device and Domain Names in the Maintenance Concepts page.
Don't check version downgradeNo

By default, firmware downgrade is not supported (for example, from 7.5.1.5 back to 7.5.1.3).
This option disables this validation, and allows to proceed using the provided firmware no matter what its version is.

Allow Features IncompatibilityNo

Allows to upload a firmware image file that is missing features that are found on the device (Tibco-EMS and DCO-Oracle).
Uploading an image that contains features that are not found in the device is not supported.

Pre-Action ScriptNo

A user defined script to run before the task is executed.
The task will not be executed If the script fails (the return code was greater than 0).
See user defined scripts for more information

Pre-Action QuiesceNo

Should the device(s) be quiesced before it is restarted.
The timeout value that is passed to the quiesce SOMA is controlled by a system parameter (see Maintenance Configurable Parametersfor more information)

The device(s) will be always quiesced before the upgrade is executed, whether or not you checked this option
This option only controls the quiesce that happens before the optional restart.
Pre-Action RestartNo

Should the device(s) be restarted before the upgrade starts.

Restarting the device before firmware upgrade is recommended

Seconds to wait after restart

Yes

(if restart requested)

How long (in seconds) to wait after restart and before issuing the quiesce request and upgrading the firmware.
This parameter is used for situations where the monitored device does not enter "ready" state immediately after device restate.
Pre-Action QuiesceYesAlways checked, this option cannot be changed.
The device will be quiesced before the upgrade starts.
The timeout value that is passed to the quiesce SOMA is controlled by a system parameter (see Maintenance Configurable Parameters for more information)
Image FileYesThe firmware image file, only scrypt3, scrypt4 and tar.gz types are supported
Click the Three dots button to open the file selection window, the window will show all image files that were found in the Repository path (see "Firmware Upgrade - Repository Path")
If a new file was just uploaded, close and re-open the window to refresh the list.
Upgrade timeout in secondsYesHow long to wait before DPOD will mark the upgrade execution as failed.
For example, if DPOD did not receive any response from the upgraded device after 30 minutes, it will mark the execution as failed, so a syslog/email will be sent.
Post-Action UnquiesceNo

Always checked, this option cannot be changed.
If the device was upgraded successfully, the upgrade process will restart the device, causing it to start unquiesced.
If the upgrade failed, DPOD will automatically unquiesce the device.

Post-Action ScriptNo

A user defined script to run after the task is executed.
The user selects whether the script should run always when a task completes, or only when the task execution fails.
See user defined scripts for more information.

Error PolicyYes

Select how this activity handles errors.
Plan's Default - Use the value that was set for the plan.
Halt - When the task failed validation or execution, stop all other tasks from this plan that are waiting for execution.
Ignore - When the task failed validation or execution, ignore and continue to run other tasks from this plan.

Accept LicenseYesAccept IBM's license is needed before firmware upgrade.


Edit, Delete or Reorder Activities

The Firmware Upgrade Plan Details Page allows the user to edit, delete or reorder activities.

When the plan is scheduled to run, the activities will be processed in the order they were defined (see Firmware Upgrade Execution for more information)

Copyright © 2015 MonTier Software (2015) Ltd.