NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- 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
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- 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
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- 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
- Index
Name
nbholdutil — run the utility that places and removes holds on backup images
SYNOPSIS
-create -holdname hold_name [-reason "string"] -filepath filepath | -backupid backup_ID -primarycopy | -allcopy
-add -holdid hold_id | -holdname hold_name [-reason "string"] -filepath filepath | -backupid backup_ID -primarycopy | -allcopy
-list [-holdid hold_id] | [-holdname hold_name] | [-backupid backup_ID -primarycopy | -allcopy] [-U [-include_extended_info]]
-list -holdname hold_name -U -include_extended_info > bid.txt
-delete -holdid hold_id] | -holdname hold_name [-force] [-reason "string"]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/goodies
On Windows systems, the directory path to this command is install_path\NetBackup\bin\goodies
DESCRIPTION
The nbholdutil utility places holds on backup images. The holds provide a mechanism to override existing retention levels. These holds ensure that backup images and associated media are retained until the holds are released.
nbholdutil performs the following operations:
-create creates a hold on one or more holds for backup images.
-add adds one or more images to an existing hold.
-list outputs a list of all holds. This operation also creates the backup ID (BID) file.
-delete deletes one or more holds.
Only authorized users can run this command.
nbholdutil cannot hold an incremental backup image with zero files. If either a differential or cumulative incremental backup has zero (0) files in the backup image, nbholdutil fails with EXIT STATUS = 1401.
OPTIONS
- -allcopy
Includes all copies of the specified backup image.
- -backupid backup_ID
Specifies the backup ID of the backup image.
- -filepath filepath | -primarycopy | -allcopy
Specifies the file path to the backup image.
- -force
Bypasses a prompt to confirm the release of the hold. This option is useful in a script because it allows the release operations to continue without waiting for a response to the prompt.
- -holdname hold_name
Specifies a unique name for the hold.
- -include_extended_info > bid.txt
Provides more details regarding the images on hold and creates a backup (BID) in which to store the information.
- -primarycopy
Includes only the primary copy of the specified backup image.
- -reason "string"
Indicates the reason for performing this command action. The reason text string that you enter is captured and appears in the audit report. Enclose the string with double quotes ("...") and the string cannot exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').
- -U
Reports in user format which includes additional user information.
EXAMPLES
Example 1 - Create a hold that is called legal_case1. The backup image ID is win81.sky.com_1307425938. The -allcopy option indicates that the hold includes all copies of the selected backup image. If this option is not included, this operation holds only the primary copy of the selected backup image.
# nbholdutil -create -holdname legal_case1 -backupid win81.sky.com_1307425938 -allcopy