...
| Attribute | Is Mandatory? | Description |
|---|---|---|
| Enabled | Yes | Only enabled plans can be executed, a plan cannot be enabled if it does not contain any activities |
| Name | Yes | A user friendly name for the plan - for example "BackupQA" |
| Description | No | A user friendly description for the plan - for example "Backup all QA devices" |
| API Reference | Yes | A reference that will be used to execute the plan via the maintenance REST API, this field is pre-populated with a unique value generated by DPOD, you can may change this value. |
| Schedule | Yes (only for enabled plans) | When to schedule the report (this field has no effect when the plan is not enabled), the format is identical to the report scheduling format |
| Use Default Maint. Window | Yes | Should this plan take the maintenance window definition for the system parameters? (see maintenance configurable parameters for more information) |
| Maintenance Window Start | No | If you do not wish to use the system default maintenance window - enter the maintenance window start time in HH:MM format (e.g. 21:30) |
| Maintenance Window End | No | If you do not wish to use the system default maintenance window - enter the maintenance window end time in HH:MM format (e.g. 06:30) |
| Default Error Policy | Yes | Halt - when a task failed validations or execution, stop all other tasks from this plan that are waiting for execution |
| Pre-Plan Script | No | A user defined script to run before any tasks are executed. See user defined scripts for more information |
| Post-Plan Script | No | A user defined script to run after all the tasks finished executing. See user defined scripts for more information |
| Send to Syslog | No | Send syslog messages about for events generated by this plan- see publish backup events via syslogs and email |
| Send Email | No | Send emails about for events generated by this plan - see publish backup events via syslogs and email |
...