Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.2)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
    6.  
      Removal of nbexecute command
  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.  
      configurePorts
    85.  
      configureTPCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig throttle
    91.  
      duplicatetrace
    92.  
      importtrace
    93.  
      jbpSA
    94.  
      jnbSA
    95.  
      ltid
    96.  
      manageClientCerts
    97.  
      mklogdir
    98.  
      nbauditreport
    99.  
      nbcatsync
    100.  
      NBCC
    101.  
      NBCCR
    102.  
      nbcertcmd
    103.  
      nbcertupdater
    104.  
      nbcldutil
    105.  
      nbcloudrestore
    106.  
      nbcomponentupdate
    107.  
      nbcplogs
    108.  
      nbdb_admin
    109.  
      nbdb_backup
    110.  
      nbdb_move
    111.  
      nbdb_ping
    112.  
      nbdb_restore
    113.  
      nbdb_unload
    114.  
      nbdbms_start_server
    115.  
      nbdbms_start_stop
    116.  
      nbdc
    117.  
      nbdecommission
    118.  
      nbdelete
    119.  
      nbdeployutil
    120.  
      nbdevconfig
    121.  
      nbdevquery
    122.  
      nbdiscover
    123.  
      nbdna
    124.  
      nbemm
    125.  
      nbemmcmd
    126.  
      nbfindfile
    127.  
      nbfirescan
    128.  
      nbftadm
    129.  
      nbftconfig
    130.  
      nbgetconfig
    131.  
      nbhba
    132.  
      nbholdutil
    133.  
      nbhostidentity
    134.  
      nbhostmgmt
    135.  
      nbhypervtool
    136.  
      nbinstallcmd
    137.  
      nbjm
    138.  
      nbkmsutil
    139.  
      nboraadm
    140.  
      nborair
    141.  
      nbpem
    142.  
      nbpemreq
    143.  
      nbperfchk
    144.  
      nbplupgrade
    145.  
      nbrb
    146.  
      nbrbutil
    147.  
      nbregopsc
    148.  
      nbreplicate
    149.  
      nbrepo
    150.  
      nbrestorevm
    151.  
      nbseccmd
    152.  
      nbsetconfig
    153.  
      nbsnapimport
    154.  
      nbsnapreplicate
    155.  
      nbsqladm
    156.  
      nbstl
    157.  
      nbstlutil
    158.  
      nbstop
    159.  
      nbsu
    160.  
      nbsvrgrp
    161.  
      resilient_clients
    162.  
      restoretrace
    163.  
      stopltid
    164.  
      tl4d
    165.  
      tl8d
    166.  
      tl8cd
    167.  
      tldd
    168.  
      tldcd
    169.  
      tlhd
    170.  
      tlhcd
    171.  
      tlmd
    172.  
      tpautoconf
    173.  
      tpclean
    174.  
      tpconfig
    175.  
      tpext
    176.  
      tpreq
    177.  
      tpunmount
    178.  
      verifytrace
    179.  
      vltadm
    180.  
      vltcontainers
    181.  
      vlteject
    182.  
      vltinject
    183.  
      vltoffsitemedia
    184.  
      vltopmenu
    185.  
      vltrun
    186.  
      vmadd
    187.  
      vmchange
    188.  
      vmcheckxxx
    189.  
      vmd
    190.  
      vmdelete
    191.  
      vmoprcmd
    192.  
      vmphyinv
    193.  
      vmpool
    194.  
      vmquery
    195.  
      vmrule
    196.  
      vmupdate
    197.  
      vnetd
    198.  
      vssat
    199.  
      vwcp_manage
    200.  
      vxlogcfg
    201.  
      vxlogmgr
    202.  
      vxlogview
    203.  
      W2KOption

Name

bplist — list the backed up and archived files on all NetBackup hosts

SYNOPSIS

bplist [-A | -B] [-C client] [-S master_server] [-k policy] [-t policy_type] [-F] [-R [n]] [-b | -c | -u] [-l] [-r] [-flops options] [-Listseconds] [-T] [-Translateownership] [-unix_files] [-nt_files] [-s date] [-e date] [-I] [-PI] [-keyword keyword_phrase] [filename] [-Listpolicy] [-nboptimized | -nbnormal]

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 bplist command shows a list of previously archived or backed up files according to the options that you specify. You can choose the file or directory and the time period that you want the listing to cover. Directories can be recursively displayed to a specified depth. bplist shows only the files that you have read access to. It lists the files only if an administrator account performs the user backup.

You also must own or have read access to all directories in the file paths. You can list the files that were backed up or archived by another client only if the NetBackup administrator has validated you to do so.

If you create the following directory with public-write access, bplist creates a debug log file in this directory that you can use for troubleshooting:

UNIX systems: usr/openv/netbackup/logs/bplist/

Windows systems: install_path\NetBackup\logs\bplist\

OPTIONS

-A | -B

Specifies whether to produce the listing from archives (-A) or backups (-B). The default is -B.

-b | -c | -u

Specifies an alternate date-time to be used for printing with the -l option:

-b displays the backup date and time of each file.

-c displays the last inode modification date and time (UNIX systems) or creation date and time (Windows systems) for each file.

-u displays the last access date and time of each file.

The default is to display the time of the last modification of each file.

-C client

Specifies a client name to use for finding backups or archives to list. This name must be as it appears in the NetBackup configuration. The default is the current client name.

-F

Specifies that in the list output, symbolic links (which apply only to UNIX clients) end with a trailing @ and executable files with a trailing *.

filename

Names the file or directory to list. Any files or directories that you specify must be listed at the end, following all other options. If you do not specify a path, the default is the current working directory.

For Windows systems, use uppercase for the drive letter. For example:

C:\NetBackup\log1

For directories, if you do not use the -R option, include the trailing path separator as in the following:

UNIX systems: bplist -l "/home/user1/*"

Windows systems: bplist -l "D:\WS_FTP.LOG\*"

If you use the asterisk meta-character (*), use quotation marks around the file name for the command to work properly.

-flops options

Lists NetBackup files.

-I

Specifies a search that is case insensitive. The capitalization is not considered when it compares names (for example, Cat matches cat).

-k policy

Names the policy to search to produce the list. If not specified, all policies are searched.

-keyword keyword_phrase

Specifies a keyword phrase for NetBackup to use when it searches for backups or archives from which to restore files. The phrase must match the one that was previously associated with the backup or archive by the -k option of bpbackup or bparchive.

You can use this option in place of or in combination with the other restore options to make it easier to restore backups and archives. Use the following meta-characters to help match keywords or parts of keywords in the phrase:

* matches any string of characters.

? matches any single character.

[ ] matches one of the sequence of characters that is specified within the brackets.

[ - ] matches one of the range of characters, that is separated by the "-".

The keyword phrase can be up to 128 characters in length. All printable characters are permitted including space ("") and period (".").

The phrase must be enclosed in double quotes ("...") or single quotes ('...' ).

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

Note:

The keyword phrase is ignored when you use the following policy types: DB2, Informix-On-BAR, Oracle, SAP, MS-SQL-Server, Sybase.

-l

On Windows systems, -l shows the file details.

On UNIX systems, -l lists the following file details in a long format: Mode, owner, group, size in bytes, and time of last modification for each file (see the EXAMPLES section). The list shows the mode of each file as ten characters that represent the standard UNIX file permissions. The first character is one of the following:

d (specifies a directory)

l (specifies a link)

m (specifies a file that migrated by Veritas Storage Migrator for UNIX or Veritas Data Lifecycle Manager)

- (specifies a file)

The next nine characters show the three sets of permissions. The first set shows the owner's permissions, the next set shows the user-group permissions, and the last set shows permissions for all other users. Each set of three specifies the read, write, and execute permissions as follows:

r = the file is readable

w = the file is writable

x = the file is executable

- = the indicated permission is not granted

-Listpolicy

Includes the schedule type and policy name in the command output.

-Listseconds

Specifies that seconds granularity be used for the timestamp when the -l option is used.

-nboptimized

Specifies the command filter the output to show only Windows images that were backed up with the optimized flag for Windows deduplication.

-nbnormal

Specifies the command filter the output to show only Windows images that were not backed up with the optimized flag for Windows deduplication.

-nt_files

Lists the files and directories in Windows format. This option applies only to Windows. For example: C:\users\test

-PI

Specifies a path-independent search, which means that NetBackup searches for a specified file or directory without regard to the path. For example, a file with the name test exists in the three following directories. A search for test finds all three instances of the file:

UNIX systems:

/tmp/junk/test
/abc/123/xxx/test
/abc/123/xxx/yyy/zzz/test

Windows systems:

\tmp\junk\test
\abc\123\xxx\test
\abc\123\xxx\yyy\zzz\test
-r

On Windows systems, -r lists the disk images that were backed up. The default is to list file systems.

On UNIX systems, -r lists the raw partitions that were backed up. The default is to list file systems.

-R [n]

Recursively lists the subdirectories that are encountered to a depth of n. The default for n is 999.

-s date, -e date

Specifies the start date (-s) and end date (-e) for the listing.

-s specifies a start date and time for the listing. The resulting list shows only files in backups or the archives that occurred at or after the specified date and time.

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.

For more about the locale of your system, see "About specifying the locale of the NetBackup installation" in the NetBackup Administrator's Guide, Volume II.

The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07. The default is the current date minus six months.

-e specifies an end date and time for the listing. The resulting list shows only files from the backups or the archives that occurred at or before the specified date and time. Use the same format for start date and time. The default is the current date and time.

-S master_server

UNIX systems: -s specifies the name of the NetBackup server. The default is the first SERVER entry that is found in the /usr/openv/netbackup/bp.conf file.

Windows systems: -s specifies the name of the NetBackup 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.

-t policy_type

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

0 = Standard

4 = Oracle

6 = Informix-On-BAR

7 = Sybase

8 = MS-SharePoint

11 = DataTools-SQL-BackTrack

13 = MS-Windows

15 = MS-SQL-Server

16 = MS-Exchange-Server

17 = SAP

18 = DB2

19 = NDMP

20 = FlashBackup

21 = Split-Mirror

25 = Lotus Notes

29 = FlashBackup-Windows

35 = NBU-Catalog

39 = Enterprise-Vault

40 = VMware

41 = Hyper-V

44= BigData

-T

Lists the directories in true-image backups. The default is to list non-true-image backups.

Note:

TIR information does not appear for synthetic full backups, even though TIR information is used for synthetic full backups.

-Translateownership

On Linux systems for Linux VMware backups only: Translates the user ID (UID) and the group ID (GID) of the individual who owns the files to the user name and group name. By default for Linux VMware backups, bplist shows the UID and the GID.

The client on which you run the bplist command and -Translateownership option must be the same as the client that you specify with the -C option.

On operating systems other than Linux, this option has no effect.

-unix_files

Lists the files and directories in UNIX format. This option applies only to UNIX. For example: /C/users/test

EXAMPLES

Example 1 - List recursively in long format, the files that were backed up in /home/usr1 (UNIX) or D:\WS_RTP.LOG (Windows).

On UNIX systems:

# bplist -l -R /home/usr1 
 lrwxrwxrwx  usr1;usr@  eng;None  0   Apr 28 12:25 /home/usr1/dirlink
 drwxr-xr-x  usr1;usr@  eng;None  0   Apr 04 07:48 /home/usr1/testdir
 drwxr-x---  usr1;usr@  eng;None  0   Apr 04 07:49 /home/usr1/dir
 -rwxr-----  usr1;usr@  eng;None 1002 Apr 02 09:59 /home/usr1/dir/file
 lrwxrwxrwx  usr1;usr@  eng;None  0   Apr 04 07:49 /home/usr1/dir/link

On Windows systems:

# bplist -l -R D:\WS_FTP.LOG 
    -rwx------  bjm;usr@    bjm;None  64  Oct 10  2012 D:\WS_FTP.LOG
    -rwx------  bjm;usr@    bjm;None  64  Oct 10  2012 D:\WS_FTP.LOG
    -rwx------  bjm;usr@    bjm;None  64  Oct 10  2012 D:\WS_FTP.LOG

Example 2 - List the files that were backed up and associated with all or part of the keyword phrase "MyHomeDirectory".

UNIX: # bplist -keyword "*MyHomeDirectory*" -l /home/kwc/
Windows: # bplist -keyword "*MyHomeDirectory*" -l C:\home\kwc\

Example 3 - List the files that were archived and associated with all or part of the keyword phrase "MyHomeDirectory"

UNIX: # bplist -A -keyword "*MyHomeDirectory*" -l /home/kwc/
Windows: # bplist -A -keyword "*MyHomeDirectory*" -l C:\home\kwc\

Example 4 - Lists recursively and with details the output from bplist on a Windows master server from a Windows client. Enter the following command to list the files that were backed up on drive D of Windows client slater and associated with all or part of the keyword phrase "Win NT":

# bplist -keyword "*Win NT*" -C slater -R -l C:\client_data_2

drwx------ root;usr@ root;None  0 Aug 28 17 C:\client_data_2\
-rwx------ root;usr@ root;None 40 Aug 05 24 C:\client_data_2\ewr.txt
drwx------ root;usr@ root;None  0 Aug 28 17 C:\client_data_2\
-rwx------ root;usr@ root;None 40 Aug 05 24 C:\client_data_2\ewr.txt

The user column (root;usr@) for the Windows images displays the user that backed up the file and the owner@domain separated by a semicolon. The group column (root;None) for the Windows images is the group that backed up the file and the group@domain separated by a semicolon.

Example 5 - List the files from a Linux VMware backup and translate the UID and GID to the user name and the group name:

# bplist -Translateownership -S host0.example.com
-C client0.example.com -R 1 -l -t 40 -E -unix_files -b /user1_home

drwxr-xr-x user1   grp   0 Sep 09 10:39 /user1_home/
drwxr-xr-x user1   grp   0 Sep 09 10:39 /user1_home/user_data/
drwxr-xr-x root    root  0 Sep 09 10:39 /user1_home/root_data/
drwxr-xrwx root    root  0 Sep 09 10:39 /user1_home/root_data_write/
drwxr-xr-x root    root  0 Sep 09 10:39 /user1_home/root_data.orig/
drwxr-xr-x user1   grp   0 Sep 09 10:39 /user1_home/444.txt/

FILES

UNIX systems: /usr/openv/netbackup/logs/bplist/log.mmddyy

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

SEE ALSO

See bp.

See bparchive.

See bpbackup.

See bprestore.