NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.1.1)
  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.  
      bpcleanrestore
    22.  
      bpclient
    23.  
      bpclimagelist
    24.  
      bpclntcmd
    25.  
      bpclusterutil
    26.  
      bpcompatd
    27.  
      bpconfig
    28.  
      bpdbjobs
    29.  
      bpdbm
    30.  
      bpdgclone
    31.  
      bpdown
    32.  
      bpduplicate
    33.  
      bperror
    34.  
      bpexpdate
    35.  
      bpfis
    36.  
      bpflist
    37.  
      bpgetconfig
    38.  
      bpgetdebuglog
    39.  
      bpimage
    40.  
      bpimagelist
    41.  
      bpimmedia
    42.  
      bpimport
    43.  
      bpinst
    44.  
      bpkeyfile
    45.  
      bpkeyutil
    46.  
      bplabel
    47.  
      bplist
    48.  
      bpmedia
    49.  
      bpmedialist
    50.  
      bpminlicense
    51.  
      bpnbat
    52.  
      bpnbaz
    53.  
      bppficorr
    54.  
      bpplcatdrinfo
    55.  
      bpplclients
    56.  
      bppldelete
    57.  
      bpplinclude
    58.  
      bpplinfo
    59.  
      bppllist
    60.  
      bpplsched
    61.  
      bpplschedrep
    62.  
      bpplschedwin
    63.  
      bppolicynew
    64.  
      bpps
    65.  
      bprd
    66.  
      bprecover
    67.  
      bprestore
    68.  
      bpretlevel
    69.  
      bpschedule
    70.  
      bpschedulerep
    71.  
      bpsetconfig
    72.  
      bpstsinfo
    73.  
      bpstuadd
    74.  
      bpstudel
    75.  
      bpstulist
    76.  
      bpsturep
    77.  
      bptestbpcd
    78.  
      bptestnetconn
    79.  
      bptpcinfo
    80.  
      bpup
    81.  
      bpverify
    82.  
      cat_convert
    83.  
      cat_export
    84.  
      cat_import
    85.  
      configureCerts
    86.  
      configureMQ
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig reinitialize
    93.  
      csconfig throttle
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      mklogdir
    100.  
      msdpcldutil
    101.  
      nbauditreport
    102.  
      nbcallhomeproxyconfig
    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.  
      nbfp
    135.  
      nbftadm
    136.  
      nbftconfig
    137.  
      nbgetconfig
    138.  
      nbhba
    139.  
      nbholdutil
    140.  
      nbhostidentity
    141.  
      nbhostmgmt
    142.  
      nbhypervtool
    143.  
      nbidpcmd
    144.  
      nbimageshare
    145.  
      nbinstallcmd
    146.  
      nbjm
    147.  
      nbkmiputil
    148.  
      nbkmscmd
    149.  
      nbkmsutil
    150.  
      nboraadm
    151.  
      nborair
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmlb
    155.  
      nbperfchk
    156.  
      nbplupgrade
    157.  
      nbrb
    158.  
      nbrbutil
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbserviceusercmd
    164.  
      nbsetconfig
    165.  
      nbsmartdiag
    166.  
      nbsnapimport
    167.  
      nbsnapreplicate
    168.  
      nbsqladm
    169.  
      nbstl
    170.  
      nbstlutil
    171.  
      nbstop
    172.  
      nbsu
    173.  
      nbsvrgrp
    174.  
      netbackup_deployment_insights
    175.  
      resilient_clients
    176.  
      restoretrace
    177.  
      stopltid
    178.  
      tldd
    179.  
      tldcd
    180.  
      tpautoconf
    181.  
      tpclean
    182.  
      tpconfig
    183.  
      tpext
    184.  
      tpreq
    185.  
      tpunmount
    186.  
      verifytrace
    187.  
      vltadm
    188.  
      vltcontainers
    189.  
      vlteject
    190.  
      vltinject
    191.  
      vltoffsitemedia
    192.  
      vltopmenu
    193.  
      vltrun
    194.  
      vmadd
    195.  
      vmchange
    196.  
      vmcheckxxx
    197.  
      vmd
    198.  
      vmdelete
    199.  
      vmoprcmd
    200.  
      vmphyinv
    201.  
      vmpool
    202.  
      vmquery
    203.  
      vmrule
    204.  
      vmupdate
    205.  
      vnetd
    206.  
      vssat
    207.  
      vwcp_manage
    208.  
      vxlogcfg
    209.  
      vxlogmgr
    210.  
      vxlogview
    211.  
      W2KOption

Name

bpverify — verify the backups that NetBackup creates

SYNOPSIS

bpverify [-l] [-p] [-pb] [-v] [-local] [-client name] [-st sched_type] [-sl sched_label] [-L output_file [-en]] [-policy name] [-s date] [-e date] [-M master_server] [-Bidfile file_name] [-pt policy_type] [-hoursago hours] [[-cn copy number] | [-primary]] [-backupid backup_id] [[-id media_id or path] | [-stype server_type] [-dp disk_pool_name [-dv disk_volume]]] [-priority number]

 

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\

DESCRIPTION

bpverify verifies the contents of one or more backups by reading the backup volume and by comparing its contents to the NetBackup catalog. This operation does not compare the data on the volume with the contents of the client disk. However, it does read each block in the image, which verifies that the volume is readable. NetBackup verifies only one backup at a time and tries to minimize media mounts and position time.

If either -Bidfile or -backupid is specified, bpverify uses this option as the sole criterion for selecting the set of backups it verifies. If the command line does not contain -Bidfile or -backupid, then bpverify selects the backups that satisfy all the selection options. For example, if the command line looks like the following:

bpverify -pt Standard -hoursago 10

then bpverify verifies the set of backups with policy type Standard that run in the past 10 hours.

If -p or -pb is specified, bpverify previews the set of backups that meet the selection criteria. It displays the backup IDs, but does not perform the verification.

bpverify sends its error messages to stderr. It sends a log of its activity for the current day to the NetBackup admin log file in the following directory:

UNIX systems:

/usr/openv/netbackup/logs/admin

Windows systems:

install_path\NetBackup\Logs\admin

Any authorized user can run this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

OPTIONS

-backupid backup_id

Specifies the backup ID of a single backup to verify. This option takes precedence over any other selection criteria except -Bidfile. The default is any backup.

-Bidfile file_name

Specifies a file that contains a list of backup IDs to be verified. This file is removed during the activation of the command line interface (CLI). This file is removed because the NetBackup GUIs commonly use this parameter. The GUIs expect the command-line interface to remove the temporary file that was used for the -Bidfile option upon completion. Direct command-line interface users can also use the option, however it removes the file.

The file contains one backup ID per line. If this option is specified, other selection criteria are ignored. The default is no file of backup IDs, which means any backup can be verified.

-client name

Specifies the name of the client that produced the original backup. The default is any client.

-cn copy_number | -primary

Determines the copy number of the backup ID to verify. Valid values are 1 through the setting that the bpconfig -max_copies setting indicates, up to 10. The default is 1.

-primary indicates that the primary copy should be verified rather than the copy.

-dp disk_pool_name [-dv disk_volume]

Specifies the name of the disk pool, which is the data storage area for this storage unit. Optionally, bpverify verifies the images that reside on the specified disk volume only. This option must be used with the -stype option. The disk pool must already exist.

-hoursago hours

Specifies the number of hours before the current time to search for backups. This number is equivalent to the specification of a start time (-s) of the current time minus hours. Do not use both this option and the -s option.

The hours value is a non-negative integer. The default starting time is 24 hours ago.

-id media_id | path

Search the image catalog for backups to verify that they are on this media ID or pathname. If a backup has some fragments on this media ID and some another media ID, the following occurs: NetBackup verifies a spanning image as long as the backup begins on the media of the media ID that is provided.

For the images that are stored on disk rather than removable media, specify an absolute pathname instead of media_id. The default is any media ID or pathname. BasicDisk uses this option.

-L output_file [-en]

Specifies the name of a file in which to write progress information. The default is not to use a progress file, in which case the progress information is written to stderr. For more information, see DISPLAY FORMATS later in this command description.

Example path for UNIX systems,/usr/openv/netbackup/logs/user_ops

Example path for Windows systems, c:\Program Files\Veritas\NetBackup\logs\user_ops

Include the -en option to generate a log entry in English. The name of the log contains the string _en. This option is useful to the support personnel that assist in a distributed environment where different locales may create logs of various languages.

Only default paths are allowed for this option and It is recommended 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_ALLOWED_PATH option for NetBackup servers and clients" topic in the NetBackup Administrator's Guide, Volume I.

-l

Specifies that the list type is long, which causes bpverify to write additional information to the progress log. The default list type is short. For additional information, see DISPLAY FORMATS later in this command description.

-local

If you initiate bpverify from a host other than the master server and do not use -local (default), the following occurs: bpverify starts a remote copy of the command on the master server.

The remote copy allows the command to be terminated from the Activity Monitor.

Use -local to prevent the creation of a remote copy on the master server and to run bpverify only from the host where it initiated.

If the -local option is used, bpverify cannot be canceled from the Activity Monitor.

-M master_server

Specifies the master server that provides the bpverify image data. The master server must allow access by the system that issued the bpverify command. The default is the master server for the system where bpverify is entered:

For NetBackup Server:

The default is always the master server where the command is entered.

For NetBackup Enterprise Server:

If the command is entered on a master server, then that server is the default.

If the command is entered on a remote media server, then the master for that media server is the default.

-p

Previews the verification, but does not perform the verification. For additional information, see DISPLAY FORMATS later in this command description.

-pb

Previews the verification but does not perform the verification. This option is similar to -p, but -pb does not display information about the individual backups. For additional information, see DISPLAY FORMATS later in this command description.

-policy name

Search for backups to verify in the specified policy. The default is any policy.

-priority number

Specifies a new priority for the verification job that overrides the default job priority.

-pt policy_type

Specifies the policy type for selecting backups to verify. The default is any policy type.

The valid policy types are the following:

BigData
DataStore
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
Hyper-V
Informix-On-BAR
Lotus-Notes
MS-Exchange-Server
MS-SharePoint
MS-SQL-Server
MS-Windows
NBU-Catalog
NDMP
Oracle
SAP
Split-Mirror
Standard
Sybase
Universal-share
Vault
VMware
-s date, -e date

Specifies the start of the range of dates and times that include all backups to verify. The -e option specifies the end of the range.

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 "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 start time is 24 hours ago. The default ending time is the current date and time.

-sl sched_label

Search for backups to verify that the specified schedule created. The default is all schedules.

-st sched_type

Search for backups to verify that the specified schedule type created. The default is any schedule type.

Valid values are:

FULL (full backup)

INCR (differential-incremental backup)

CINC (cumulative-incremental backup)

UBAK (user backup)

UARC (user archive)

NOT_ARCHIVE (all backups except user archive)

-stype server_type

Specifies a string that identifies the storage server type. The server_type value can originate from one of the following sources:

  • Veritas provided storage. Possible values are AdvancedDisk and PureDisk.

  • Third-party disk appliances. The vendor supplies the server_type string.

  • Cloud storage. Use the csconfig cldprovider -l command to determine the possible stype values. The cloud stype values reflect the cloud storage provider. Cloud storage stype values can also incorporate a suffix (for example, amazon_crypt). Possible suffixes are:

    • _raw: The NetBackup backup image is sent to the cloud in raw format. Use this option if you do not want to compress or encrypt data before sending to cloud storage.

    • _rawc: Compresses the data before it is written to the cloud storage.

    • _crypt: Encrypt the data using AES-256 encryption before writing the data to cloud storage. You must have KMS configured in NetBackup to use this option.

    • _cryptc: Compress and encrypt the data before writing to cloud storage.

The storage server type is case sensitive.

-v

Selects the verbose mode. When -v is specified, the debug logs and progress logs include more information. The default is not verbose.

DISPLAY FORMATS

Preview displays:

bpverify runs a preview by searching for backups and then by displaying them in one of the following ways (bpverify does not verify the backups):

  • The -p display lists backup IDs that meet the criteria that the bpverify command-line options set. The -p information appears in volume order. For each volume that contains a selected backup, the media ID and server appear. The selected backup IDs that reside on that volume follow them.

  • The -pb display is a brief version of the -p display. It lists the media ID and server for each volume that contains the backups that meet the selection criteria.

Verification displays:

bpverify creates these displays as it verifies images. If bpverify contains no option to set the list format, the display format is short. If the command line contains -l, the display format is long. If the command line contains both -l and -L, bpverify creates a file that contains the progress log.

The verification list appears in volume order in the following formats:

  • In long format, bpverify displays the following information for each selected backup ID:

    • Policy, schedule, backup ID, media ID or path, and creation time

    • Files that are backed up

    • Any problems that bpverify detects while it verifies the image

    • Whether the image verification is successful or not

  • In short format, bpverify does not list the files that were backed up.

EXAMPLES

Example 1 - Verify the backups that ran in the past 36 hours:

# bpverify -hoursago 36
      Verify started Thu Feb  3 11:30:29 2012
      INF - Verifying policy mkb_policy, schedule Full
  (plim_0949536546), path /tmp/mkbunit, created 02/02/12 18:09:06.
  INF - Verify of policy mkb_policy, schedule Full 
  (plim_0949536546) was successful.
  INF - Status = successfully verified 1 of 1 images.

Example 2 - Compare the two preview displays, -p and -pb:

# bpverify -p -hoursago 2002
Media id = A00002  Server = plim
Bid = plim_0949616279  Kbytes = 32800  Filenum = 1   Fragment = 1
Bid = gava_0949681647  Kbytes = 12191  Filenum = 2   Fragment = 1
Bid = gava_0949683298  Kbytes = 161    Filenum = 3   Fragment = 1
Bid = gava_0949683671  Kbytes = 11417  Filenum = 4   Fragment = 1
Bid = gava_0949684009  Kbytes = 11611  Filenum = 5   Fragment = 1
Bid = gava_0949684276  Kbytes = 806    Filenum = 6   Fragment = 1
Bid = gava_0949688704  Kbytes = 9869   Filenum = 7   Fragment = 1
Bid = gava_0949688813  Kbytes = 9869   Filenum = 8   Fragment = 1
Bid = gava_0949949336  Kbytes = 10256  Filenum = 9   Fragment = 1
Bid = plim_0949949337  Kbytes = 6080   Filenum = 9   Fragment = 1
Bid = plim_0949949337  Kbytes = 4176   Filenum = 10  Fragment = 2
Bid = gava_0949949686  Kbytes = 10256  Filenum = 11  Fragment = 1
Bid = plim_0949949687  Kbytes = 5440   Filenum = 11  Fragment = 1
Bid = plim_0949949687  Kbytes = 4816   Filenum = 12  Fragment = 2

Media id = 400032  Server = plim
Bid = toaster2_0950199621 Kbytes = 298180 Filenum = 1 Fragment = 1
Bid = toaster2_0950199901 Kbytes = 298180 Filenum = 3 Fragment = 1

# bpverify -pb -hoursago 200
Media id = A00002  Server = plim
Media id = 400032  Server = plim

RETURN VALUES

An exit status of 0 means that the command ran successfully. Any exit status other than 0 means that an error occurred.

If the administrative log function is enabled, bpverify logs the exit status in the administrative daily log under the log directory:

UNIX systems:

/usr/openv/netbackup/logs/admin

Windows systems:

install_path\NetBackup\logs\admin

It has the following form:

bpverify: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/error/*
/usr/openv/netbackup/db/images/*

Windows systems:

install_path\NetBackup\logs\admin\*
install_path\NetBackup\db\error\*
install_path\NetBackup\db\images\*