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

nbdb2adutl — used to query or extract DB2 backup images from the NetBackup catalog

SYNOPSIS

nbdb2adutl query logs {db|database db_name} [inst inst_name] [partition n|all] [between sn1 and sn2] [chain n|all] [browse_client browse_client_name]

nbdb2adutl extract logs {db|database db_name} [inst inst_name] [partition n|all] [between sn1 and sn2] [chain n|all] [browse_client browse_client_name]

nbdb2adutl query {db|database db_name} [inst inst_name] [partition n|all] [full|tablespace] [nonincremental|incremental|delta] [taken at timestamp] [browse_client browse_client_name]

nbdb2adutl extract {db|database db_name} [inst inst_name] [partition n|all] [full|tablespace] [nonincremental|incremental|delta] taken at timestamp [browse_client browse_client_name]

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

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

DESCRIPTION

Use the nbdb2adutl command to interact with the DB2 backup images found in the NetBackup catalog.

When you use the query option, the command queries the NetBackup catalog for DB2 backups. The inst option is only required when the instance name (DB2INSTANCE) is not found in the environment.

When you use the extract option, the command restores DB2 database backup images and archive logs from NetBackup to the user's current working directory. Existing database backup images and log files are not overwritten. For this reason, be careful when you use all with either partition or chain.

By default, the original user, or any user from the same group has access to the backup images. NetBackup image permissions are set at backup time using the BKUP_IMAGE_PERM option. See the NetBackup for DB2 Administrator's Guide for more information.

Before you run the nbdb2adutl command, you must run the bpnbat - login - loginType WEB command. The bpnbat command authenticates your web services logon. The user that is specified when you run bpnbat -login -loginType WEB should be a member of an RBAC role with Assets, DB2, View, and Recover permissions.

You can use the filter types listed here for backup type or incremental type:

OPTIONS

between sn1 and sn2

Identifies the range of archive log sequence numbers. The specified sequence numbers are inclusive in the range. If the option is omitted, all sequence numbers that meet the specified criteria are returned.

browse_client client_name

Identifies the name of the client where the backups were performed. Used for alternate client restores. Primary server must be configured for alternate client restore. That is altnames, etc. If not specified, the browse client is determined from the bp.conf.

chain n | all

Identifies the archive log chain number. Use all to indicate that you want all chain numbers included. The default value is 0.

db database_name

Name of the database.

delta

Include only the incremental delta backup images in the query or extract.

extract

Identifies that a restore operation is to be performed.

full

Include only the full database backup images in the query or extract.

incremental

Include only the incremental backup images in the query or extract.

inst instance_name

Name of the instance. The option is required if the name of the instance cannot be obtained from the DB2INSTANCE environment value.

logs

Identifies that the DB2 archive logs are the object.

nonincremental

Include only the non-incremental backup images in the query or extract.

partition n | all

Identifies the DB2 database partition. Use all to specify all partition numbers. The default is 0.

query

Used to search the NetBackup catalog for DB2 archive log backups.

tablespace

Include only the tablespace backup images in the query or extract.

taken at date-time

Used to specify the timestamp of a backup image in query and extract operations. The timestamp is displayed after successful completion of a backup operation and is part of the path name for the backup image. The timestamp format is yyyymmddhhmmss. This parameter is required for the extract operation and optional for the query operation. If the parameter is not specified for a query operation, the output is not timestamp limited.

You can specify a partial timestamp. For example, if the backup images with timestamps 20241201130130 and 20241202130130 exist, if you specify 20241202 the operation uses the 20241202130130 image.

EXAMPLES

Example 1: Query all the logs for a database named sample where the instance is prod, the partition is 0, and the chain is 0.

nbdb2adutl query logs db sample inst prod

Example 2: Query log sequence numbers 5 to 10 for the sample database, where the instance is prod, the partition is 0 and the chain is 0. Instance prod is found in the environment.

nbdb2adutl query logs db sample between 5 and 10

Example 3: Restore log sequence numbers 5 to 10 for the sample database, where the instance is prod, the partition is 0, and the chain is 0.

nbdb2adutl extract logs db sample inst prod between 5 and 10

Example 4: Alternate client restore log sequence number 5 to 10 for the sample database from the production server prodbox.sample.com, where instance is prod, the partition is 0, and chain is 0.

nbdb2adutl extract logs db sample inst prod between 5 and 10 
browse_client prodbox.sample.com

Example 5: Query all the database backup images that were taken on March 25, 2024 for the sample database, the instance is prod, the partition is 0.

nbdb2adutl query db sample inst prod taken at 20240325

Example 6: Restore all the database backup images that were taken at 1:45:03 on March 25, 2024 for the sample database, the instance is prod, the partition is 0.

nbdb2adutl extract db sample inst prod taken at 20240325124503

SEE ALSO

See bplist.

See bpnbat.