IBM DataPower Operations Dashboard v1.0.12.0

A newer version of this product documentation is available.

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

Sync Activity

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

A Sync Activity defines the target and the destination domains to be synced, pre/post actions and the error policy to use.

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

e


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

Sync Types

There are 3 types of destination/target pairs:

For all sync types - DPOD will NOT create any domains on the target devices, it is the admin's responsibility to create them.
If a target domain does not exist - the sync task will be skipped
  1. Domain Pattern - Enter source device name, source domain pattern and target device pattern.
    All the source domains matching the pattern will be synced to domains with identical names on the target device(s)
    For example:
    Source Device = QA1, Source Domain = Domain*, Target Device = QA2, QA3
    Results - the domain QA1/Domain1 will be synced to QA2/Domain1 and QA3/Domain1
                   the domain QA1/Domain2 will be synced to QA2/Domain2 and to QA3/Domain3
  2. Single Domain - Enter source device and domain names (no patterns) and the target device pattern and target domain name
    This will sync a single domain from the source to the same or different domain name on the target device(s)
    For example:
    Source Device = QA1, Source Domain = Domain1, Target Device = QA2, QA3, Target Domain = CopyDomain1
    Results - The domain QA1/Domain1 will be synced to QA2/CopyDomain1 and to QA3/CopyDomain1
  3. Device - Enter source device name and a target device pattern, all the domains from the source device will be synced to the target device(s)
    For Example:
    Source Device = PROD1, Target Device = DRP*
    Results - All the domains from device PROD1 will be synced to devices DRP_Active and DRP_Inactive


AttributeMandatory?Description
Sync TypeYesDomain Pattern, Single Domain or Device as explained above
Pre Validation - Skip Major Version CheckYes

Select to allow Syncing configuration from higher firmware major release (e.g. 7.5.2.0) to lower major release (e.g. 7.2.0.0)
Syncing from higher firmware major release to lower major release may cause features that were introduced in the later version not to work.

Pre Validations - Skip Gateway License Features and OptionsYesSelect to allow Syncing configuration between devices with non-identical licenses (e.g. the source device has B2B or SQL-ODBC license and the target device does not)
Pre Validations - Skip Device Type CheckYesSelect to allow Syncing configuration between higher device types to lower device types (e.g. IDG to XG-45 or XI-52 to XG-45)
Approve Object Creation in Source DeviceYesWhen both source and target devices firmware versions are 7.5.2.X+
In order to test that the password map alias in the source and target are identical - DPOD will need approval to create a temporary object in the source device
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 sync 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)

Deployment PolicyNoAn optional deployment policy from the source or target device, if the object is not found on the device, the sync task will not execute
Deployment Policy VariablesNoAn optional deployment policy variables object on the target device, if the object is not found on the target device, the sync task will not execute
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 Sync 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

Stop on Objects Deletion Error in Target DeviceYesBefore importing the object to the target domain, DPOD will first delete objects from the target domain - check this option to stop the import if deletion of those objects failed

Edit, Delete or Reorder Activities

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



IBM DataPower Operations Dashboard (DPOD) v1.0.12.0