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.

Backup Activity

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

A Backup Activity defines what should be backed-up, pre/post actions and the error policy to use.
There are two types of activities:

  1. Secure Backup
  2. Export domain

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

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

Secure Backup

AttributeIs Mandatory?Description
Device (or Pattern)YesThe Device(s) to backup, 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
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 the backup is executed.
The timeout value that is passed to the quiesce SOMA is controlled by a system parameter (see Maintenance Configurable Parameters for more information)

ActionYesSelect Secure Backup to define a secure backup activity. (Export Domain is described below)
Certificate NameYesThe certificate to use for the backup.
Click on the ... (Three dots) button to open a window that shows the available certificates on the device,
if multiple devices were chosen, the list will show the certificates of the first device. All other devices must have a certificate installed with an identical name to the one
selected for the first device.
Post-Action UnquiesceNoThis option cannot be edited - it will be automatically set to the value of the Pre-Action Quiesce.
The user may set how long DPOD waits for the unquiesce operation to finish before cancelling the task via a system parameter (see Maintenance Configurable Parameters for more information)
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 backup activity handles errors.
Plan's Default - Use the value that was set for the Backup 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


Export Domain

AttributeMandatory?Description
Device (or Pattern)YesThe device(s) to backup.
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
Domain (or Pattern)YesThe domain(s) to export.
Enter a specific domain, pattern with asterisk or a list of domains or patterns
See Using Patterns for Device and Domain Names in the Maintenance Concepts page

Check "All Domains" to export all domains.
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 domain(s) be quiesced before the backup is executed
The timeout value that is passed to the quiesce SOMA is controlled by a system parameter (see Maintenance Configurable Parameters for more information)

ActionYesExport Domain
Post-Action UnquiesceNoThis option cannot be edited - it will be automatically set to the value of the Pre-Action Quiesce.
The user may set how long DPOD waits for the unquiesce operation to finish before cancelling the task via a system parameter (see Maintenance Configurable Parameters for more information)
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 backup activity handles errors.
Plan's Default - Use the value that was set for the Backup 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


Edit, Delete or Reorder Activities

The Backup 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 Backup Execution for more information)

IBM DataPower Operations Dashboard (DPOD) v1.0.14.0