ndmp_start_notify script (UNIX)
The UNIX scripts are provided as examples only. You must customize the scripts before using them. For example, the -ne value in the first if statement must be modified to reflect the number of passed parameters. For the ndmp_start_notify script, the -ne value must be set to 7.
On the UNIX media server, NetBackup calls the ndmp_start_notify script each time the client starts a backup operation. To use this script, create a script similar to
/usr/openv/netbackup/bin/goodies/bpstart_notify
on the server, and copy it to
/usr/openv/netbackup/bin/ndmp_start_notify
on the UNIX NetBackup for NDMP server. Then, modify the script and ensure that you have permission to run it.
Note:
Before you use this script, make sure that you can run it by using other on the media server. Run chmod 755 script_name, where script_name is the name of the script.
The ndmp_start_notify script runs each time a backup starts and after the tape has been positioned. This script must exit with a status of 0 for the calling program to continue and for the backup to proceed. A nonzero status causes the client backup to exit with a status of ndmp_start_notify failed.
If the /usr/openv/netbackup/bin/ndmp_start_notify script exists, it runs in the foreground. The bptm process that is on the NetBackup for NDMP server waits for it to complete before continuing. Any commands in the script that do not end with an & character run serially.
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 for CLIENT_READ_TIMEOUT is 300. If the script needs more time than 300 seconds, increase the value to allow more time.
NetBackup passes the following parameters to the script:
Table: Script parameters for ndmp_start_notify (UNIX)
Parameter | Description |
|---|---|
$1 | Specifies the name of the NDMP host. |
$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 (differential incremental) CINC (cumulative incremental) |
$5 | Specifies the NetBackup status code for the operation. |
For example:
ndmp_start_notify freddie cd4000s fulls FULL 0 ndmp_start_notify danr cd4000s incrementals INCR 0 ndmp_start_notify hare cd4000s fulls FULL 0
To create an ndmp_start_notify script for a specific policy or policy and schedule combination, create script files with a .policyname or .policyname.schedulename suffix. In the following two examples of script names, the policy is named production and the schedule is named fulls:
/usr/openv/netbackup/bin/ndmp_start_notify.production /usr/openv/netbackup/bin/ndmp_start_notify.production.fulls
The first script affects all scheduled backups in the policy that is named production. The second script affects scheduled backups in the policy that is named production only when the schedule is named fulls.
Note:
For a given backup, NetBackup uses only one ndmp_start_notify script and that is the one with the most specific name. For example, if there are both ndmp_start_notify.production and ndmp_start_notify.production.fulls scripts, NetBackup uses only ndmp_start_notify.production.fulls.
The ndmp_start_notify script can use the following environment variables:
BACKUPID UNIXBACKUPTIME BACKUPTIME
The NetBackup bptm process creates these variables. The following are examples of the strings that are available to the script for use in recording information about a backup:
BACKUPID=freddie_0857340526 UNIXBACKUPTIME=0857340526 BACKUPTIME=Sun Mar 2 16:08:46 1997