Versions Compared

Key

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

The A Backup Plan includes general parameters and definitions for the execution of the backup activities.

Create To create a new backup plan from the Manage->Maintenance→Backup menu

Image Removed

The , navigate to the Manage→ Maintenance→Backup menu and click on the button to add a new backup plan.

Image Added

The system will display the "Add Backup Plan" page will show. Image Removed. Consult the screenshot and the table below in order to create a new backup plan in the system.

Image Added

AttributeIs Mandatory?Description
EnabledYesOnly enabled plans can may be executed, a plan cannot be enabled if it does not contain any activities
NameYesA user-friendly name for the plan - for example , e.g. "BackupQA"
DescriptionNoA user-friendly description for the plan - for example , e.g. "Backup all QA devices"
API ReferenceYesA reference that will be used to execute the plan via the maintenance Backup REST API, .
this This field is pre-populated with a unique value generated by DPOD, you can may change this value.
ScheduleYes (only for enabled plans)When to schedule the report (this backup. This field has no effect when the plan is not enabled), the format .
Format is identical to the report scheduling format
Use Default Maint. WindowYes

Should this plan take use the default maintenance window definition defined for the system parameters? . (see See maintenance configurable parameters for more information)

Maintenance Window StartNo

If you do not wish to use When not using the system default maintenance window - enter the , 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 always eligible to run)

Maintenance Window EndNo

If you do not wish to use When not using the system default maintenance window - enter the , 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 always eligible to run)

Default Error PolicyYes

Halt - when a task failed validations or execution, stop all other tasks waiting for execution from this plan that are waiting for execution.

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 are is executed.
The script will not run if the plan did not passed validations - for example, if it was failed validation, e.g. when it is executed outside the maintenance window timeframe.
If the script failed fails (the return code was greater than 0) - the plan will fail too and not its tasks will not be executed.

See user defined scripts for more information

Post-Plan ScriptNo

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

See user defined scripts for more information

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

The Plan Details Page

Click the plan's name on the Backup Plans page to display the Plan's Details Page

Image Added

The Plan Details page is composed of three parts:

  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. Backup Activities - Add, Edit or Delete a backup activity
  3. Recent Backup 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

Image Added