Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.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.  
      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.  
      vwcp_manage
    195.  
      vxlogcfg
    196.  
      vxlogmgr
    197.  
      vxlogview
    198.  
      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 .