Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    21.  
      bpclient
    22.  
      bpclimagelist
    23.  
      bpclntcmd
    24.  
      bpclusterutil
    25.  
      bpcompatd
    26.  
      bpconfig
    27.  
      bpdbjobs
    28.  
      bpdbm
    29.  
      bpdgclone
    30.  
      bpdown
    31.  
      bpduplicate
    32.  
      bperror
    33.  
      bpexpdate
    34.  
      bpfis
    35.  
      bpflist
    36.  
      bpgetconfig
    37.  
      bpgetdebuglog
    38.  
      bpimage
    39.  
      bpimagelist
    40.  
      bpimmedia
    41.  
      bpimport
    42.  
      bpinst
    43.  
      bpkeyfile
    44.  
      bpkeyutil
    45.  
      bplabel
    46.  
      bplist
    47.  
      bpmedia
    48.  
      bpmedialist
    49.  
      bpminlicense
    50.  
      bpnbat
    51.  
      bpnbaz
    52.  
      bppficorr
    53.  
      bpplcatdrinfo
    54.  
      bpplclients
    55.  
      bppldelete
    56.  
      bpplinclude
    57.  
      bpplinfo
    58.  
      bppllist
    59.  
      bpplsched
    60.  
      bpplschedrep
    61.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig cldinstance
    86.  
      csconfig cldprovider
    87.  
      csconfig meter
    88.  
      csconfig throttle
    89.  
      duplicatetrace
    90.  
      importtrace
    91.  
      jbpSA
    92.  
      jnbSA
    93.  
      ltid
    94.  
      manageClientCerts
    95.  
      mklogdir
    96.  
      nbauditreport
    97.  
      nbcatsync
    98.  
      NBCC
    99.  
      NBCCR
    100.  
      nbcertcmd
    101.  
      nbcertupdater
    102.  
      nbcldutil
    103.  
      nbcomponentupdate
    104.  
      nbcplogs
    105.  
      nbdb_admin
    106.  
      nbdb_backup
    107.  
      nbdb_move
    108.  
      nbdb_ping
    109.  
      nbdb_restore
    110.  
      nbdb_unload
    111.  
      nbdbms_start_server
    112.  
      nbdbms_start_stop
    113.  
      nbdc
    114.  
      nbdecommission
    115.  
      nbdelete
    116.  
      nbdeployutil
    117.  
      nbdevconfig
    118.  
      nbdevquery
    119.  
      nbdiscover
    120.  
      nbdna
    121.  
      nbemm
    122.  
      nbemmcmd
    123.  
      nbexecute
    124.  
      nbfindfile
    125.  
      nbfirescan
    126.  
      nbftadm
    127.  
      nbftconfig
    128.  
      nbgetconfig
    129.  
      nbhba
    130.  
      nbholdutil
    131.  
      nbhostidentity
    132.  
      nbhostmgmt
    133.  
      nbhypervtool
    134.  
      nbjm
    135.  
      nbkmsutil
    136.  
      nboraadm
    137.  
      nborair
    138.  
      nbpem
    139.  
      nbpemreq
    140.  
      nbperfchk
    141.  
      nbplupgrade
    142.  
      nbrb
    143.  
      nbrbutil
    144.  
      nbregopsc
    145.  
      nbreplicate
    146.  
      nbrestorevm
    147.  
      nbseccmd
    148.  
      nbsetconfig
    149.  
      nbsnapimport
    150.  
      nbsnapreplicate
    151.  
      nbsqladm
    152.  
      nbstl
    153.  
      nbstlutil
    154.  
      nbstop
    155.  
      nbsu
    156.  
      nbsvrgrp
    157.  
      resilient_clients
    158.  
      restoretrace
    159.  
      stopltid
    160.  
      tl4d
    161.  
      tl8d
    162.  
      tl8cd
    163.  
      tldd
    164.  
      tldcd
    165.  
      tlhd
    166.  
      tlhcd
    167.  
      tlmd
    168.  
      tpautoconf
    169.  
      tpclean
    170.  
      tpconfig
    171.  
      tpext
    172.  
      tpreq
    173.  
      tpunmount
    174.  
      verifytrace
    175.  
      vltadm
    176.  
      vltcontainers
    177.  
      vlteject
    178.  
      vltinject
    179.  
      vltoffsitemedia
    180.  
      vltopmenu
    181.  
      vltrun
    182.  
      vmadd
    183.  
      vmchange
    184.  
      vmcheckxxx
    185.  
      vmd
    186.  
      vmdelete
    187.  
      vmoprcmd
    188.  
      vmphyinv
    189.  
      vmpool
    190.  
      vmquery
    191.  
      vmrule
    192.  
      vmupdate
    193.  
      vnetd
    194.  
      vxlogcfg
    195.  
      vxlogmgr
    196.  
      vxlogview
    197.  
      W2KOption

Name

bpbackup — back up files to the NetBackup server

SYNOPSIS

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"]

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"]

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\

DESCRIPTION

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.

Note:

In addition to listing individual files or directories, bpbackup can also use directives to indicate the files to be backed up. For example: bpbackup "/Shadow Copy Components/" or bpbackup "/System State/". Clients can enter the directive in the listfile using the bpbackup -f listfile option.

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:

  • 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.

  • On UNIX systems: If you specify a 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 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.

Note:

The - L option is not supported for NDMP clients.

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:

  • A nonroot user specifies USEMAIL = mail_address in the $HOME/bp.conf file

  • A root user specifies USEMAIL = mail_address in the /usr/openv/netbackup/bp.conf file

OPTIONS

-dssu DSSUname

NetBackup immediately runs the schedule that is associated with the disk staging storage unit. The -i option is the implied behavior and is not necessary.

-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, 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 file

Examples on Windows systems are the following:

11 c:\Programs
8 c:\winnt
22 c:\documents\old memos
filenames

Names one or more files to back up. You can use this option instead of the -f option, but you cannot use it with the -i option. You must list any files that you specify at the end, following all other options.

-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.

-i

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

-instance instance_name [-database database_name]

Specifies the name of an Oracle or SQL Server instance that you want to back up. The policy type (-t) must be set to 4 (Oracle) or 15 (SQL Server). You must use this option with the -h option, and you must be the administrator on the master server.

[-database database_name] specifies the name of a SQL Server database in an instance that you want to back up.

-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.

On UNIX systems, 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.

On Windows systems, all printable characters are permitted including space (" ") and period ("."). Enclose the phrase in double quotes ("...") or single quotes ( '...').

The default keyword phrase is the null (empty) string.

-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.

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 "BPCD_WHITELIST_PATH option for NetBackup servers and clients" topic in the NetBackup Administrator's Guide, Volume I.

-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.

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

-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 currently in use.

See the -p option.

-S master_server [,master_server,...]

On UNIX systems, -S specifies the name(s) of the NetBackup master server(s). The default is the first SERVER entry that is found in the /usr/openv/netbackup/bp.conf file.

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.

-t policy_type

Specifies one of the following numbers that correspond to the policy type. The default for Windows clients is 13, and the default for all others is 0:

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

-w [hh:mm:ss]

Causes NetBackup to wait for a completion status from the server before it returns you to the system prompt.

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.

EXAMPLES

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 "Backup Home Dir 01/01/01" 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 "Policy Win 01/01/01" 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

FILES

UNIX systems: $HOME/bp.conf

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

Windows systems: install_path\NetBackup\logs\bpbackup\*.log

SEE ALSO

See bp.

See bparchive.

See bplist.

See bprestore.