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

NBCC — run the NetBackup consistency check (NBCC) utility.

SYNOPSIS

NBCC [-batch] [-debug] [-gather] [-help] [-idar] [-kbfree ####] [-locale locale_name] [-nozip] [-nocleanup] [-terse] [-upgrade] {-use_reg_cmd [32 | 64]] [-version] [-unknown_image_servers_option]

 

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

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

DESCRIPTION

The NBCC command executes the NBCC utility that is used to confirm the integrity of portions of the NetBackup catalog and databases, including the following elements:

  • Tape media and associated images

  • The NBDB image, ImageCopy table records, ImageFragment table records, and the image catalog

  • Enterprise Media Manager (EMM) server entries and configured storage unit entries

If NBCC detects catalog inconsistencies, it generates a set of output files. It can create a support package bundle of these files by using available system utilities.

These inconsistencies include the images whose associated media servers are not known to the EMM database. In these cases, you can use the -unknown_image_servers_option feature to select one of the following options: comment out, expire, or let a known media server inherit the images associated with these unknown media servers.

For more about the NBCC utility, see the NetBackup Troubleshooting Guide.

OPTIONS

-batch

Runs NBCC in a non-interactive mode. In this mode, the following occurs:

  • If the output report already exists, NBCC automatically overwrites it.

  • After the processing of bpimagelist information, any media servers that EMM does not know about are flagged. The full analysis then generates all repairs to be commented out for later review.

  • If NBCC detects no NetBackup catalog inconsistencies, it does not create a support package.

-debug

Adds additional program debug information to the nbcc-info.txt file, which greatly increases the size of this file.

-gather

Gathers NetBackup configuration and catalog information only. This option does not check NetBackup catalog consistency.

-help

Outputs a more expanded version of help information about the NBCC utility.

-idar

Includes the identification of the abandoned tape media resources in the consistency check.

-kbfree freespace

Specifies the amount of free file system space that is required to run NBCC. Only whole numbers are allowed. The default value is located in the help output.

The NBCC default is: Free file system space (Kilobytes)= 2048000.

To skip all free file system space checking, set this value to zero (0) to run in a non-English locale environment.

-locale locale_name

Designates the NetBackup common_local_name. NBCC searches for this name in the following file:

On UNIX: /usr/openv/msg/.conf

On Windows: .\VERITAS\msg\LC_CONF

This name determines the associated date format to use with the bpimagelist -d command line option.

-nocleanup

If NBCC runs the consistency checks with no inconsistencies detected, it does not clean up the resultant support package or files.

Note:

Do not use the -nocleanup option and the -gather option together. They are mutually exclusive because of the consistency check state.

-nozip

Skips the creation of a support package bundle. The generated NBCC files remain in the output directory.

-terse

Extracts only the fields that are associated with the consistency checks from each catalog record into the individual catalog content files.

-unknown_image_servers_option

Designates the action that the consistency analysis takes for any media server that is detected in the image database that is unknown to the EMM. option is one of the following values:

  • comment_all - Comments out all Suggested Repair Actions (SRAs) that the analysis program generates that are related to the images associated with an unknown media server. Thus, NBCCR does not try to process these commented-out repairs.

  • expire_all - The SRAs that the analysis program generates for NBCCR to process expire all images that are associated with any unknown media servers.

  • inherit_all hostname - Designates a known media server (hostname) to replace the unknown server. This new server inherits all the images that are associated with any unknown media server. The analysis program generates these SRA items for NBCCR to process.

    For example, the following command lets media server MS1 inherit all the images that are associated with any unknown media servers.

    # NBCC -unknown_image_servers_inherit_all MS1
-upgrade

Includes only the consistency checks that relate to the ability to upgrade the NetBackup catalog.

-use_reg_cmd [32 | 64]

Enables the use of the Reg.exe utility to query the Windows registry. The version of Reg.exe that supports the /reg:32 or the /reg:64 command line parameters must be installed so that this option works correctly.

This option operates only on Windows systems.

-version

Outputs the internal version number of NBCC.

PREREQUISITES

The following items are needed before you can use the NBCC utility:

  • For NBCC to create a support package (if required), the path to the following programs must be included in the $PATH environment variable: tar and gzip.

    If tar is not available, use the makecab program (if available) to bundle and compress the output files.

    If these programs are unavailable and you need a single support package file, manually bundle the files in the output directory into a support package.

  • If you do not use the command line option -kbfree 0, NBCC inspects file system usage characteristics. Then it unloads the configuration information and catalog information and creates a support package. This information includes available free file system space (in Kilobytes). (Refer to the -kbfree option description.)

  • The EMM server must be operational.

  • The vmd process must run on the master server and on all other servers that act as the EMM server in the NetBackup configuration.

  • The bpdbm process must run on the master server.

  • On the installed NetBackup, all media servers and the ltid process must be running, and the network services must be configured.

  • The UTC time on all servers in the NetBackup configuration and the server where the NBCC utility is run, must be synchronized within a few minutes of each other.

    Note:

    Failure to ensure that the clocks are synchronized may cause NBCC to report inaccurate results.

PROGRAM USAGE

The following are program usage considerations:

  • NBCC runs from the support directory (see synopsis). If you want to run from a different directory, NBCC uses the following default directory location:

    On UNIX: /usr/openv/netbackup/bin/support/config

    On Windows: install_path\NetBackup\bin\support\

  • To ensure that catalog consistency problems are identified and fixed correctly, verify the following: No NetBackup jobs are running or started from the time when the data is collected until the time when the repair work is completed. Because this condition is not possible in most configurations, NBCC tries to identify the tape media that are associated with active NetBackup jobs. Due to the propagation delay that may occur during normal processing, not all active tape media may be identified. Hence, you should carefully review the consistency analysis results.

  • NBCC detects EMM master servers. If more than one master server is detected, NBCC identifies the one that is associated with the system on which NBCC runs. NBCC uses the identified EMM master server to determine which EMM media servers are associated with that master server.

RETURN VALUES

The following exit values are returned:

0 = Consistency checks skipped (-gather)
    No inconsistency detected

1 = Inconsistency detected

2 = Program error condition detected:

    Invalid command line option
    .nbcc.lock file exists
    File permission problem
    File open/read/write problem
    Insufficient free disk space
    Unable to obtain the version of NetBackup
    Issue with NetBackup configuration information/detection
    Issue with NetBackup catalog information/detection

3 = -help information displayed
    -version information displayed

SEE ALSO

See NBCCR.

See nbcplogs.

See nbsu .