IBM DataPower Operations Dashboard v1.0.14.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Firmware Upgrade Plan
- Assaf Cohen (Deactivated)
- Amit Munwes
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 |
|---|---|---|
| Enabled | Yes | Only enabled plans may be executed, a plan cannot be enabled if it does not contain any activities |
| Name | Yes | A user friendly name for the plan, e.g. "UpgradeQA" |
| Description | No | A user friendly description for the plan, e.g. "Upgrade all QA devices to IDG7.5.1.2" |
| API Reference | Yes | A 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. |
| Schedule | No | When to schedule the plan. This field has no effect when the plan is not enabled. |
| Use Default Maint. Window | Yes | Should this plan use the default maintenance window defined for the system parameters. (See Maintenance Configurable Parameters for more information) |
| Maintenance Window Start | No | 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) |
| Maintenance Window End | No | 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) |
| Default Error Policy | Yes | 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 Script | No | A user defined script to run before any of the tasks is executed. See user defined scripts for more information |
| Post-Plan Script | No | A user defined script to run after all the tasks finished executing. See user defined scripts for more information |
| Send to Syslog | No | Send syslog messages for events generated by this plan- see publish firmware upgrade events via syslogs and email |
| Send Email | No | Send 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:
- 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)
- Activities - Add, Edit or Delete a firmware upgrade activity
- 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