SYNOPSIS
/usr/openv/netbackup/bin/bpbackup [-p policy] [-s schedule] [-S mas-
ter_server...] [-t policy_type] [-L progress_log [-en]] [-w
[hh:mm:ss]] [-help] [-k "keyword_phrase"] -f listfile | file-
names
/usr/openv/netbackup/bin/bpbackup -i [-p policy] [-h hostname] [-s
schedule] [-S master_server...] [-t policy_type] [-L
progress_log [-en]] [-w [hh:mm:ss]] [-k "keyword_phrase"]
/usr/openv/netbackup/bin/bpbackup -dssu DSSUname
DESCRIPTION
bpbackup starts either of the following processes:
On clients
The first form in the command synopsis, bpbackup starts a user backup
equivalent to what is performed by using the interface on the client.
This type of backup can be started from any NetBackup client 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 name or a directory name. If the named files
include a directory, bpbackup backs up all files and subdirectories of
that directory; it starts at the directory itself.
On master servers
The second form in the command synopsis, 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 mas-
ter server. It is equivalent to when you start a manual backup from the
NetBackup Administration Console. Use the -h option to specify the
host.
Since progress logs are written only on clients and this form of
bpbackup is run from the master server only, the -L option is unde-
fined.
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 the directories that other users own
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.
If you create a directory that is named /usr/openv/net-
backup/logs/bpbackup/ with public-write access, bpbackup creates a
debug log file in this directory to use for troubleshooting.
NetBackup sends mail on the backup completion status when the backup
process is complete to mail_address when users specify the following:
· A nonroot user specifies USEMAIL = mail_address in their
$HOME/bp.conf file
· A root user specifies USEMAIL = mail_address in the
/usr/openv/netbackup/bp.conf file
OPTIONS
-p policy Names the policy to use for the backup.
If this option is not specified, 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. It is equivalent to when
you start a manual backup from the NetBackup administrator
interface. You must be the administrator on the master server
to use the -i option.
-dssu DSSUname
NetBackup immediately runs the schedule that is associated
with the disk staging storage unit. The -i option is the
implied behavior and therefore is not necessary.
-h hostname
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 spec-
ified, the NetBackup server uses the first user backup sched-
ule it finds for the client in the policy currently in use.
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 that corresponds to
13 = MS-Windows
14 = OS/2
15 = MS-SQL-Server
16 = MS-Exchange-Server
19 = NDMP Note that the following policy types apply only to
NetBackup Enterprise Server.
11 = DataTools-SQL-BackTrack
17 = SAP
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 does not exist.
For example: /home/tlc/proglog
The default is not to use a progress log.
Include the -en option to generate a log in English. The name
of the log contains the string _en. This option is useful to
support personnel in a distributed environment where differ-
ent 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 the 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 timeout status. The backup, however,
still completes on the server.
The bpbackup -w option causes the shell to wait for a return
status. However, becauseNetBackup only returns one status
code to the shell, the job ID that the status code belongs to
is unknown.
If multiple clients are running multiple jobs and Allow Mul-
tiple Data Streams is not selected, use -h to restrict the
operation to one client. However, if Allow Multiple Data
Streams is selected in the policy and the selected client has
multiple jobs, the returned status code is again unknown.
-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 that this backup operation creates. You then can
restore the image by specifying the keyword phrase with the
-k option on the bprestore command.
If you use the -i option with -k, NetBackup establishes an
association between the keyword phrase and the backup policy
and image.
The keyword phrase is a textual description of the backup
that is a maximum of 128 characters in length. All printable
characters are permitted including space (" ") and period
("."). Enclose the phrase in double quotes ("...") or single
quotes ( `...') to avoid conflict with the UNIX shell.
The default keyword phrase is the null (empty) string.
-f listfile
Specifies a file (listfile) that contains a list of files to
back up. You can use this option instead of the filenames
option, but you cannot use it with the -i option. List each
file on a separate line.
The format that is required for the file list depends on
whether the files have spaces or newlines in the names.
To back up the files that do not have spaces or newlines in
the names, use the following format:
filepath
Where filepath is the path to the file you want to back up.
For example:
/home
/etc
4 /etc
4 /var
19 /home/abc/test file
filenames Names one or more files to back up. You can use this option
instead of the -f option, but you ocannot use it with the -i
option. You must list any files that you specify at the end,
following all other options.
NOTES
The format that you must use for date and time values in NetBackup com-
mands 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:
[-w hh:mm:ss]
Notice the hours:minutes:seconds requirement. These are for a locale
setting of C and may be different for other locales.
For more information on locale, see the locale(1) man page for your
system.
EXAMPLES
Example 1
Performs a user backup of a single file, enter:
bpbackup /usr/user1/file1
Example 2
The following command starts a user backup of the files that are listed
in a file that is 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 Standard policy and is in the configuration on the mas-
ter server named hoss.
bpbackup -p cis_co -i -h diablo -S hoss -t 0
Example 4
slater in the policy named win_nt_policy. (Enter the command all on one
line.)
bpbackup -k "Policy Win 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)
11 Jul 2005 bpbackup(1)