bpbackup -f listfile | filenames [-p policy] [-s schedule] [-S master_server...] [-t policy_type] [-L progress_log [-en]] [-w [hh:mm:ss]] [-k "keyword_phrase"] [-utf8]
bpbackup -i [-p policy] [-h hostname [-instance instance_name [-database database_name]]] [-s schedule] [-S master_server...] [-t policy_type] [-L progress_log [-en]] [-w [hh:mm:ss]] [-k "keyword_phrase"] [-utf8]
bpbackup -dssu DSSUname [-S master_server]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\
The bpbackup command can start a backup process on clients and master servers. When you use an Oracle policy, bpbackup lets you back up an instance. When you use a SQL Server policy, bpbackup lets you back up an instance or a database in an instance.
On clients:
The -f option of 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.
bpbackup 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 -i option of bpbackup starts an immediate manual backup of a client. The bpbackup option is available only to the administrator on the master server. It is equivalent to when you start a manual backup from the NetBackup Administration Console. Use the -h option to specify the host.
Because progress logs are written only on clients and this form of bpbackup is run from the master server only, the -L option is undefined.
The following restrictions apply to this command:
By default, you return to the system prompt after bpbackup is successfully submitted. The command works in the background and does not return completion status directly to you. The -w option lets you change this behavior so the command works in the foreground. It returns completion status after a specified time period.
If you create the file before you run the bpbackup command and then specify the file with the -L progress_log option, the following occurs: bpbackup writes informative and error messages to a progress-log file. If bpbackup cannot back up the requested files or directories, use the progress log to determine the reason for the failure.
If you create the following directory with public-write access, bpbackup creates a debug log file in the directory that you can use for troubleshooting:
On Windows systems: install_path\NetBackup\logs\bpbackup\
On UNIX systems: usr/openv/netbackup/logs/bpbackup/
NetBackup sends mail on the backup completion status when the backup process is complete to mail_address when users specify the following:
The format that is required for the file list depends on whether the files have spaces, newlines, or returns in the names.
To back up the files that do not have spaces, newlines, or returns in the names, use the following format:
filepath
Where
filepath
is the path to the file you want to back up.
On UNIX systems, examples are /home, /etc, and /var.
On Windows systems, examples are c:\Programs, c:\winnt, and c:\documents\old_memos
To back up the files that have spaces, newlines, or returns in the names, use the following format:
filepathlen filepath
Where
filepath
is the path to the file you want to back up and
filepathlen
is the number of characters in the file path.
Examples on UNIX systems are the following:
5 /home 4 /etc 4 /var 19 /home/abc/test fileExamples on Windows systems are the following:
11 c:\Programs 8 c:\winnt 22 c:\documents\old memos
[-database database_name] specifies the name of a SQL Server database in an instance that you want to back up.
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.
On UNIX systems, all printable characters are permitted including space (" ") and period ("."). Enclose the phrase in double quotes ("...") or single quotes ( oq...cq) to avoid conflict with the UNIX shell.
On Windows systems, all printable characters are permitted including space (" ") and period ("."). Enclose the phrase in double quotes ("...") or single quotes ( oq...cq).
The default keyword phrase is the null (empty) string.
On Windows systems, for example: NetBackup\logs\user_ops\proglog
On UNIX systems, for example: netbackup/logs/user_ops/proglog
The default is not to use a progress log.
The - L option is not supported for NDMP clients.
Include the -en option to generate a progress log that is in English. The name of the log contains the string _en. This option is useful to support personnel in a distributed environment where different locales may create logs of various languages.
Only default paths are allowed for this option and Veritas recommends to use the default paths. If you cannot use the NetBackup default path in your setup, you should add custom paths to the NetBackup configuration.
For more information on how to add a custom path, see the lqBPCD_WHITELIST_PATH option for NetBackup servers and clientsrq topic in the [1]NetBackup Administratorcqs Guide, Volume I.
If this option is not specified, NetBackup uses the first policy it finds that includes the client and a user backup schedule.
This option is required for an immediate-manual backup (-i option).
See the -p option.
On Windows systems, -S specifies the name(s) of the NetBackup master server(s). The default is the server designated as current on the Servers tab of the Specify NetBackup Machines dialog box. To display this dialog box, start the Backup, Archive, and Restore user interface on the client. Then click Specify NetBackup Machines on the File menu.
0 = Standard
4 = Oracle
6 = Informix-On-BAR
7 = Sybase
8 = MS-SharePoint
13 = MS-Windows
15 = MS-SQL-Server
16 = MS-Exchange-Server
19 = NDMP
Note that the following policy types apply only to the NetBackup Enterprise Server.
11 = DataTools-SQL-BackTrack
17 = SAP
18 = DB2
20 = FlashBackup
21 = Split-Mirror
39 = Enterprise-Vault
44 = BigData
For some policy types, NetBackup on Windows assumes that the input file list is formatted in the active code page (ACP). It converts each path specification from the ACP to UTF-8. The option applies to any backups that are initiated from the command line on Windows, for the following policy types:
DB2 MS-Exchange-Server Lotus-Notes Oracle SAP MS-SQL-Server Sybase MS-Windows
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 code. The operating system shell can only return one return code. Therefore, if you use -w without specifying a wait time or you specify a value of 0, NetBackup waits indefinitely for the completion status.
You can start a manual or an administrative backup using bpbackup -i along with the -w function. This type of backup has the potential to start multiple jobs because it is based on policy attributes. If the manual backup starts multiple jobs, the -w function still only returns one return code to the shell.
If you use -i with -w and more than one job begins, NetBackup waits until all jobs complete before it returns a completion status. However, because NetBackup only returns one status code to the shell, the job ID that the status code belongs to is unknown.
If multiple jobs are due to multiple clients and Allow Multiple 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.
Example 1 - Perform a user backup of a single file.
On UNIX systems: # bpbackup /usr/user1/file1
On Windows systems: # bpbackup c:\users\user1\file1
Example 2 - Start a user backup of the files that are listed in a file that is named backup_list.
# bpbackup -f backup_list
Example 3 - Start an immediate-manual backup (all on one line) 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 master server named hoss.
UNIX: # bpbackup -p cis_co -i -h diablo -S hoss -t 0
Windows: # bpbackup -p cis_co -i -h diablo -S hoss -t 0
Example 4 - On Windows systems: Associate the keyword phrase "Backup My Home Directory 01/01/01" to the user backup of the directory C:\home\kwc. (Enter the command on one line.)
# bpbackup -k "Backup My Home Directory 01/01/01" -L c:\Program Files\Veritas\NetBackup\logs\user_ops\bkup.log \ C:\home\kwc
On UNIX systems: The following command associates the keyword phrase lqBackup Home Dir 01/01/01rq to the user backup of the directory /home/kwc. (Enter the command on one line or use the backslash continuation character.)
# bpbackup -k "Backup Home Dir 01/01/01" -L /usr/openv/netbackup/logs/user_ops/bkup.log \ /home/kwc
Example 5 - Associate the keyword phrase lqPolicy Win 01/01/01rq to the immediate-manual backup of the client host named slater in the policy named win_nt_policy. (Enter the command all on one line.)
UNIX:
# bpbackup -k "Policy Win 01/01/01" -i -h slater \ -p win_nt_policy -t 13
Windows:
# bpbackup -k "Policy Win 01/01/01" -i -h slater -p win_nt_policy -t 13
Example 6 - Perform a manual backup of the Oracle instance orac11g on client host hookvm2 by using the ora policy.
# bpbackup -i -p ora -h hookvm2 -t 4 -instance orac11g
Example 7 - Perform a manual backup of the SQL Server database HRDB1 in instance HRon client host winvm2 by using the sql policy.
# bpbackup -i -p sql -h winvm2 -t 15 -instance HR -database HRDB1
UNIX systems: $HOME/bp.conf
/usr/openv/netbackup/logs/bpbackup/log.mmddyy
Windows systems: install_path\NetBackup\logs\bpbackup\*.log
bp, bparchive, bplist, bprestore