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

bperror — display NetBackup status and troubleshooting information or entries from NetBackup error catalog

SYNOPSIS

bperror {-S | -statuscode status_code} [-r | -recommendation] [[-p Unx | NTx] | [-platform Unx | NTx]] [-v]

bperror [-all | -problems | -media | tape] {-backstat [-by_statcode]} [-L | -l | -U] [-columns ncols] [-d date | -hoursago hours] [-e date] [-client client_name] [-server server_name] [-jobid job_id] [-M master_server,...] [-v]

bperror [-s {severity[+]}|severity ...] [-t type ...] [-dt disk_type] [-L | -l | -U] [-columns ncols] [-d date | -hoursago hours] [-e date] [-client client_name] [-server server_name] [-jobid job_id] [-M master_server,...] [-v]

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

bperror displays information from either the same source as the online troubleshooter (in the Activity Monitor or Reports applications) or from the NetBackup error catalog. bperror provides the following types of displays:

  • A display of the message that corresponds to a status code and, optionally, a recommendation on how to troubleshoot the problem. In this case, the display results come from the same source as the online troubleshooter for the local system.

  • A display of the error catalog entries that satisfy the command-line options. For instance, bperror can display all the problem entries for the previous day.

  • A display of the error catalog entries that correspond to a particular message severity and message type.

For information on details of the displays, see DISPLAY FORMATS later in this command description.

bperror writes its debug log information to the following directory:

On Windows systems: install_path\NetBackup\logs\admin

On UNIX systems: /usr/openv/netbackup/logs/admin

You can use the information in this directory for troubleshooting.

The output of bperror goes to standard output.

OPTIONS

-all, -backstat [-by_statcode], -media, -problems

These options specify the type and severity of log messages to display. The default type is ALL. The default severity is ALL.

-all: The type is ALL, and severity is ALL. Run bperror with this option and with -U to produce an All Log Entries report.

-backstat: The type is BACKSTAT, and severity is ALL. If -by_statcode is present, the display contains one entry for each unique status code. Line 1 of the entry contains the status code and the corresponding message text. Line 2 of the entry contains the list of clients for which this status code occurred. -by_statcode is only valid when the command line contains both -backstat and -U. Run bperror with this option and with -U to produce a Backup Status report.

-media: The type is MEDIADEV, and severity is ALL. Run bperror with this option and with -U produces a Media Logs report.

-problems: The type is ALL, and severity is the union of WARNING, ERROR, and CRITICAL. Run bperror with this option and with -U to produce a Problems report.

-client client_name

Specifies the name of a NetBackup client. This name must be as it appears in the NetBackup catalog. By default, bperror searches for all clients.

-columns ncols

For the -L and -U reports, -columns provides an approximate upper bound on the maximum line length. bperror does not try to produce lines exactly ncols characters in length.

-columns does not apply to the -l report.

ncols must be at least 40. The default is 80.

-d date, -e date

Specifies the start date and end date range for the listing.

-d specifies a start date and time (optional) for the listing. The resulting list shows only images in the backups or archives that occurred at or after the specified date-time. The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07. The default is 24 hours before the current date and time.

-e specifies an end date and time (optional) for the listing. The resulting list shows only files from backups or the archives that occurred at or before the specified date and time. Use the same format for the start date. The default is the current date and time. The end date must be greater than or equal to the start date.

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 following is a typical format for the -d and -e options:

[-d mm/dd/yyyy hh:mm:ss | -hoursago hours]
[-e mm/dd/yyyy hh:mm:ss]
-dt disk_type

Enables the user to specify a disk type. The following are the valid values for disk_type:

0 - All

1 - BasicDisk

3 - SnapVault

6 - DiskPool

-hoursago hours

Specifies a start time of many hours ago, which is equivalent to specifying a start time (-d) of the current time minus hours. Hours is an integer. The default is 24, which is a start time of 24 hours before the current time.

-jobid job_id

Specifies a NetBackup job ID. By default, bperror searches for all job IDs.

-L

Reports in long format.

-l

Reports in short format. This report produces a terse listing. This option is useful for scripts or the programs that rework the listing contents into a customized report format. This option is the default list type.

-M master_server,...

Specifies a comma-separated list of one or more hostnames. The command is run on each of the master servers in this list. The master servers must allow access by the system that issues the command. If an error occurs for any master server, the process stops at that point in the list. The default is the master server for the system where the command is entered.

-p Unx | NTx, -platform Unx | NTx

Displays the message that applies to the platform (UNIX or Windows) for the specified status code. The default is to display the message for the platform on which bperror is running. The -S or -statuscode option must be specified when you use this option.

-r | -recommendation

Displays the recommended action for the specified status code from the NetBackup Status Codes Reference Guide. The default is not to display the recommendation. The -S or -statuscode option must be specified when you use this option.

-S status_code, -statuscode status_code

Displays the message that corresponds to the status code. This option has no default condition.

-s severity, -s severity+

Specifies the severity of log messages to display. The defined values are ALL, DEBUG, INFO, WARNING, ERROR, and CRITICAL.

You can specify severity in two ways. The first way is a list of one or more severity values. For instance, "-s INFO ERROR" displays the messages with either severity INFO or severity ERROR. The delimiter must be a blank (" ") between the elements in the list. The second way is a single severity value with "+" appended, which is this severity or greater. For instance "-s WARNING+" displays the messages with severity values WARNING, ERROR, and CRITICAL.

The default is ALL. The severity value can be in uppercase or lowercase.

-server server_name

Specifies the name of a NetBackup server. This name must be as it appears in the NetBackup catalog. The display is limited to the messages that are logged for this server, which also satisfies the criteria for any other bperror options. For example, if -server plim and -hoursago 2 are bperror options, the display contains the messages that were logged for plim in the past two hours.

The server name must match the server name that was recorded in the log messages. For example, if the logs record the server name as plim.null.com, -server plim does not display the logs, but -server plim.null.com does.

The query goes to the error catalog which resides on either the local master server or the master server that -M specifies. The master server must allow access by the system that runs bperror.

The default is to display log messages for all media servers that are known to the master server(s).

-t type

Specifies the type of log messages to display. The defined values are ALL, BACKSTAT, MEDIADEV, GENERAL, BACKUP, ARCHIVE, RETRIEVE, and SECURITY. The default is ALL. The type value can be upper or lower case. It is entered as a list of one or more values. For instance, -t BACKSTAT MEDIADEV displays the messages with either type BACKSTAT or type MEDIADEV. The delimiter between the list elements must be a blank (" ").

-U

Reports in user format. NetBackup report-generating tools such as the NetBackup-Java Reports application uses this report.

-v

Verbose mode. This option causes bperror to log additional information for the debugging purposes that go into the NetBackup-administration daily debug log. -v is meaningful only when NetBackup has debug logs enabled (install_path\NetBackup\logs\admin/usr/openv/netbackup/logs/admin directory defined). The default is to not be verbose.

DISPLAY FORMATS

The following are display formats of the bperror command:

  • Status code display (for example, bperror -S status_code):

    bperror queries the NetBackup online troubleshooter on the local system for the message that corresponds to the status code. bperror displays the message text on one line and an explanation on a second line.

    If -r is an option, bperror also queries for the troubleshooting recommendation that corresponds to the status code. bperror displays the recommendation following the status message, on one or more lines.

  • Error catalog display (for example, bperror -all; bperror -s severity):

    bperror queries the NetBackup error catalog on either the local master server or the master servers in the -M option list. The display consists of the results that are returned from querying the error catalog on the master server(s). The results are limited to catalog the entries that satisfy all the bperror options. For example, the bperror command line may contain options for client, start time, and end time. If so, then bperror reports only the jobs that are run for that client between the start time and end time.

    The display variant that shows individual message entries from the error catalog can appear in long (-L), user (-U), or short (-l) format. The display variant that categorizes by status code can appear in user (-U) format only. The following is the display content for each of these formats:

  • Error catalog display, individual message entries, long format (for example, bperror -media -L). This report produces several lines per log entry, with the following contents:

    Field 1: Date and time - Number of seconds since 1/1/1970

    Field 2: NetBackup version - The NetBackup version in use

    Field 3: Error type - Media numeric identifiers of the error

    Field 4: Log entry type - 2=Debug, 4=Info, 8=Warning, 16=Error, 32=Critical

    Field 5: Server - Server name

    Field 6: Job ID

    Field 7: Group job ID

    Field 8: Unused

    Field 9: NetBackup process - Name of the NetBackup process that does the logging

    Field 10: Client name

    Field 11: Policy name

    Field 12: Schedule type - The type of schedule being run for the backup

    0=FULL, 1=INCR, 2=CINC, 3=UBAK, 4=UARC

    Field 13: Exit status - The status when the backup was completed

  • Error catalog display, individual message entries, user format (for example, bperror -media -U). The user format produces a header line that shows column names, and one or more lines per log entry with these contents:

    Line 1: Date and time

    Server

    Client

    Text (at the start of the log message, continued on subsequent lines if needed)

  • Error catalog display, individual message entries, short format (for example, bperror -media -l). The short format produces a single line per log entry, with the following contents:

    Line 1: Time (internal system representation)

    NetBackup version

    Type code (decimal)

    Severity code (decimal)

    Server

    Job ID

    Job Group ID

    An unused field

    Client

    Who

    Text (the entire log message text, with no truncation of the line length)

  • Error catalog display that the status code categorizes. This display reports only each unique status code, instead of listing every log entry for that status code (for example, bperror -backstat -by_statcode -U). This option produces two or more lines per status code, with the following contents:

    Line 1: Status code

    Text (the beginning of the log message text, continued on subsequent lines if necessary)

    Line 2: The list of clients for which this status occurred.

EXAMPLES

Example 1 - Display the error for a job that failed because the NetBackup encryption package was not installed. Status code 9 is the NetBackup status code for this failure. The second run of bperror displays the action that is recommended for NetBackup status code 9.

# bperror -d 12/23/2012 16:00:00 -e 12/23/2012 17:00:00 -t backstat 
-U
STATUS CLIENT    POLICY    SCHED    SERVER    TIME COMPLETED 
9      plim      dhcrypt   user     plim      12/23/2012 16:38:09
an extension package is needed, but was not installed
# bperror -S 9 -r
an extension package is needed, but was not installed
A NetBackup extension product is required in order to perform the 
requested operation.
Install the required extension product.

Example 2 - Report the problems in the User format that have occurred in the previous 24 hours.

# bperror -U -problems
        TIME            SERVER CLIENT - TEXT
11/23/2012 16:07:39 raisins - no storage units configured
11/23/2012 16:07:39 raisins - scheduler exiting - failed reading 
storage unit database information (217)
11/23/2012 16:17:38 raisins - no storage units configured
11/23/2012 16:17:38 raisins - scheduler exiting - failed reading 
storage unit database information (217)
11/23/2012 18:11:03 raisins nut bpcd on nut exited with status 59: 
access to the client was not allowed
11/23/2012? 18:11:20 raisins - WARNING: NetBackup database backup is 
currently disabled

Example 3 - The following example displays status for type backstat for the jobs that are run in the previous 24 hours. The option -by_statcode produces a display that is organized by status code.

The display shows that one or more jobs for each of the clients chive, gava, and raisins have completed successfully (the status code is 0). In addition, one or more jobs for client nut have failed because nut did not allow access by the master server or media server. (The status code is 59.)

# bperror -U -backstat -by_statcode
         0   the requested operation was successfully completed
             chive gava raisins
         59   access to the client was not allowed 
               nut

Example 4 - Identify and retrieve the results for a particular user job. It first lists the log entries with job IDs other than zero. It then runs a User-format report on the job of interest.

# bperror -hoursago 2012 -L | grep 'S:' | egrep 'J\:[1-9]'
12/21/2012 17:24:14 V1 S:plim C:plim J:1 (U:0,0)
12/23/2012 16:31:04 V1 S:plim C:plim J:1 (U:0,0)
12/23/2012 16:38:04 V1 S:plim C:plim J:3 (U:0,0)
# bperror -d 1/7/2007 -jobid 34 -U
     TIME            SERVER CLIENT - TEXT
01/07/2012 13:12:31 plim plim started backup job for client plim, 
policy jdhcrypt, schedule user on storage unit jdhcrypt
01/07/2012 13:12:40 plim plim successfully wrote backup id 
plim_0947272350,copy 1, fragment 1, 32 Kbytes at 11.057 Kbytes/sec
01/07/2012 13:12:41 plim plim CLIENT plim POLICY jdhcrypt SCHED user 
EXIT STATUS 0 (the requested operation was successfully completed)

Example 5 - Show media entries in the error catalog for the past 2000 hours.

bperror -hoursago 2000 -media -U
        TTIME            SERVER CLIENT - TEXT
12/23/2012 16:31:04 plim plim  Media Manager terminated during mount 
of media id A00000, possible media mount timeout
12/24/2012 04:31:20 plim -  media id A00000 removed from Media 
Manager database (manual deassign)

Example 6 - Report and add up the total number of bytes backed up in the past 24 hours.

bperror -all -hoursago 24 | grep "successfully wrote backup id | awk 
'{bytes= bytes + $20} END {print "backed up",bytes," Kbytes of 
data"}'
backed up 64  Kbytes of data
up",bytes," Kbytes of data"}'