Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- msdpimgutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhsmcmd
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tiermover
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
NBCC — run the NetBackup consistency check (NBCC) utility.
SYNOPSIS
[-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.txtfile, 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/.confOn Windows:
.\msg\LC_CONFThis 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.exeutility to query the Windows registry. The version ofReg.exethat 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/configOn 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