ndmp_start_notify.cmd script (Microsoft Windows)
When you use Windows NetBackup for NDMP media servers, you can create the batch scripts that provide notification whenever the client starts a backup. These scripts must reside on the media server in the following directory:
install_path\NetBackup\bin
where install_path is the directory where NetBackup is installed.
You can create ndmp_start_notify scripts that provide notification for all backups or only for backups of a specific policy or schedule. The ndmp_start_notify script runs each time a backup starts and after the tape is positioned.
To create a script that applies to all backups, name the script:
install_path\netbackup\bin\ndmp_start_notify.cmd
To create an ndmp_start_notify 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_notify.days.cmd
The following script applies only to a schedule that is named fulls, which is in a policy named days:
install_path\netbackup\bin\ndmp_start_notify.days.fulls.cmd
The first script affects the scheduled backups in the policy named days. The second script affects the scheduled backups in the policy named days only when the schedule is named fulls.
For a given backup, NetBackup calls only one ndmp_start_notify script and checks for them in the following order:
ndmp_start_notify.policy.schedule.cmd ndmp_start_notify.policy.cmd ndmp_start_notify.cmd
For example, if there are both ndmp_start_notify.policy.cmd and ndmp_start_notify.policy.schedule.cmd scripts, NetBackup uses only the ndmp_start_notify.policy.schedule.cmd script.
Note:
If you also use ndmp_end_notify scripts, they can provide a different level of notification than the ndmp_start_notify scripts. For example, if you had one of each, they could be ndmp_start_notify.policy.cmd and ndmp_end_notify.policy.schedule.cmd.
When the backup starts, NetBackup passes the following parameters to the script:
Table: Script parameters for ndmp_start_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 is always 0 for bpstart_notify. |
%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_NOTIFY_RES.policy.schedule If the script applies to a specific policy, the results file must be named install_path\NetBackup\bin\NDMP_START_NOTIFY_RES.policy If the script applies to all backups, the results file must be named install_path\NetBackup\bin\NDMP_START_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. |
The server expects the client to respond with a continue message within the period of time that the NetBackup CLIENT_READ_TIMEOUT option on the server specifies. The default is 300 seconds. If the script needs more than 300 seconds, increase the value to allow more time.