Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attribute

Mandatory?

Description

EnabledYesOnly enabled plans may be executed, a plan cannot be enabled if it does not contain any activities
NameYesA user friendly name for the plan, e.g. "SyncQA"
DescriptionNoA user friendly description for the plan, e.g. "Sync all QA2 device with QA1"
API ReferenceYesA reference that will be used to execute the plan via the Sync REST API.
This field is pre-populated with a unique value generated by DPOD, you may change this value.
ScheduleYes
(only for enabled plans)

When to schedule the sync plan. This field has no effect when the plan is not enabled.
Format is identical to the report scheduling format

Info

For scheduled executions - DPOD checks if the source domain was changed since the last time it was synced to the target domain.
If no changes were detected, the sync will not commence.


Use Default Maint. WindowYes

Should this plan use the default maintenance window defined for the system parameters. (See maintenance configurable parametersMaintenance Configurable Parameters for more information)

Maintenance Window StartNo

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)
Leave the maintenance window start and end fields empty to disable the maintenance window check (the plan will always be eligible to run)

Maintenance Window EndNo

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)
Leave the maintenance window start and end fields empty to disable the maintenance window check (the plan will always be eligible to run)

Default Error PolicyYes

Halt - when a task failed validation 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 ScriptNo

A user defined script to run before any of the tasks is executed.
The script will not run if the plan failed validation, e.g. when it is executed outside the maintenance window timeframe.
If the script fails (the return code was greater than 0) - the plan will fail too and its tasks will not be executed.

See user defined scriptsUser Defined Scripts for more information

Post-Plan ScriptNo

A user defined script to run after all the tasks finished executing.
The screen lets the user select whether to always execute this script or execute only when at least one task failed.

See user defined scriptsUser Defined Scripts for more information

Parallel TasksNo

Allow multiple sync tasks to run in parallel on the same device

Warning

Enabling this feature can cause extreme load on the appliance and may fail the sync process and the running transactions on the device.


Send to SyslogNoSend syslog messages for events generated by this plan- see publish sync events via syslogs and email
Send EmailNoSend emails for events generated by this plan - see publish sync events via syslogs and email

...

  1. 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)
  2. Sync Activities - Add, Edit or Delete a sync activity
  3. Recent Sync 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

...