Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (9.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.  
      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.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    103.  
      nbcallhomeproxyconfig
    104.  
      nbcatsync
    105.  
      NBCC
    106.  
      NBCCR
    107.  
      nbcertcmd
    108.  
      nbcertupdater
    109.  
      nbcldutil
    110.  
      nbcloudrestore
    111.  
      nbcomponentupdate
    112.  
      nbcplogs
    113.  
      nbcredkeyutil
    114.  
      nbdb_admin
    115.  
      nbdb_backup
    116.  
      nbdb_move
    117.  
      nbdb_ping
    118.  
      nbdb_restore
    119.  
      nbdb_unload
    120.  
      nbdb2adutl
    121.  
      nbdbms_start_server
    122.  
      nbdbms_start_stop
    123.  
      nbdc
    124.  
      nbdecommission
    125.  
      nbdelete
    126.  
      nbdeployutil
    127.  
      nbdevconfig
    128.  
      nbdevquery
    129.  
      nbdiscover
    130.  
      nbdna
    131.  
      nbemm
    132.  
      nbemmcmd
    133.  
      nbfindfile
    134.  
      nbfirescan
    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.  
      nbregopsc
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbsmartdiag
    167.  
      nbsnapimport
    168.  
      nbsnapreplicate
    169.  
      nbsqladm
    170.  
      nbstl
    171.  
      nbstlutil
    172.  
      nbstop
    173.  
      nbsu
    174.  
      nbsvrgrp
    175.  
      netbackup_deployment_insights
    176.  
      resilient_clients
    177.  
      restoretrace
    178.  
      stopltid
    179.  
      tldd
    180.  
      tldcd
    181.  
      tpautoconf
    182.  
      tpclean
    183.  
      tpconfig
    184.  
      tpext
    185.  
      tpreq
    186.  
      tpunmount
    187.  
      verifytrace
    188.  
      vltadm
    189.  
      vltcontainers
    190.  
      vlteject
    191.  
      vltinject
    192.  
      vltoffsitemedia
    193.  
      vltopmenu
    194.  
      vltrun
    195.  
      vmadd
    196.  
      vmchange
    197.  
      vmcheckxxx
    198.  
      vmd
    199.  
      vmdelete
    200.  
      vmoprcmd
    201.  
      vmphyinv
    202.  
      vmpool
    203.  
      vmquery
    204.  
      vmrule
    205.  
      vmupdate
    206.  
      vnetd
    207.  
      vssat
    208.  
      vwcp_manage
    209.  
      vxlogcfg
    210.  
      vxlogmgr
    211.  
      vxlogview
    212.  
      W2KOption
  3.  
    Index

Name

nbrbutil — configures the NetBackup Resource Broker (nbrb)

SYNOPSIS

nbrbutil [-cancel GUID] [-changePriority requestID] [-changePriorityClass requestID] [-changesettings name=value [,name=value],...] [-deleteSetting settingname] [-disablePerfMon] [-dump] [-dumptables -f filename] [-enablePerfMon] [-listActiveJobs] [-listActiveDriveJobs] [-listActiveMediaJobs] [-listActivePoolJobs] [-listActiveStuJobs] [-listOrphanedDrives] [-listOrphanedMedia] [-listOrphanedPipes] [-listOrphanedStus] [-listSettings] [-release GUID] [-resetAll] [-releaseAllocHolds] [-releaseDrive drive] [-releaseMDS ID] [-releaseMedia mediaID] [-releaseOrphanedDrive drivekey] [-releaseOrphanedMedia mediakey] [-releaseOrphanedPipes] [-releaseOrphanedStu name] [-resetMediaServer mediaserver] [-reportInconsistentAllocations] [-resume] [-setDriveGroupUnjoinable] [-setMediaGroupUnjoinable] [-suspend] [-syncAllocations]

nbrbutil - listPipes [-verbose] [-jobid jobid][-pipe pipeid][-pipeState PIPE_AVAILABLE | PIPE_UNALLOCATED | PIPE_CLIENT_ORHPANED | PIPE_SERVER_ORPHANED | PIPE_ORPHANED | PIPE_ACTIVE | PIPE_SHUTDOWN_REQUEST | PIPE_SHUTDOWN_READ | PIPE_SHUTDOWN_WRITE]

 

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

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

DESCRIPTION

The NetBackup Resource Broker utility sets up the following Resource Broker functionality:

  • List the allocations that the Resource Broker has handed out.

  • Release an allocation.

  • View the list of orphaned resources.

  • Display the jobs that use a particular resource (drive, media, storage unit)

  • Cancel a request that has not been allocated.

  • Set the Resource Broker tuning parameters.

  • Suspend and resume the process.

  • List all Fibre Transport pipes.

OPTIONS

-cancel GUID

Cancels the allocation request within the given identifier.

-changePriority requestID -priority priority

Changes the request priority.

-changePriorityClass requestID -priorityClass priorityClass

Changes the request priority class.

-changesettings name=value [,name=value]...

Adds or changes the nbrb configuration settings.

The following describes all the -changesettings parameters:

  • RB_DO_INTERMITTENT_UNLOADS - When this parameter is set to true (default), nbrb initiates unloads of the drives that have exceeded the media unload delay. Drives become available more quickly to jobs that require different media servers or different media than the job that last used the drive. However, the loaded media or drive pair may not be available for jobs with less priority in the prioritized evaluation queue that can use the drive or media without unload.

  • RB_ENABLE_OPTIMIZATION - When this parameter is set to true, it serves as a performance tuning parameter for the Intelligent Resource Manager. This entry instructs NBRB to cache states of resource requests.

  • RB_RESPECT_REQUEST_PRIORITY - Possible values for this parameter are true or false.

    When RB_RESPECT_REQUEST_PRIORITY is set to false (default), nbrb continues to evaluate jobs in the prioritized job queue. As a result, a job is likely to reuse a drive more quickly after the drive has been released. However, some lower priority jobs may receive drives before higher priority jobs.

    When the parameter is set to true, nbrb restarts its evaluation queue at the top of the prioritized job queue after resources have been released.

  • RB_BREAK_EVAL_ON_DEMAND - When a high priority request appears, nbrb immediately interrupts the evaluation cycle. The request can be a tape span request, a subsequent request for a synthetic or a duplication job, or a read request for an optimized duplication. If required, nbrb releases and unloads drives before the evaluation cycle begins again.

    If the RB_BREAK_EVAL_ON_DEMAND parameter is set to true (default), interruptions of high priority jobs are not allowed and the evaluation cycle continues.

  • RB_MAX_HIGH_PRIORITY_QUEUE_SIZE - Spanning requests and additional resources for an active duplication job are put in a special queue for priority processing. The RB_MAX_HIGH_PRIORITY_QUEUE_SIZE parameter sets the maximum number of requests that NetBackup allows in that queue. (Default: 100 requests.)

  • RB_RELEASE_PERIOD - This parameter indicates the interval that NetBackup waits before it releases a resource. (Default: 180 seconds.)

  • RB_CLEANUP_OBSOLETE_DBINFO - This parameter indicates the number of seconds that can elapse between the cleanup of obsolete information in the nbrb database. (Default: 60 seconds.)

  • RB_MPX_GROUP_UNLOAD_DELAY - This parameter indicates the number of seconds that nbrb waits for a new job to appear before a tape is unloaded. (Default: 10 seconds.)

    This setting can help avoid unnecessary reloading of tapes and applies to all backup jobs. During user backups, nbrb uses the maximum value of RB_MPX_GROUP_UNLOAD_DELAY and the Media mount timeout host property setting when nbrb unmounts the tape.

  • RB_RETRY_DELAY_AFTER_EMM_ERR - This parameter indicates how long NetBackup waits after an EMM error before it tries again. The error must be one where a retry is possible. For example, if a media server is down. (Default: 60 seconds.)

  • RB_REEVAL_PENDING - This parameter indicates the number of seconds that can elapse between evaluations of the pending request queue. For example, a pending request queue can include, jobs awaiting resources. (Default: 60 seconds.)

  • RB_REEVAL_PERIOD - This parameter indicates the time between evaluations if an outstanding request is not satisfied, and if no other requests or resources have been released. (Default: Five minutes must pass before the initial request is reevaluated.)

-deleteSetting settingname

Deletes the nbrb configuration setting identified by the settingname value.

-disablePerfMon

Disables the Performance Monitoring.

-dump

Dumps all nbrb allocation and request lists.

-dumptables -f filename

Enables the Resource Broker (nbrb) to log its internal state in the specified file name.

-enablePerfMon

Enables the Performance Monitoring.

-jobid jobid

Restricts the output listing of Fibre Transport pipes to only those used for the specified jobid.

-listActiveJobs

Lists all the active jobs.

-listActiveDriveJobs

Lists all the active jobs for a drive.

-listActiveMediaJobs

Lists all the active jobs for a media ID (disk or tape).

-listActivePoolJobs

Lists all the active jobs for a volume pool.

-listActiveStuJobs

Lists all the active jobs for a storage unit or a storage unit group.

-listOrphanedDrives

Lists the drives that are reserved in EMM but have no corresponding allocation in the Resource Broker.

-listOrphanedMedia

Lists the media that is reserved in EMM but has no corresponding allocation in the Resource Broker.

-listOrphanedPipes

Lists the orphaned Fibre Transport pipes.

-listOrphanedStus

Lists the storage units that are reserved in EMM but have no corresponding allocation in the Resource Broker.

-listPipes

Lists the information about Fibre Transport pipes.

-listSettings

Lists the NBRB configuration settings.

-pipe pipeID

Restricts the output of Fibre Transport pipes to only those with the matching pipeID value.

-pipeState state

Restricts the output listing of Fibre Transport pipes to only the pipes in specified state.

-release GUID

Releases the allocation with the given identifier.

-resetAll

Resets all nbrb allocations, requests, and persisted states.

-releaseAllocHolds

Releases allocation holds caused by allocation errors for drives and media.

-releaseDrive drive

Releases all allocations for the specified drive.

-releaseMDS ID

Releases the EMM and the MDS allocations that are allocated by the MDS with the specified identifier.

-releaseMedia mediaID

Releases all allocations for the specified volume.

-releaseOrphanedDrive drivekey

Releases drives that are reserved in EMM but have no corresponding allocation in the Resource Broker.

-releaseOrphanedMedia mediakey

Releases media that are reserved in EMM but have no corresponding allocation in the Resource Broker.

-releaseOrphanedPipes

Releases the orphaned Fibre Transport pipes.

-releaseOrphanedStu name

Releases the storage units that are reserved in EMM but have no corresponding allocation in the Resource Broker.

-resetMediaServer mediaserver

Resets all nbrb EMM and MDS allocations that are related to ltid on the media server.

-reportInconsistentAllocations

Reports inconsistent allocation between the Resource Broker and MDS.

-resume

Resumes the Resource Broker (nbrb) processing.

-setDriveGroupUnjoinable

Disables the future job from joining the group for this drive.

-setMediaGroupUnjoinable

Disables the future job from joining the group for this media.

-suspend

Suspends the Resource Broker (nbrb) processing.

-syncAllocations

Syncs up any allocation difference between the Resource Broker and MDS.

-verbose

Provides a more detailed information for Fibre Transport pipes.

SEE ALSO

See nbjm.

See nbpem.