NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.5)
  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.  
      nblogparser
    150.  
      nbmariadb
    151.  
      nbmysql
    152.  
      nbmlb
    153.  
      nboraadm
    154.  
      nborair
    155.  
      nboracmd
    156.  
      nbpem
    157.  
      nbpemreq
    158.  
      nbmariadb
    159.  
      nbmlb
    160.  
      nbperfchk
    161.  
      nbpgsql
    162.  
      nbplupgrade
    163.  
      nbrb
    164.  
      nbrbutil
    165.  
      nbreplicate
    166.  
      nbrepo
    167.  
      nbrestorevm
    168.  
      nbseccmd
    169.  
      nbserviceusercmd
    170.  
      nbsetconfig
    171.  
      nbshvault
    172.  
      nbsmartdiag
    173.  
      nbsnapimport
    174.  
      nbsnapreplicate
    175.  
      nbsqladm
    176.  
      nbsqlcmd
    177.  
      nbsqlite
    178.  
      nbstl
    179.  
      nbstlutil
    180.  
      nbstop
    181.  
      nbsu
    182.  
      nbsvrgrp
    183.  
      netbackup_deployment_insights
    184.  
      resilient_clients
    185.  
      restoretrace
    186.  
      stopltid
    187.  
      tldd
    188.  
      tldcd
    189.  
      tpautoconf
    190.  
      tpclean
    191.  
      tpconfig
    192.  
      tpext
    193.  
      tpreq
    194.  
      tpunmount
    195.  
      verifytrace
    196.  
      vltadm
    197.  
      vltcontainers
    198.  
      vlteject
    199.  
      vltinject
    200.  
      vltoffsitemedia
    201.  
      vltopmenu
    202.  
      vltrun
    203.  
      vmadd
    204.  
      vmchange
    205.  
      vmcheckxxx
    206.  
      vmd
    207.  
      vmdelete
    208.  
      vmoprcmd
    209.  
      vmphyinv
    210.  
      vmpool
    211.  
      vmquery
    212.  
      vmrule
    213.  
      vmupdate
    214.  
      vnetd
    215.  
      vssat
    216.  
      vwcp_manage
    217.  
      vxlogcfg
    218.  
      vxlogmgr
    219.  
      vxlogview
    220.  
      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 .