ndmp_start_path_notify.cmd script (Microsoft Windows)
For Windows media servers, you can create the batch scripts that provide notification before the backup process is issued to the NAS machine. These scripts must reside on the media server in the same directory as the NetBackup binaries:
install_path\NetBackup\bin
where install_path is the directory where NetBackup is installed.
You can create ndmp_start_path_notify scripts that provide notification for all backups or only for backups of a specific policy or schedule.
To create an ndmp_start_path_notify script that applies to all backups, name the script:
install_path\netbackup\bin\ndmp_start_path_notify.cmd
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. The following are two examples:
The following script applies only to a policy named days:
install_path\netbackup\bin\ndmp_start_path_notify.days.cmd
The following script applies only to a schedule that is named fulls, which in a policy named days:
install_path\netbackup\bin\ndmp_start_path_notify.days.fulls.cmd
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 ndmp_start_path_notify script and checks for them in the following order:
ndmp_start_path_notify.policy.schedule.cmd ndmp_start_path_notify.policy.cmd ndmp_start_path_notify.cmd
For example, if there are both ndmp_start_path_notify.policy.cmd and ndmp_start_path_notify.policy.schedule.cmd scripts, NetBackup uses only ndmp_start_path_notify.policy.schedule.cmd.
Note:
If you also use ndmp_start_notify scripts, they can provide a different level of notification than the ndmp_start_path_notify scripts. For example, if you had one of each, they could be ndmp_start_notify.policy.cmd and ndmp_start_path_notify.policy.schedule.cmd.
When the backup starts, NetBackup passes the following parameters to the script:
Table: Script parameters for ndmp_start_path_notify.cmd (Microsoft Windows)
Parameter | Description |
|---|---|
%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 |
%5 | Specifies the status of the operation. It is the same as the status sent to the NetBackup server. This 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\NDMP_START_PATH_NOTIFY_RES.policy.schedule If the script applies to a specific policy, the results file must be named install_path\NetBackup\bin\NDMP_START_PATH_NOTIFY_RES.policy If the script applies to all backups, the results file must be named install_path\NetBackup\bin\NDMP_START_PATH_NOTIFY_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. |
%7 | Pathname being backed up. |