bpstart_notify script (UNIX clients)
On UNIX clients, NetBackup calls the bpstart_notify script each time the client starts a backup or an archive.
Note:
Ensure that others can run this script on the client before it's used. To do so, run chmod ugo+rx script_name, where script_name is the name of the script.
To use this script, copy the following file from the server:
/usr/openv/netbackup/bin/goodies/bpstart_notify
Then place the script in the following location on the UNIX client:
/usr/openv/netbackup/bin/
Modify the script and ensure that you have permission to run the script.
The bpstart_notify script runs each time a backup or an archive starts and initialization is completed. The script runs before the tape is positioned. This script must exit with a status of 0 for the calling program to continue and for the backup or archive to proceed. A nonzero status causes the client backup or archive to exit with a status of bpstart_notify failed.
If the /usr/openv/netbackup/bin/bpstart_notify script exists, it runs in the foreground. The bpbkar process on the client waits for the script to complete before it continues. Any commands in the script that do not end with an ampersand character (&) run serially.
The server expects the client to respond with a continue message within the time that the BPSTART_TIMEOUT option specifies on the server. The default for BPSTART_TIMEOUT is 300 seconds. If the script needs more time than 300 seconds, increase the value to allow more time. (The BPSTART_TIMEOUT option corresponds to the Backup start notify timeout on the host properties.)
Note:
NetBackup passes the following parameters to the script:
clientname | Specifies the name of the client from the NetBackup catalog. |
policyname | Specifies the policy name from the NetBackup catalog. |
schedname | Specifies the schedule name from the NetBackup catalog. |
schedtype | Specifies one of the following: FULL, INCR (differential incremental), CINC (cumulative incremental), UBAK, UARC |
Note:
The bpstart_notify script also runs for NetBackup catalog backups if a .policyname[.schedule] is not specified.
For example:
bpstart_notify client1 pol_cd4000s sched_fulls FULL bpstart_notify client2 pol_cd4000s sched_incrementals INCR bpstart_notify client3 pol_cd4000s sched_fulls FULL bpstart_notify client4 pol_cd4000s sched_user_backups UBAK bpstart_notify client5 pol_cd4000s sched_user_archive UARC
To create a bpstart_notify script for a specific policy or policy and schedule combination, create script files with a .policyname or .policyname.schedulename suffix. The following are two examples of script names for a policy (production) that has a schedule (fulls):
/usr/openv/netbackup/bin/bpstart_notify.production /usr/openv/netbackup/bin/bpstart_notify.production.fulls
The first script affects all scheduled backups in the policy that are 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 bpstart_notify script and that is the script with the most specific name. For example, if there are both bpstart_notify.production and bpstart_notify.production.fulls scripts, NetBackup uses only bpstart_notify.production.fulls.
The bpstart_notify script can use the following environment variables:
BACKUPID UNIXBACKUPTIME BACKUPTIME
The NetBackup bpbkar process creates these variables. The following are examples of the strings that are available to the script to use to record information about a backup:
BACKUPID=client1_0857340526 UNIXBACKUPTIME=0857340526 BACKUPTIME=Sun Mar 2 16:08:46 2016
In addition, the following environment variables can be used to support multiple data streams.
Table: Environment variables used to support multiple data streams
Environment variable | Description |
|---|---|
STREAM_NUMBER | Specifies the stream number. The first stream from a policy, client, and schedule is 1. A 0 value indicates that multiple data streams are not enabled. |
STREAM_COUNT | Specifies the total number of streams to be generated from this policy, client, and schedule. |
STREAM_PID | Specifies the PID (process ID) number of bpbkar. |
RESTARTED | Specifies the checkpointed restarts or checkpointed backup jobs. A value of 0 indicates that the job was not resumed. (For example, upon first initiation.) A value of 1 indicates that the job was resumed. |