IBM DataPower Operations Dashboard v1.0.7.1

A newer version of this product documentation is available.

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

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Flow

General execution flow for a backup plan:

  1. Check if the system allows Backups to run - see Configurable Parameters and Settings to learn how to enable or disable all backups
  2. Check if the current system time is within the maintenance window timeframe that was defined for the plan
  3. Check if the backup store destination path is a mounted, remote, filesystem  see Configurable Parameters and Settings to learn how to set the destination path
  4. Check if there is enough space in the destination path for downloading and storing the backup - see Configurable Parameters and Settings to learn how to determine this check's threshold value
  5. Go over all the activities defined for the plan, and split them into executable tasks.
    For example, the plan have two activities, one to Secure Backup devices QA* and a second to export domain DOMAIN* on device TEST8 and on an unavailable device - TEST9,
    Six tasks will be created:
    a. Secure Backup task for device QA1
    b. Secure Backup task for device QA2
    c. Secure Backup task for device QA3
    d. Export Domain task for Device TEST8 and Domain DOMAIN1
    e. Export Domain task for Device TEST8 and Domain DOMAIN2
    f.  Since the device TEST9 is unavailable - an Export Domain task for Device TEST9 and domain DOMAIN* will be created with a "Skipped" status 
  6. If all the created tasks are in "Skipped" state (because the devices are not available, or because no devices or domains matched the input patterns) - the plan will stop
  7. If there are any tasks waiting to be executed - the Pre-Plan Script will be executed (if requested in the plan settings)
    the plan will stop if the script's return code is larger than 0


After the backup tasks are created they will start to execute, here is the general execution flow for a backup task:

The backup tasks will start to execute in the order they were created, which corresponds to the order which the activities were defined.
Two different tasks will not execute backup in parallel on the same device, even if they backup different domains

  1. Check if the current system time is within the maintenance window timeframe that was defined for the plan
  2. Check if there is enough space in the destination path for downloading and storing the files - see Configurable Parameters and Settings to lean how to determine the check threshold value
  3. If the backup is for a specific domain and quiesce was requested - check that the domain is not already quiesced
    If the backup is for an entire device and quiesce was requested - check that there are no quiesced domains in the device
  4. If Export Domain was requested - check that there are no unsaved changes in the requested domain(s),
    If there are any unsaved changes, two export domain backups will be taken - one for the persisted data and one for the unpersisted data.
  5. If Secure Backup was requested - check that there is enough space in the DataPower appliance to store the backup before downloading it to the user storage - see Configurable Parameters and Settings to learn how to determine this check's threshold value
  6.  Run the user's pre-script (if requested in the activity), the task will stop if the script return value was larger than 0
  7.  Issue a Quiesce domain/device SOMA (if requested in the activity
  8. Wait for the device or domain to finish quiescing. you can specify a timeout parameter for the Quiesce SOMA (see Configurable Parameters and Settings),
    DPOD will cancel the task if the domain(s) are not yet quiesced 3 minutes after the specified timeout and will issue an Unquiesce SOMA
  9. Perform the Secure Backup or Export Domain operation
  10. Unquiesce the device/domain (if it was previously quiesced by this task) 
  11. Wait for the device/domain to unquiesce,  you can specify a timeout value, 3 minutes after the timeout, DPOD will stop waiting for the unquiesce operation and will fail the task (the device's unquiesce operation will not be interrupted though)
  12. Run the user's post-task script (if requested in the activity

After all the plan's tasks finished to execute - the post-plan script will be executed (if requested in the plan settings)

Output Files

The backups will be downloaded and stored in the destination filesystem that was set by the user (see Configurable Parameters and Settings)

For secure backup, the destination path will be:
<user defined path> + /Device-Name/secure-backup/timestamp    
For example /data/backup/store/QA-device1/secure-backup/2017-06-26-22-48-00-000

For export domain (specific domain), the destination path will be:
<user defined path> + /Device-Name/domain/domain-name/domain-export-timestamp-isPersisted
For example /data/backup/store/QA-device1/domain/Domain1/Domain1-export-2017-06-26-22-48-00-000-persisted.zip

For export domain (all domains), the destination path will be:
<user defined path> + /Device-Name/domain/all-domains/all-domains-export-timestamp-isPersisted
For example /data/backup/store/QA-device1/all-domains/all-domains-export-2017-06-26-22-48-00-000-nonpersisted.zip

Backup Execution Results

The Plan Details page shows the last 40 plan execution results, 

The table outlines the following details for each plan execution

Column NameDescription
IDThe Plan Execution ID
Start TimeWhen the plan was entered the execution queue
DevicesHow many devices were supposed to be backed-up, both failed and successful backups are counted
DomainsHow many domains were supposed to be backed-up, both failed and successful backups are counted. (for secure backup and export all domains -no domains are counted)
StatusThe current status of the plan
Successful TasksHow many backup tasks completed successfully for this plan execution
Failed TasksHow many backup tasks failed for this plan execution
Skipped TasksHow many backup tasks did not execute, for example, because the device was not available
Error MessagePlan's Error message if any


Click the status column to drill into the activities execution details page


Column NameDescription
IDThe Activity Execution ID
Status TimeWhen was the last time the status of the activity changed
Device PatternThe device name or pattern that was selected for this backup activity
Domain PatternThe domain name or pattern that was selected for this backup activity
ActionSECURE_BACKUP or EXPORT_DOMAIN
StatusThe current status of the activity
Successful TasksHow many backup tasks completed successfully for this activity execution
Failed TasksHow many backup tasks failed for this activity execution
Skipped TasksHow many backup tasks were skipped for this activity execution


Click the status column to drill into the task execution details page

Column NameDescription
IDThe Task Execution ID
Status TimeWhen was the last time the status of the task changed
Device NameThe Device being backed-up
Domain NameThe Domain being backed-up or "all-domains" for Secure Backup/Export Domain for all domains
Files D/LHow many files were downloaded to the user's storage
D/L ErrorsNumber of download errors
StatusThe current status of the task
Error MessageTask's Error message if any


Click the status column to drill into the downloaded files details page

The downloaded files page shows information about the backup operation, such as the device firmware version, device type, device build, etc; and a list of all files that were downloaded to the user's storage


  • No labels