NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  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.  
      backupdbtrace
    3.  
      backuptrace
    4.  
      bmrc
    5.  
      bmrconfig
    6.  
      bmrepadm
    7.  
      bmrprep
    8.  
      bmrs
    9.  
      bmrsrtadm
    10.  
      bp
    11.  
      bparchive
    12.  
      bpbackup
    13.  
      bpbackupdb
    14.  
      bpcatarc
    15.  
      bpcatlist
    16.  
      bpcatres
    17.  
      bpcatrm
    18.  
      bpcd
    19.  
      bpchangeprimary
    20.  
      bpcleanrestore
    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.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configureCerts
    84.  
      configureMQ
    85.  
      configureWebServerCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig reinitialize
    91.  
      csconfig throttle
    92.  
      duplicatetrace
    93.  
      importtrace
    94.  
      jbpSA
    95.  
      jnbSA
    96.  
      ltid
    97.  
      mklogdir
    98.  
      msdpcldutil
    99.  
      nbauditreport
    100.  
      nbcallhomeproxyconfig
    101.  
      nbcatsync
    102.  
      NBCC
    103.  
      NBCCR
    104.  
      nbcertcmd
    105.  
      nbcertupdater
    106.  
      nbcldutil
    107.  
      nbcmdrun
    108.  
      nbcomponentupdate
    109.  
      nbcplogs
    110.  
      nbcredkeyutil
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdb2adutl
    118.  
      nbdbms_start_server
    119.  
      nbdbms_start_stop
    120.  
      nbdc
    121.  
      nbdecommission
    122.  
      nbdelete
    123.  
      nbdeployutil
    124.  
      nbdevconfig
    125.  
      nbdevquery
    126.  
      nbdiscover
    127.  
      nbdna
    128.  
      nbemm
    129.  
      nbemmcmd
    130.  
      nbepicfile
    131.  
      nbfindfile
    132.  
      nbfirescan
    133.  
      nbfp
    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.  
      nboracmd
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmariadb
    155.  
      nbmlb
    156.  
      nbperfchk
    157.  
      nbplupgrade
    158.  
      nbrb
    159.  
      nbrbutil
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbshvault
    167.  
      nbsmartdiag
    168.  
      nbsnapimport
    169.  
      nbsnapreplicate
    170.  
      nbsqladm
    171.  
      nbsqlite
    172.  
      nbstl
    173.  
      nbstlutil
    174.  
      nbstop
    175.  
      nbsu
    176.  
      nbsvrgrp
    177.  
      netbackup_deployment_insights
    178.  
      resilient_clients
    179.  
      restoretrace
    180.  
      stopltid
    181.  
      tldd
    182.  
      tldcd
    183.  
      tpautoconf
    184.  
      tpclean
    185.  
      tpconfig
    186.  
      tpext
    187.  
      tpreq
    188.  
      tpunmount
    189.  
      verifytrace
    190.  
      vltadm
    191.  
      vltcontainers
    192.  
      vlteject
    193.  
      vltinject
    194.  
      vltoffsitemedia
    195.  
      vltopmenu
    196.  
      vltrun
    197.  
      vmadd
    198.  
      vmchange
    199.  
      vmcheckxxx
    200.  
      vmd
    201.  
      vmdelete
    202.  
      vmoprcmd
    203.  
      vmphyinv
    204.  
      vmpool
    205.  
      vmquery
    206.  
      vmrule
    207.  
      vmupdate
    208.  
      vnetd
    209.  
      vssat
    210.  
      vwcp_manage
    211.  
      vxlogcfg
    212.  
      vxlogmgr
    213.  
      vxlogview
    214.  
      W2KOption

Name

nbperfchk — measures a disk array's or a network's read and write speeds

SYNOPSIS

nbperfchk -i option -o option [-s filesize] [-syncend] [-bs buffersize] [-directio] [-n number_of_buffers] [-nr] [-q] [-rc] [-ri interval] [-rp] [-v]

On UNIX systems, the directory path to this command is /usr/openv/pdde/pdag/bin/

On Windows systems, the directory path to this command is install_path\Veritas\pdde\

DESCRIPTION

The nbperfchk command measures the read speed and write speed of a disk array. You can use this command to test the read speed and the write speed of the disks that host deduplicated data. For example, you can measure the speeds of the disks that host deduplicated data.

The nbperfchk command measures the read speed and write speed of either a disk array or a network. You can use this command to test the read speed and the write speed of the disks that host deduplicated data. For example, you can measure the speeds of the disks that host deduplicated data.

In a NetBackup Media Server Deduplication Pool (MSDP), use this command to measure the speed of the disks that are attached to the media server. The media server can be running any operating system that Veritas supports for media servers and MSDPs.

Note:

Veritas recommends that you work with a Veritas technical support staff member when you run this command and interpret its results. Veritas recommends a minimum disk performance level of 130 MB/sec for deduplicated read and write operations.

The nbperfchk utility enables you to write a test file to a disk, read back that test file, and observe the read speeds attained during the read operation. You can use the results from nbperfchk to make sure that the ReadBufferSize parameter is set appropriately in your backup environment. The ReadBufferSize parameter resides in the [CRDataStore] section of the contentrouter.cfg file. You can use this command as follows:

  • Use the following command to write data to the disks:

    nbperfchk -i inputpath -o outputpath -s filesize -syncend

  • Use the following command to read data from the disks:

    nbperfchk -i inputpath -o outputpath -bs buffersize

  • Use the following commands to test network between computers A and B:

  • A: nbperfchk -i zero: -o tcp::port

    B: nbperfchk -i tcp:computer_A_ip_address:port -o null:

For additional details on the use of the nbperfchk command, see:

https://www.veritas.com/support/en_US/article.100038623

OPTIONS

-bs buffersize

For buffersize, specify the read buffer size to use when nbperfchk runs. For example, 64k or 128k.

-directio

Use this option to minimize input and output cache effects with the file specified. In general, this option degrades performance, but helps when applications perform their own caching. File input and output are done directly to and from the user-space buffers.

-i inputpath

The -i option lets you provide input to the nbperfchk command. You can provide one of the input options shown:

  • File: -i inputpath

    For inputpath, specify the full path to an input file. The nbperfchk command reads this file and generates information about the read speed when this file is read to disk.

  • Network: -i tcp:ip:port

    You can omit the IP information to indicate the use of a local IP address. Use the format tcp::port to omit the IP address.

  • Generate data: -i data_format:

    This input generates: all zero data (-i zero:), random data (-i random:), or sequence data (-i seq:). Be aware the trailing colon (:) is required.

-n

Specifies the number of buffers. The minimum value is 1 and the maximum value is 255. By default, this option is set to 255.

Use this option if the command fails due to insufficient memory. Reduce the number of buffers with this option to reduce the memory usage of the command.

-nr

This option suppresses the test details and shows only the final report when the command exits.

-o outputpath

The -o option lets you specify output options for the nbperfchk command. You can provide one of the output options shown:

  • File: -o filename

    For filename, specify the full path to an output file. The nbperfchk command writes this file and generates information about the write speed when this file is written to disk.

  • Network: -o tcp:ip:port

    You can omit the IP information to indicate the use of a local IP address. Use the format tcp::port to omit the IP address.

  • Null data: -o null:

    To discard all the output, use -o null:

-q

Use this option to disable all log displays. When you use TCP for network testing, if you are not concerned about the server or the client situation and don't want the information continuously displayed, use this option. This option suppresses all logging information, including the final report.

-rc

If you specify this option, the report is displayed in compact mode with no line feeds.

-ri

The report interval for the command. The value is shown in seconds. The minimum value is 1 and the maximum value is 300. The default is 3.

-rp

This option is the report probe option. It displays the buffers status in the report test details. When conducting TCP testing, use this option to view the buffer status of the server and the client. Use this information to determine if the issue is a server or a client issue.

-s filesize

For filesize, specify a file size that is equal to or larger than the combined memory size of your computer plus the amount in the disk array. A file of this size ensures that the data is written to disk and not to a buffer.

-syncend

The syncend parameter flushes the buffer and writes all data to disk.

-v

Use this option to confirm the data the client receives is correct. This option is helpful to determine if there is any packet loss in the transfer process. Use this option with the -i option. If you do not use the -i option, the verification fails.

PROCEDURES

To analyze nbperfchk results and adjust the ReadBufferSize parameter setting

  1. Log on as the root user (UNIX) or the administrator (Windows) on the computer that hosts the content router.

    In NetBackup environments, log on to the media server.

  2. Change to a test directory.
  3. Type the nbperfchk command in the following format to write a large test file to the content router:
    nbperfchk -i inputpath -o outputpath -s filesize -syncend

    For example, the following command writes a 64-GB data file that contains all zeros to the e drive:

    nbperfchk -i zero: -o e:\data1 -s 64g -syncend
    
  4. Type the nbperfchk command in the following format to read the test file and observe the read speeds in the nbperfchk output:
    nbperfchk -i inputpath -o NULL -bs buffersize

    Example 1. To observe several read speeds with several buffer sizes, type the following series of commands:

    nbperfchk -i e:\data1 -bs 64k -o NULL
    nbperfchk -i e:\data1 -bs 128k -o NULL
    nbperfchk -i e:\data1 -bs 256k -o NULL

    Example 2. The following nbperfchk command reads back the data in file data1 and uses a buffer size of 1024 KB:

    C:\Users\administrator.mymediaserver\Desktop>nbperfchk -i e:\data1 -bs 1024k -o NULL
         195 MB @   65.3 MB/sec,      194 MB @   64.9 MB/sec
         295 MB @   49.4 MB/sec,      100 MB @   33.5 MB/sec
         403 MB @   44.8 MB/sec,      108 MB @   35.8 MB/sec
         505 MB @   42.1 MB/sec,      102 MB @   34.1 MB/sec
         599 MB @   40.0 MB/sec,       94 MB @   31.3 MB/sec
         705 MB @   39.2 MB/sec,      106 MB @   35.5 MB/sec
         821 MB @   39.2 MB/sec,      116 MB @   38.8 MB/sec
         943 MB @   39.4 MB/sec,      122 MB @   40.8 MB/sec
        1024 MB @   40.1 MB/sec

    Observe the following when you analyze the data:

    • The left two columns show the amount of data read and the average read speed.

      For the bolded information in the example shown, the amount of data read is 403 MB. The average read speed is 44.8 MB/sec.

    • The right two columns show the average read speed in the last 3 seconds of each read.

      For the bolded information in the example shown, the average amount of data that was read in the last three seconds is 108 MB. The average read speed for the last three seconds is 35.8 MB/sec.

      Unless these numbers vary drastically from read to read, you can disregard the right two columns.

    • The final line shows the overall read speed.

      In the example shown, final line is the 1024 MB @ 40.1 MB/sec information. In this example, the overall read speed for this test is 40.1 MB/sec.

      This line is the most important line in the output because it shows you how fast the total read occurred with the buffer size you specified.

  5. Analyze your read speeds and adjust the ReadBufferSize parameter if necessary.

    Your operating system, your disk speeds, and the ReadBufferSize parameter setting all affect restore and rehydration performance.

    Veritas recommends that you type several nbperfchk commands and increase the size of the argument to the -bs parameter each time. Example 1 in step 4 shows this method. If you can enter ever-increasing arguments to the -bs parameter, you can probably increase the size of the ReadBufferSize parameter in the [CRDataStore] section of the contentrouter.cfg file.

    By default, ReadBufferSize=65536, which is 64K. Veritas testing shows that ReadBufferSize=1048576, which is 1024 X 1024, or 1M, offers good performance on most Windows systems. On most UNIX systems, Veritas testing shows that ReadBufferSize=65536 (the default) offers good performance.

    For information about how to edit NetBackup configuration files, see the NetBackup documentation.