bpend_notify.bat script (Windows clients)
For Windows clients, you can create batch scripts that provide notification whenever the client completes a backup or archive. These scripts must reside on the client and in the same directory as the NetBackup client binaries:
Install_path\NetBackup\bin\bpend_notify.bat
Install_path is the directory where NetBackup is installed.
You can create bpend_notify scripts that provide notification for all backups or for backups of a specific policy or schedule.
To create a bpend_notify script that applies to all backups, name the script bpend_notify.bat
To create a script that applies only to a specific policy or policy and schedule combination, add a .policyname or .policyname.schedulename suffix to the script name as follows:
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.
Note:
bpstart_notify scripts can provide a different level of notification than the bpend_notify scripts. For example, if you had one of each, they could be bpstart_notify.policy.bat and bpend_notify.policy.schedule.bat.
NetBackup passes the following parameters to the script when the backup completes:
%1 | Specifies the name of the client from the NetBackup catalog. |
%2 | Specifies the policy name from the NetBackup catalog. |
%3 | Specifies the schedule name from the NetBackup catalog. |
%4 | Specifies one of the following: FULL, INCR, CINC, UBAK, UARC |
%5 | Specifies the status of the operation. It is the same status as is sent to the NetBackup server. The status is 0 for successful backups and 1 for partially successful backups. If an error occurs, the status is the value associated with that error. |
%6 | Specifies the results file that NetBackup checks for a return code from the script. NetBackup uses %6 to pass the file name and then expects the script to create the file in the same directory as the script. If the script applies to a specific policy and schedule, the results file must be named Install_path\netbackup\bin\BPEND_RES.policy.schedule If the script applies to a specific policy, the results file must be named Install_path\netbackup\bin\BPEND_RES.policy If the script applies to all backups, the results file must be named Install_path\netbackup\bin\BPEND_RES An echo 0> %6 statement is one way for the script to create the file. NetBackup deletes the existing results file before it calls the script. After the script runs, NetBackup checks the new results file for the status. The status must be 0 for the script to be considered successful. If the results file does not exist, NetBackup assumes that the script was successful. |
The server expects the client to respond with a continue message within the time that the BPEND_TIMEOUT option specifies. The default for BPEND_TIMEOUT is 300. If the script needs more than 300 seconds, increase the value to allow more time.