Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig
    86.  
      duplicatetrace
    87.  
      importtrace
    88.  
      jbpSA
    89.  
      jnbSA
    90.  
      ltid
    91.  
      mklogdir
    92.  
      nbauditreport
    93.  
      nbcatsync
    94.  
      NBCC
    95.  
      NBCCR
    96.  
      nbcertcmd
    97.  
      nbcertupdater
    98.  
      nbcomponentupdate
    99.  
      nbcplogs
    100.  
      nbdb_admin
    101.  
      nbdb_backup
    102.  
      nbdb_move
    103.  
      nbdb_ping
    104.  
      nbdb_restore
    105.  
      nbdb_unload
    106.  
      nbdbms_start_server
    107.  
      nbdbms_start_stop
    108.  
      nbdc
    109.  
      nbdecommission
    110.  
      nbdelete
    111.  
      nbdeployutil
    112.  
      nbdevconfig
    113.  
      nbdevquery
    114.  
      nbdiscover
    115.  
      nbdna
    116.  
      nbemm
    117.  
      nbemmcmd
    118.  
      nbexecute
    119.  
      nbfindfile
    120.  
      nbfirescan
    121.  
      nbftadm
    122.  
      nbftconfig
    123.  
      nbgetconfig
    124.  
      nbhba
    125.  
      nbholdutil
    126.  
      nbhypervtool
    127.  
      nbjm
    128.  
      nbkmsutil
    129.  
      nboraadm
    130.  
      nbpem
    131.  
      nbpemreq
    132.  
      nbperfchk
    133.  
      nbplupgrade
    134.  
      nbrb
    135.  
      nbrbutil
    136.  
      nbregopsc
    137.  
      nbreplicate
    138.  
      nbrestorevm
    139.  
      nbseccmd
    140.  
      nbsetconfig
    141.  
      nbsnapimport
    142.  
      nbsnapreplicate
    143.  
      nbsqladm
    144.  
      nbstl
    145.  
      nbstlutil
    146.  
      nbsu
    147.  
      nbsvrgrp
    148.  
      resilient_clients
    149.  
      restoretrace
    150.  
      stopltid
    151.  
      tl4d
    152.  
      tl8d
    153.  
      tl8cd
    154.  
      tldd
    155.  
      tldcd
    156.  
      tlhd
    157.  
      tlhcd
    158.  
      tlmd
    159.  
      tpautoconf
    160.  
      tpclean
    161.  
      tpconfig
    162.  
      tpext
    163.  
      tpreq
    164.  
      tpunmount
    165.  
      verifytrace
    166.  
      vltadm
    167.  
      vltcontainers
    168.  
      vlteject
    169.  
      vltinject
    170.  
      vltoffsitemedia
    171.  
      vltopmenu
    172.  
      vltrun
    173.  
      vmadd
    174.  
      vmchange
    175.  
      vmcheckxxx
    176.  
      vmd
    177.  
      vmdelete
    178.  
      vmoprcmd
    179.  
      vmphyinv
    180.  
      vmpool
    181.  
      vmquery
    182.  
      vmrule
    183.  
      vmupdate
    184.  
      vnetd
    185.  
      vxlogcfg
    186.  
      vxlogmgr
    187.  
      vxlogview
    188.  
      W2KOption

Name

bpimage — perform functions on stored images in a database

SYNOPSIS

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:

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.

-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