IBM DataPower Operations Dashboard v1.0.13.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Backup Plan
- Assaf Cohen (Deactivated)
- Hanan Kenan
A Backup Plan includes general parameters and definitions for the execution of the backup activities.
To create a new backup plan, navigate to the Manage→ Maintenance→Backup menu and click on the button to add a new backup plan.
The system will display the "Add Backup Plan" page. Consult the screenshot and the table below in order to create a new backup 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. "BackupQA" |
| Description | No | A user-friendly description for the plan, e.g. "Backup all QA devices" |
| API Reference | Yes | A reference that will be used to execute the plan via the Backup REST API. This field is pre-populated with a unique value generated by DPOD, you may change this value. |
| Schedule | Yes (only for enabled plans) | When to schedule the backup. This field has no effect when the plan is not enabled. Format is identical to the report scheduling format |
| 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 validations 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 backup events via syslogs and email |
| Send Email | No | Send emails for events generated by this plan - see publish backup events via syslogs and email |
The Plan Details Page
Click the plan's name on the Backup 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)
- Backup Activities - Add, Edit or Delete a backup activity
- Recent Backup 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
