How to use bpstart and bpend notify scripts

Problem

This is a basic how to on the use of bpstart and bpend notify scripts.

Solution

Symantec NetBackup ™ comes packaged with a number of script files that provide information on the different stages of backup jobs and other aspects of its functionality. 
The bulk of the .cmd\.bat script files can be found on the NetBackup master server in the <install_path>\VERITAS\NetBackup\bin directory.

Additional .cmd\.bat files can be found in the <install_path>\VERITAS\NetBackup\bin\goodies directory.

For these files to work, they must reside in the <install_path>\VERITAS\NetBackup\bin directory. For the files in the \goodies directory, the original files should be copied to the \bin directory.

Note: Symantec does not support any scripts that are modified from the default NetBackup script provided. The scripts listed can be adapted to provide an added service to the NetBackup program, however, these modifications will not be supported, and a default copy of the script must be available at all times to aid troubleshooting problems.

Scripts:

\netbackup\bin\goodies\bpstart_notify.bat

– This script is called when bpbkar is started for a client backup.
– This script receives six parameters:

%1 = CLIENT_NAME
%2 = POLICY_NAME 
%3 = SCHEDULE_NAME 
%4 = SCHEDULE_TYPE, one of the following: FULL, INCR, CINC, UBAK, UARC
%5 = STATUS, always 0
%6 = RESULT_FILE

\netbackup\bin\goodies\bpend_notify.bat

– This script is called when bpbkar is finished with a backup job.
– During an archive this script is called after the backup is complete and before the files are deleted.
– This script receives six parameters:

%1 = CLIENT_NAME 
%2 = POLICY_NAME 
%3 = SCHEDULE_NAME 
%4 = SCHEDULE_TYPE, one of the following: FULL, INCR, CINC, UBAK, UARC
%5 = Status of backup
%6 = RESULT_FILE

The following are examples of bpstart_notify script names:

* The following script applies only to a policy named days:

* Any 'notify' scripts need to be moved into the <install path>netbackup\bin (win) or /usr/openv/netbackup/bin (unix) for them to be found and executed.

Note: The return status from the script is checked. Any non-zero status returned from your script will result in a failed job.

\install_path\netbackup\bin\bpstart_notify.days.bat

* The following script applies only to a schedule that is named fulls in a policy named days:

\install_path\netbackup\bin\bpstart_notify.days.fulls.bat

The bpstart_notify script also runs for NetBackup catalog backups if a .policyname[.schedule] is not specified.

The first script affects all scheduled backups in the policy named days.
The second script affects scheduled backups in the policy named days only when the schedule is named fulls.

For a given backup, NetBackup calls only one bpstart_notify script and checks for them in the following order:

bpstart_notify.policy.schedule.bat
bpstart_notify.policy.bat
bpstart_notify.bat
 

The following are examples of bpstart_notify script names:

* The following script applies only to a policy named days:

\install_path\netbackup\bin\bpend_notify.days.bat

* The following script applies only to a schedule that is named fulls in a policy named days:

\install_path\netbackup\bin\bpend_notify.days.fulls.bat

Note: The bpend_notify script also runs for NetBackup catalog backups if a .policyname[.schedule] is not specified.

The first script affects all scheduled backups in the policy named days.
The second script affects scheduled backups in the policy named days only when the schedule is named fulls.

For a given backup, NetBackup calls only one bpend_notify script and checks for them in the following order:

bpend_notify.policy.schedule.bat
bpend_notify.policy.bat
bpend_notify.bat

For example, if there are both bpend_notify.policy.bat and bpend_notify.policy.schedule.bat scripts, NetBackup uses only bpend_notify.policy.schedule.bat.

Please refer to the NetBackup Administration Guide Volume I and Volume II for complete details.