DPOD allows execution of user defined, custom scripts before and after both Plan and Task execution.
The scripts are executed from /app/custom/scripts (See Configurable Parameters and Settings for information on how to change this path)
Any script that returns a return code larger than 0 is considered to have failed.
if a pre-plan or a pre-task script failed - the plan or task will be flagged as failed and will not execute.
If a pre-task script failed, the post-task script will still be executed (if requested)
DPOD will send certain parameters to the script, to indicate the execution details and completion status.
Parameters Sent to the Backup Pre-Plan Script
Sample script: /app/custom/scripts/backup_pre_plan_sample.sh
1=PLAN_TYPE - The constant "BACKUP-PLAN"
2=PLAN_STAGE - The constant "PRE"
3=PLAN_ID - The ID of the backup plan
3=PLAN_NAME - The name of the backup plan
Example:
1=BACKUP-PLAN
2=PRE
3=16
4=backup1
Parameters Sent to the Backup Post-Plan Script
Sample script: /app/custom/scripts/backup_post_plan_sample.sh
1=PLAN_TYPE - The constant "BACKUP-PLAN"
2=PLAN_STAGE - The constant "POST"
3=PLAN_ID - The ID of the backup plan
4=PLAN_NAME - The name of the backup plan
5=FINAL_STATUS_CODE - Final status code of the backup plan
6=FINAL_ERROR_MSG - Final error message of the backup plan, or "NONE" if there were no errors
7=FFU1 - The constant "FFU" (For future use)
8=FFU2 - The constant "FFU" (For future use)
9=TASKS_VALUES - list of comma separated values for each task - task ID, backup action, device, domain, task status - different tasks are separated with ~ (Tilde sign)
Example:
1=BACKUP-PLAN
2=POST
3=16
4=backup1
5=SUCCESS
6=NONE
7=FFU
8=FFU
9=13,exportDomain,IDG-MonTierQA-2,CarRentA_Domain,SUCCESS~14,exportDomain,IDG-QA-2,CarRentB_Domain,SUCCESS
Parameters Sent to the Backup Pre-Task Script
Sample script: /app/custom/scripts/backup_pre_task_sample.sh
1=TASK_TYPE - The constant "BACKUP-TASK"
2=TASK_STAGE - The constant "PRE"
3=TASK_ID - The ID of the backup task
4=PLAN_NAME - The name of the backup plan that generated this task
5=BACKUP_ACTION - The action that the backup task is going to perform: One of "exportDomain" or "secureBackup"
6=DEVICE_NAME - The name of the device that will be backed-up by the task (or contains the domain to be backed-up)
7=DEVICE_HOST - The host of the device that will backed-up by the task (or contains the domain to be backed-up)
8=SOMA_PORT - The soma port of the device
9=DOMAIN - The name of the domain that will be backed-up by the task, or the constant "ALL" in case of secureBackup
Example:
1=BACKUP-TASK
2=PRE
3=12
4=backup1
5=exportDomain
6=IDG-QA-2
7=192.168.72.100
8=5550
9=CarRentalA_Domain
Parameters Sent to the Backup Post-Task Script
Sample script: /app/custom/scripts/backup_post_task_sample.sh
1=TASK_TYPE - The constant "BACKUP-TASK"
2=TASK_STAGE - The constant "POST"
3=TASK_ID - The ID of the backup task
4=PLAN_NAME - The name of the backup plan that generated this task
5=FINAL_STATUS - Final status code of the backup task
6=FINAL_ERROR_MSG - Final error message of the backup task, or "NONE" if there were no errors
7=FFU1 - The constant "FFU" (For future use)
8=FFU2 - The constant "FFU" (For future use)
9=BACKUP_ACTION - The action that the backup task performed. One of "exportDomain" or "secureBackup"
10=DEVICE_NAME - The name of the device that was backed-up by the task (or contains the domain that was backed-up)
11=DEVICE_HOST - The host of the device that was backed-up by the task (or contains the domain that was backed-up)
12=SOMA_PORT - The soma port of the device
13=DOMAIN - The name of the domain that was backed-up by the task, or the constant "ALL" in case of secureBackup
14=DOWNLOADED_FILES - comma separated list of downloaded backup files (full path) or the constant "NONE"
Example:
1=BACKUP-TASK
2=POST
3=13
4=backup1
5=SUCCESS
6=NONE
7=FFU
8=FFU
9=exportDomain
10=IDG-QA-2
11=192.168.72.100
12=5550
13=CarRentA_Domain
14=/data/backups/store/IDG-QA-2/domain/CarRentA_Domain/CarRentA_Domain-export-2017-06-20-19-26-45-229-persisted.zip