IBM DataPower Operations Dashboard v1.0.21.x

Firmware Upgrade Plan

Owned by Assaf Cohen (Deactivated)
Last updated: Feb 17, 2020 by Amit Munwes
3 min read

A Firmware Upgrade Plan includes general parameters and definitions for the execution of the upgrade activities.

To create a new firmware upgrade plan, navigate to the Manage→ Maintenance→Firmware Upgrade menu and click on the button to add a new plan.


The system will display the "Add Firmware Upgrade Plan" page. Consult the screenshot and the table below in order to create a new firmware upgrade plan in the system.

Attribute

Mandatory?

Description

EnabledYesOnly enabled plans may be executed, a plan cannot be enabled if it does not contain any activities
NameYesA user friendly name for the plan, e.g. "UpgradeQA"
DescriptionNoA user friendly description for the plan, e.g. "Upgrade all QA devices to IDG7.5.1.2"
API ReferenceYesA reference that will be used to execute the plan via the Firmware Upgrade REST API.
This field is pre-populated with a unique value generated by DPOD, you may change this value.
ScheduleNo

When to schedule the plan. This field has no effect when the plan is not enabled.
Format is identical to the report scheduling format

Use Default Maint. WindowYes

Should this plan use the default maintenance window defined for the system parameters. (See Maintenance Configurable Parameters for more information)

Maintenance Window StartNo

When not using the system default maintenance window, this will be used as the plan's maintenance window start time in 24H, HH:MM format (e.g. 21:30)
Leave the maintenance window start and end fields empty to disable the maintenance window check (the plan will always be eligible to run)

Maintenance Window EndNo

When not using the system default maintenance window, this will be used as the plan's maintenance window end time in 24H, HH:MM format (e.g. 06:30)
Leave the maintenance window start and end fields empty to disable the maintenance window check (the plan will always be eligible to run)

Default Error PolicyYes

Halt - when a task failed validation or execution, stop all other tasks waiting for execution from this plan.

Ignore - when a task failed validation or execution, ignore and continue to run other tasks from this plan.

Pre-Plan ScriptNo

A user defined script to run before any of the tasks is executed.
The script will not run if the plan failed validation, e.g. when it is executed outside the maintenance window timeframe.
If the script fails (the return code was greater than 0) - the plan will fail too and its tasks will not be executed.

See user defined scripts for more information

Post-Plan ScriptNo

A user defined script to run after all the tasks finished executing.
The screen lets the user select whether to always execute this script or execute only when at least one task failed.

See user defined scripts for more information

Send to SyslogNoSend syslog messages for events generated by this plan- see publish firmware upgrade events via syslogs and email
Send EmailNoSend emails for events generated by this plan - see publish firmware upgrade events via syslogs and email

The Plan Details Page

Click the plan's name on the Firmware Upgrade Plans page to display the Plan's Details Page




The Plan Details page is composed of three parts:

  1. Plan Details - Displays the plan details, and lets the user Edit the plan, Delete it, or execute it in an ad-hoc manner (only for enabled plans)
  2. Activities - Add, Edit or Delete a firmware upgrade activity
  3. Recent Firmware Upgrade Plan Executions - Displays results for the most recent 40 executions of the plan - see Maintenance Plans Status Description for descriptions of the possible plan statuses


Copyright © 2015 MonTier Software (2015) Ltd.