IBM DataPower Operations Dashboard v1.0.10.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
Sync Execution (Tasks)
This page describes how DPOD prepares the execution flow of a sync plan (using tasks) and subsequently - how the tasks themselves are executed
Task Creation Flow
General execution flow for a sync plan:
- Verify that the system allows Syncs to run. (See Configurable Parameters and Settings to learn how to enable or disable all sync activities)
- Verify that the current system time is within the maintenance window timeframe defined for the plan
- Iterate over all the activities defined for the plan, and split them into executable tasks.
For example: consider a plan with two activities, one to sync device PROD1 to DR1 and a second to sync domain pattern with source device = PROD1, source domain = Flight* and target device = PROD2
DPOD will create eight tasks:
a. Export task for source device/domain PROD1/Domain1
b. Import task for target device/domain DR1/Domain1
c. Import task for target device/domain DR1/Domain2
d. Import task for target device/domain DR1/Domain3
e. Export task for source device/domain PROD1/Flight1
f. Import task for target device/domain PROD2/Flight1
g. Export task for source device/domain PROD1/Flight2
h. Import task for target device/domain PROD2/Flight2 - 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
- 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.
Task Execution Flow
After the sync tasks are created, they will start to execute. The following is the general execution flow for a sync task:
Two different tasks will not execute concurrent syncs on the same device, unless the option "Allow multiple sync tasks to run in parallel" was checked in the plan definition
- Verify that the current system time is within the maintenance window timeframe defined for the plan.
- Verify that both source and target devices' firmware levels are above 7.1.0.0
- If a deployment policy was specified in the sync activity definition - ensure it exists
- If a deployment policy variables object was specified in the sync activity definition - ensure it exists
- Check that the source and target device type match (IDG > XB-62 > XI-52 > XG-45) - you can turn this check off in the sync activity definition
- Check that the source device major firmware level is lower or equal to the target device major firmware level - you can turn this check off in the sync activity definition
- Check that the target device contains the same licenses/features of the source device (e.g. B2B, SQL-ODBC, Tibco-ESM) - you can turn this check off in the sync activity definition
- If both source and target devices have firmware level above 7.5.2.4, DPOD will try to check if the passphrase in both source and target match, and will stop the sync process if they do not.
If one of the source or target devices' firmware is below level 7.5.2.4, DPOD will not sync any password map/alias objects - Export the source domain's configuration
- If pre-quiesce was requested - check that the domain is not already quiesced
- Run the user's pre-script (if requested in the activity), the task will stop if the script return value is larger than 0
- Issue a Quiesce domain/device SOMA (if requested in the activity)
- Wait for the device or domain to finish quiescing. A timeout value may be specified 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 - Perform an Import Dry-run to try and detect any errors before the actual Import
- Delete objects on the target domain (DPOD does not use "reset domain" in order to retain the passwords on the target domains) -
The following object types will be deleted:- WSGateway
- MultiProtocolGateway
- XMLFirewallService
- SSLProxyService
- HTTPService
- B2BGateway
- TCPProxyService
- WebTokenService
- WebAppFW
- XSLProxyService
- CloudGatewayService
- SQLDataSource
- MQQMGroup
- MQQM
- ISAMReverseProxy
- TibcoEMSServer
- LoadBalancerGroup
- WebSphereJMSServer
Import the configuration into the target domain
- Save config on the target domain
- Unquiesce the device/domain (if it was previously quiesced by this task)
- Wait for the device/domain to unquiesce. A timeout value may be specified for this operation. 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)
- Run the user's post-task script (if requested in the activity)
When all the plan's tasks completed execution, the post-plan script will be executed (if requested in the plan settings).
Sync Execution Results
The Plan Details page shows the 40 most recent plan execution results
The following table outlines the details for each column in the plan execution table
Column Name | Description |
---|---|
ID | The Plan Execution ID |
Start Time | The time the plan entered the execution queue |
Devices | Number of devices that were supposed to be synced. Both failed and successful syncs are aggregated. |
Domains | Number of domains that were supposed to be synced. Both failed and successful syncs are aggregated. |
Status | The current status of the plan |
Successful Tasks | Number of sync tasks that completed successfully for this plan execution |
Failed Tasks | Number of sync tasks that failed for this plan execution |
Skipped Tasks | Number of sync tasks that did not execute, e.g. because the device was not available |
Error Message | Plan's Error message (If any) |
*Click the red "Abort Pending Executions" to stop execution in status "WAITING_FOR_PRE_VALIDATION" that did not started yet.
**Click the status column to drill into the plan execution details page.
Column Name | Description |
---|---|
ID | The Activity Execution ID |
Status Time | The last time the status of the activity changed |
Source Device Name | The source device name |
Source Domain Pattern | The source domain name or pattern |
Target Device Pattern | The target device name or pattern |
Target Domain Pattern | The target domain name or pattern |
Status | The current status of the activity |
Successful Tasks | Number of backup tasks that completed successfully for this activity execution |
Failed Tasks | Number of backup tasks that failed for this activity execution |
Skipped Tasks | Number of backup tasks that were skipped for this activity execution |
Click the status column to drill into the activity execution details page
Column Name | Description |
---|---|
ID | The Task Execution ID |
Status Time | The last time the status of the task changed |
Source Device Name | The source device name |
Source Domain Name | The source domain name |
Target Device Name | The target device name |
Target Domain Name | The target domain name |
Action | EXPORT or IMPORT |
Status | The current status of the task |
Error Message | Task's Error message if any |
Click the status column to drill into the task execution results page, this page will display the Import SOMA result for the task (if an Import was actually performed)