Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  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.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    103.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

bparchive — archive files to the NetBackup server

SYNOPSIS

bparchive [-p policy] [-s schedule][-L progress_log [-en]] [-S master_server [,master_server,...]] [-t policy_type] [-w [hh:mm:ss]] [-k "keyword_phrase"] [-utf8] -f listfile | filenames

 

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

bparchive processes the files that are listed on the command line or in the specified file, using the -f listfile option. Any file path that is entered can be a file name or a directory name. If the list of files includes a directory, it archives all files and subdirectories of that directory and starts at the directory itself.

By default, you return to the system prompt after bparchive is successfully submitted. The command works in the background and does not return completion status directly to you. Use the -w option to change bparchive to work in the foreground and to return completion status after a specified time period.

bparchive writes informative and error messages to a progress-log file if the file is created. Create the file before you run the bparchive command and specify it with the -L progress_log option. If bparchive cannot archive any of the requested files or directories, use the progress log to determine the reason for the failure.

If you create a directory with write access, bparchive creates a debug log file in this directory to use for troubleshooting.

On Windows systems, nbu_dir_path is install_path\NetBackup\logs\bparchive\

On UNIX systems, the directory is /usr/openv/netbackup/logs/bparchive/

NetBackup sends mail on the archive completion status to mail_address if USEMAIL = mail_address. It is entered as follows: non-administrator users specify it on the $HOME/bp.conf file; administrators specify it in the /usr/openv/netbackup/bp.conf file. This message is sent when the archive process is complete.

The following restrictions apply to this command:

  • On UNIX systems: To archive a file with bparchive, you must be the root or the owner and a member of the primary group (as owner) to delete. Also, the file must not be read only. Otherwise, NetBackup saves the files but cannot reset their access time (utime) and does not delete them from the disk.

  • On Windows systems, to archive a file with bparchive, you must have permission to delete the file and the file must not be read only. Otherwise, NetBackup saves the files but does not delete them from the disk.

  • On UNIX systems: If you specify a UNIX file that is a link, bparchive archives only the link itself, not the file to which it links.

  • bparchive does not archive the "." or ".." directory entries, and does not archive disk-image backups.

OPTIONS

-f listfile

Specifies a file (listfile) that contains a list of files to be archived and can be used instead of the filenames option. In listfile, place each file path on a separate line.

The required file list format depends on whether the files have spaces, newlines, or returns in the names. To archive the files that do not have spaces or newlines or returns in the names, use the following format:

filepath

The path to the file you want to archive. Some examples on UNIX systems are:/home, /etc, and /var. Some examples on Windows systems are: c:\Programs and c:\documents\old_memos

To archive the files that have spaces or newlines or returns in the names, use this format:

filepathlen filepath

filepath is the path to the file you want to archive and filepathlen is the number of characters in the file path.

The path to the file you want to archive. Some examples on UNIX systems are:/home, /etc, and /var. Some examples on Windows systems are: c:\Programs and c:\documents\old_memos

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 be archived and can be used instead of the -f option. Any files that you specify must be listed at the end, after all other options.

-k keyword_phrase

Specifies a keyword phrase that NetBackup associates with the image created by this archive operation. You then can restore the image by specifying the keyword phrase with the -k option on the bprestore command.

The keyword phrase is a textual description of the archive 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 ('...').

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

-L progress_log [-en]

Specifies the name of an existing file in which to write progress information.

On UNIX systems, the file name must begin with /.

For example: netbackup/logs/user_ops/proglog

On Windows system, an example is NetBackup\logs\user_ops\proglog

The default is to not use a progress log.

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 using 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 user archive. If it is not specified, the NetBackup server uses the first policy it finds that includes the client and a user archive schedule.

-S master_server

On UNIX systems, this option specifies the name of the NetBackup master server. The default is the first SERVER entry in the /usr/openv/netbackup/bp.conf file.

On Windows systems, this option specifies the name of the NetBackup master server. 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.

-s schedule

Names the schedule to use for the user archive. If it is not specified, the NetBackup server uses the first user archive schedule it finds in the policy it currently uses. (See the -p option.)

-t policy_type

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

0 = Standard

4 = Oracle

6 = Informix-On-BAR

7 = Sybase

13 = MS-Windows

15 = MS-SQL-Server

16 = MS-Exchange-Server

19 = NDMP

The following policy types apply only to NetBackup Enterprise Server:

11 = DataTools-SQL-BackTrack

17 = SAP

18 = DB2

20 = FlashBackup

21 = Split-Mirror

39 = Enterprise-Vault

-utf8

This option tells NetBackup that the file list that is provided is in UTF-8 format. With this option, NetBackup does not try to convert the path names. The option has no effect for non-Windows platforms or for other policy types.

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
-w [hh:mm:ss]

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

The required date and time values format in NetBackup commands varies according to your locale. The /usr/openv/msg/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.

See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II.

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 archive is complete, the command exits with a timeout status. The archive, however, still completes on the server.

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

EXAMPLES

Example 1 - Archive a single file:

UNIX systems: bparchive /usr/user1/file1

Windows systems: bparchive c:\usr\user1\file1

Example 2 - Archive the files that are listed in a file that is named archive_list:

bparchive -f archive_list

Example 3 - Associate keyword phrase "Archive My Home Directory 02/02/10" to the archive of a directory named kwc and use a progress log that is named arch.log:

UNIX systems: bparchive -k "Archive My Home Directory 02/02/10" \-L /usr/openv/netbackup/logs/user_ops/arch.log /home/kwc

Windows systems: bparchive -k "Archive My Home Directory 02/02/10" \-L c:\Program Files\Veritas\NetBackup\logs\user_ops\arch.log c:\home\kwc