Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  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.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    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.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

bpimage — perform functions on stored images in a database

SYNOPSIS

bpimage -[de]compress [-allclients | -client name] [-M master_server,...][-update_compression]

bpimage -npc copy_number -backupid backupid [-client name] [-M master_server,...]

bpimage -newserver newserver_name [-oldserver oldserver_name] [-id id] [-M master_server,...]

bpimage -deletecopy copy_number -backupid backupid [-M master_server,...]

bpimage -testlock copy_number -backupid backupid [-M master_server,...]

bpimage -prunetir [-allclients | -client name] -cleanup [-notimmediate] [-M master_server,...]

bpimage -cleanup_image_change_log [-M master_server,...]

bpimage -gendrreport -backupid backupid [-M master_server,...]

bpimage -wff path bytes -backupid backupid [-client name] [-M master_server,...]

bpimage -update [-rfile 0|1 | -filesysonly 0|1 | -numfiles number | -keyword keyword_phrase | -objdesc string] [-client name -policy name -t type -d mm/dd/yyyy hh:mm:ss] [-id id] [-M master_server,...]

 

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

This command can be used to perform many different functions to images that are stored in a database. Some of the functions are as follows:

  • Compress and decompress the stored images.

  • Remove existing images from the database.

  • Test the locking capability on an image.

OPTIONS

The following options represent the criteria that determine which images or media are selected for the report. Where images are discussed in these options, media can be substituted if the context refers to a media report.

-allclients

Selects all NetBackup clients that are already backed up on the system.

-backupid backup_id

Specifies a backup ID to use for finding applicable images.

-cleanup

Deletes expired images, compresses the images that are scheduled to be compressed, and prunes the TIR information from the specified images.

Note:

This option enables a user to accomplish the same tasks manually that the scheduler performs on a regular basis. It can be used when the user does not have enough time to wait for the scheduler to perform these tasks.

-cleanup_image_change_log

Cleans up the image change on the current master server and optionally, on other master servers that are specified by the -M option.

-client name

Specifies a client name to use for finding backups or archives on which to perform the specified function. The client name that bpimage searches for is case insensitive. For example, bpimage displays images from client, cLiEnT, and CLIENT. By default, bpimage searches for images on all clients.

-d date

Specifies the start date and end date range for the listing.

-d specifies a start date and time for the listing. The list shows only images in backups or the archives that occurred at or after the specified date and time.

The required date and time values format in NetBackup commands varies according to your locale. The /usr/openv/msg/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.

For more about the locale of your system, see "About specifying the locale of the NetBackup installation" in the NetBackup Administrator's Guide, Volume II.

The valid range of dates is from 01/01/1970 00:00:00 to 01/19/2038 03:14:07. The default is the previous midnight.

-[de]compress

Initiates compression or decompression of a specified client or all clients.

-deletecopy copy_number

Removes the images that the copy number and the backup_id specify.

-filesysonly 0|1

Limits bpimage to query only the local file system if set to 1.

-gendrreport

Generate a disaster recovery report for the specified backup_id.

-id id

Specifies the media ID when used with the -newserver command or specifies the backup ID when used with the -update command.

-keyword "keyword_phrase"

Specifies a keyword phrase for NetBackup to use when it searches. The phrase must match the phrase that was previously associated with the image.

-M master_server,...

Specifies a list of alternative master servers. This list is a comma-delimited list of hostnames. Each master server in the list runs the bpimage command. If an error occurs for any master server, the process stops at that point.

The report is the composite of the information that all the master servers in this list returns. bpimage queries each of these master servers. The master server returns image or media information from the image catalogs. Each master server must allow access by the system that issues the bpimage command.

The default is the master server for the system running bpimage.

-newserver name | -oldserver name

Specifies the new name or the old name of a NetBackup server.

-notimmediate

Inhibits the call that bpexpdate makes to the nbdelete command after it expires an image on disk. If you intend to delete many images at the same time, use -notimmediate to avoid the overhead of multiple job creation fornbdelete to process. You can run the nbdelete command later.

-npc copy_number

Sets the specified image as the primary image, which is based on the copy number of the image.

-numfiles number

Specifies the number of files when used with the -update command.

-objdesc string

Specifies the object description string of the Informix client type when used with the -update command.

-policy name

Searches for backups to import in the specified policy. The default is all policies.

-prunetir

Prunes the true image restore (TIR) information from the specified clients. The default is all clients.

-rfile 0|1

Use the Restore file when used with the -update command.

-t type

Specifies a policy type. By default, bpimage searches for all policy types. type is one of the following character strings:

Informix-On-BAR 
MS-Exchange-Server
MS-SQL-Server
MS-Windows
Oracle
Standard
Sybase
NDMP

The following policy types apply only to NetBackup Enterprise Server:

BigData
DataTools-SQL-BackTrack
DB2
FlashBackup
SAP
Split-Mirror
-testlock

Determines if the copy for the specified backup ID is locked.

-update

Updates an image that is based on the chosen parameter.

-update_compression

Tells NetBackup to uncompress the images that were compressed with the old compression algorithm and recompress them with the new algorithm. The -update_compression flag only applies used with the -compress option.

A new compression algorithm was deployed with NetBackup 7.6. With the old algorithm, the NetBackup .f files have a file name extension of .Z on Linux or UNIX. With the new algorithm, they have either a .Zs or .Zl extension. The .Zs extension designates the files that are compressed with user-specified scripts and is only used on Linux and UNIX. The .Zl extension is for the files that are compressed internally by NetBackup and is used on Windows, Linux, and UNIX platforms.

-wff path bytes

Writes the files file (image .f file) for the backup that is specified with -backupID.

EXAMPLES

Example: This example determines if the specified copy for the backup ID is locked.

# bpimage -testlock 1 -backupid abc123.server.domain.com_1416316372
Backupid abc123.server.domain.com_1416316372 copy 1 is not locked