SYNOPSIS

       /usr/openv/netbackup/bin/bpbackup  [-p  policy]  [-s schedule] [-S master_server
              [,master_server,...]]  [-t  policy_type]  [-L  progress_log  [-en]]   [-w
              [hh:mm:ss]] [-help] [-k "keyword_phrase"] -f listfile | filenames

       /usr/openv/netbackup/bin/bpbackup -i [-p policy] [-h hostname] [-s schedule] [-S
              master_server [,master_server,...]]  [-t  policy_type]  [-L  progress_log
              [-en]] [-w [hh:mm:ss]] [-k "keyword_phrase"]

       /usr/openv/netbackup/bin/bpbackup -dssu storage unit name


DESCRIPTION

       bpbackup starts either of the following processes:

       On clients

       Using the first form of the command above, bpbackup starts a user backup that is
       the equivalent to what is performed by using the interface on the  client.  This
       type  of  backup  can  be  started from any NetBackup client in order to back up
       files from that client.

       The bpbackup command processes the files that you list on the command line or in
       the file that you specify with the -f listfile option. A file path can be a file
       or directory name. If the named files include a directory, bpbackup backs up all
       files and subdirectories of that directory starting at the directory itself.

       On master servers

       Using  the second form of the command shown above, bpbackup starts an immediate-
       manual backup of a client. This variation requires the -i option on the bpbackup
       command  and  is available only to the administrator on the master server. It is
       the equivalent of starting a manual backup from  the  NetBackup  administrator's
       interface. Use the -h option to specify the host.

       Since  progress  logs  are  written  only on clients, and since this form of the
       bpbackup command is run from the master server only, the -L option is undefined.

       The following restrictions apply to this command:

             You  must  be the owner of the file or an administrator to back up a file
              with bpbackup.

             You can back up files and directories owned by other users  if  you  have
              the necessary permissions.

             If  you  specify  a  UNIX file that is a link, bpbackup backs up only the
              link itself, not the file to which it links.

             bpbackup does not back up the "." or ".." directory entries.

       By default, you are returned to the system prompt after bpbackup is successfully
       submitted.  The  command  works in the background and does not return completion
       $HOME/bp.conf  file  or  a  root  user  specifies  it  in  the   /usr/openv/net-
       backup/bp.conf  file,  NetBackup  sends  mail on the backup completion status to
       mail_address. This message is sent when the backup process is complete.


OPTIONS

       -p policy Names the policy to use for the backup.

                 If this option is not specified for a user backup, NetBackup uses  the
                 first  policy  it  finds  that  includes  the client and a user backup
                 schedule.

                 The -p option is required for an immediate-manual backup (-i  option).

       -i        Starts  an immediate-manual backup. This is the equivalent of starting
                 a manual backup from the NetBackup administrator interface.  You  must
                 be the administrator on the master server to use the -i option.

       -dssu storage unit name
                 NetBackup manually starts an immediate running of the schedule associ-
                 ated with the disk staging storage unit. The -i option is the  implied
                 behavior and therfore is not necessary.

       -h hostname
                 It  names  the  client  host  on which to run the backup. If it is not
                 specified, NetBackup runs the backup on all clients in the policy.

       -s schedule
                 Names the schedule to use for the backup. If it is not specified,  the
                 NetBackup  server uses the first user backup schedule it finds for the
                 client in the policy it is using (see the -p option).

       -S master_server [,master_server,...]
                 Specifies the name(s) of the NetBackup master server(s).  The  default
                 is  the  first  SERVER entry found in the /usr/openv/netbackup/bp.conf
                 file.

       -t policy_type
                 Specifies one of the following numbers  corresponding  to  the  policy
                 type. The default for NT clients is 13,for Netware clients the default
                 is 10, and the default for all others is 0:

                 0 = Standard

                 4 = Oracle

                 6 = Informix-On-BAR

                 7 = Sybase

                 10 = NetWare

                 13 = MS-Windows-NT

                 18 = DB2

                 20 = FlashBackup

                 21 = Split-Mirror

                 22 = AFS

       -L progress_log [-en]
                 Specifies  the  name of a file in which to write progress information.
                 NetBackup creates the file if it doesn't exist.

                  For example: /home/tlc/proglog

                 The default is to not use a progress log.

                 Include the -en option to generate a log in English. The name  of  the
                 log will contain the string _en. This option is useful to support per-
                 sonnel assisting in a distributed environment where differing  locales
                 may create logs of various languages.

       -w [hh:mm:ss]
                 Causes  NetBackup  to  wait  for  a  completion status from the server
                 before returning you to the system prompt.

                 The date and time format depend on the user's locale. See NOTES.

                 You can optionally specify a wait time in hours, minutes, and seconds.
                 The  maximum  wait  time you can specify is 23:59:59. If the wait time
                 expires before the backup is complete, the command exits with a  time-
                 out status. The backup, however, still completes on the server.

                 If you use -w without specifying a wait time or you specify a value of
                 0, NetBackup waits indefinitely for the completion status.

                 If you include -i with -w, NetBackup waits until  all  initiated  jobs
                 have  completed before returning status. However, if more than one job
                 starts, the status is unpredictable. If the multiple jobs are  due  to
                 there  being  more  than one client and the policy does not have Allow
                 Multiple Data Streams selected, you  can  include  the  -h  option  to
                 restrict  the  operation  to one client and obtain predictable status.
                 However, if the policy has Allow Multiple Data  Streams  selected  and
                 there  is  more  than  one job from the selected client, the status is
                 still unpredictable.

       -help     Prints a command line usage message when -help is the only  option  on
                 the command line.

       -k keyword_phrase
                 Specifies  a  keyword  phrase that NetBackup associates with the image
                 being created by this backup operation. You can then restore the image

       -f listfile
                 Specifies  a  file  (listfile) containing a list of files to be backed
                 up. This option can be used instead of the filenames option, but  can-
                 not be used with the -i option. List each file on a separate line.

                 The  format  required  for  the file list depends on whether the files
                 have spaces or newlines in the names.

                 To back up files that do not have spaces or newlines in the names, use
                 this format:

                  filepath

                 Where  filepath  is the path to the file you are backing up. For exam-
                 ple:

                 /home

                 /etc

                 /var

                 To back up files that have spaces or newlines in the names,  use  this
                 format:

                  filepathlen filepath

                 Where  filepath  is  the  path  to  the  file  you  are backing up and
                 filepathlen is the number of characters in the file path.

                 For example:

                 5 /home

                 4 /etc

                 4 /var

                 19 /home/abc/test file

       filenames Names one or more files to be backed  up.  This  option  can  be  used
                 instead  of  the -f option, but cannot be used with the -i option. Any
                 files that you specify must be listed at the end, following all  other
                 options.


NOTES

       The  format  that  you  must  use for date and time values in NetBackup commands
       varies according to the locale setting.

       If you are uncertain of the NetBackup  command  requirements  for  your  locale,
       enter  the  command  with the -help option and check the usage. The following is
       part of the bpbackup usage statement output that shows the -w option:

       Example 2

       The  following  command  starts  a user backup of the files that are listed in a
       file named backup_list.

       bpbackup -f backup_list

       Example 3

       The following command (all on one line) starts an immediate-manual backup of the
       client  host  named diablo, in the policy named cis_co. The policy type is Stan-
       dard policy and is in the configuration on the master server named hoss.

       bpbackup -p cis_co -i -h diablo -S hoss -t 0

       Example 4

       The following command (all on one line,  or  using  the  backslash  continuation
       character)  associates the keyword phrase "Backup My Home Directory 01/01/01" to
       the user backup of the directory /home/kwc. The progress log is:

       /home/kwc/bkup.log.bpbackup -k \"Backup My Home Directory 01/01/01"

       -L /home/kwc/bkup.log  /home/kwc

       Example 5

       The following command (all on one line) associates the  keyword  phrase  "Policy
       Win  NT 01/01/01" to the immediate-manual backup of the client host named slater
       in the policy named win_nt_policy.

       bpbackup -k "Policy Win NT 01/01/01" -i -h slater \

       -p win_nt_policy -t 13


FILES

       $HOME/bp.conf

       /usr/openv/netbackup/logs/bpbackup/log.mmddyy


SEE ALSO

       bp(1), bparchive(1), bplist(1), bprestore(1)


COPYRIGHT

       Copyright 2002-2003 VERITAS Software Corporation. All rights reserved.