Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1)
  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 cldinstance
    86.  
      csconfig cldprovider
    87.  
      csconfig meter
    88.  
      csconfig throttle
    89.  
      duplicatetrace
    90.  
      importtrace
    91.  
      jbpSA
    92.  
      jnbSA
    93.  
      ltid
    94.  
      manageClientCerts
    95.  
      mklogdir
    96.  
      nbauditreport
    97.  
      nbcatsync
    98.  
      NBCC
    99.  
      NBCCR
    100.  
      nbcertcmd
    101.  
      nbcertupdater
    102.  
      nbcldutil
    103.  
      nbcomponentupdate
    104.  
      nbcplogs
    105.  
      nbdb_admin
    106.  
      nbdb_backup
    107.  
      nbdb_move
    108.  
      nbdb_ping
    109.  
      nbdb_restore
    110.  
      nbdb_unload
    111.  
      nbdbms_start_server
    112.  
      nbdbms_start_stop
    113.  
      nbdc
    114.  
      nbdecommission
    115.  
      nbdelete
    116.  
      nbdeployutil
    117.  
      nbdevconfig
    118.  
      nbdevquery
    119.  
      nbdiscover
    120.  
      nbdna
    121.  
      nbemm
    122.  
      nbemmcmd
    123.  
      nbexecute
    124.  
      nbfindfile
    125.  
      nbfirescan
    126.  
      nbftadm
    127.  
      nbftconfig
    128.  
      nbgetconfig
    129.  
      nbhba
    130.  
      nbholdutil
    131.  
      nbhostidentity
    132.  
      nbhostmgmt
    133.  
      nbhypervtool
    134.  
      nbjm
    135.  
      nbkmsutil
    136.  
      nboraadm
    137.  
      nborair
    138.  
      nbpem
    139.  
      nbpemreq
    140.  
      nbperfchk
    141.  
      nbplupgrade
    142.  
      nbrb
    143.  
      nbrbutil
    144.  
      nbregopsc
    145.  
      nbreplicate
    146.  
      nbrestorevm
    147.  
      nbseccmd
    148.  
      nbsetconfig
    149.  
      nbsnapimport
    150.  
      nbsnapreplicate
    151.  
      nbsqladm
    152.  
      nbstl
    153.  
      nbstlutil
    154.  
      nbstop
    155.  
      nbsu
    156.  
      nbsvrgrp
    157.  
      resilient_clients
    158.  
      restoretrace
    159.  
      stopltid
    160.  
      tl4d
    161.  
      tl8d
    162.  
      tl8cd
    163.  
      tldd
    164.  
      tldcd
    165.  
      tlhd
    166.  
      tlhcd
    167.  
      tlmd
    168.  
      tpautoconf
    169.  
      tpclean
    170.  
      tpconfig
    171.  
      tpext
    172.  
      tpreq
    173.  
      tpunmount
    174.  
      verifytrace
    175.  
      vltadm
    176.  
      vltcontainers
    177.  
      vlteject
    178.  
      vltinject
    179.  
      vltoffsitemedia
    180.  
      vltopmenu
    181.  
      vltrun
    182.  
      vmadd
    183.  
      vmchange
    184.  
      vmcheckxxx
    185.  
      vmd
    186.  
      vmdelete
    187.  
      vmoprcmd
    188.  
      vmphyinv
    189.  
      vmpool
    190.  
      vmquery
    191.  
      vmrule
    192.  
      vmupdate
    193.  
      vnetd
    194.  
      vxlogcfg
    195.  
      vxlogmgr
    196.  
      vxlogview
    197.  
      W2KOption

Name

bpimagelist — produce status report on NetBackup images or removable media

SYNOPSIS

bpimagelist [-media] [-l | -L | -U | -idonly] [-tape] [-d date] [-e date] [-hoursago hours] [-keyword "keyword phrase"] [-client client_name] [-server server_name] [-backupid backup_id] [-option INCLUDE_PRE_IMPORT | INCLUDE_TIR | LIST_COMPLETE_COPIES | LIST_OLD_TO_NEW | ONLY_PRE_IMPORT | ONLY_TIR] [-policy policy_name] [-pt policy_type] [-rl retention_level] [-sl sched_label] [-st sched_type] [-class_id class_guid] [-stl_complete] [-stl_incomplete] [-stl_name storage_lifecycle_name] [-M master_server,...] [-inter-domain] [-v]
[-oracle_copilot_ir]

bpimagelist -changelog [-L | -json | -json_compact] [-min_changelog_keykey] [-d mm/dd/yyyy hh:mm:ss] [-e mm/dd/yyyy hh:mm:ss] [-new_images] [-updated_images] [-deleted_images]

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

bpimagelist uses a specified format to report on catalog images or the removable media that matches the attributes that are sent from the command options. bpimagelist reports on the removable media if the -media option is on the command line. If not, it reports on the catalog images.

The bpimagelist -changelog option reports on records in the image change log. You can filter the report to only new images, updated images, or deleted images.

It writes its debug log information to the following directory:

On UNIX systems: /usr/openv/netbackup/logs/admin
On Windows systems: install_path\NetBackup\logs\admin

You can use the information in this directory for troubleshooting.

The output of bpimagelist goes to standard output.

Authorized users can run this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

Note:

For the NetBackup Accelerator feature, bpimagelist reports the amount of data that was transferred over the network for each backup. You can also configure the command to show the transferred data in the field that normally shows the Accelerator backup image size. For details, see the Accelerator topics in the NetBackup Administrator's Guide Volume I, the NetBackup for VMware Administrator's Guide, and the NetBackup for NDMP Administrator's Guide.

OPTIONS

The following are the bpimagelist options:

-backupid backup_id

Specifies a backup ID to use for finding applicable images (applies only to the image list).

-changelog

Reports on the records from the image change log.

-class_id class_guid

Specifies a class identifier to use to select images. The identifier represents a GUID (globally unique identifier ). The bpimagelist command reports only those images with the specified class identifier.

-client client_name

Specifies a client name to use for finding backups or archives to list. The client name that bpimagelist searches for is case insensitive. For example, bpimagelist displays images from client, cLiEnT, and CLIENT. By default, bpimagelist searches for all clients.

-d mm/dd/yy hh:mm:ss, -e mm/dd/yy hh:mm:ss

Specifies the start date and end date range for the listing. If these values are not included on the command line, the default values are as follows:

  • The -d default is the previous midnight.

  • The -e default is the current date and time.

The complete format of the start date and end date is as follows:

-d specifies a start date and time for the listing. The output list shows only images in backups or the archives (or data in the change log for the -changelog option) that occurred at or after the specified date and time.

-e specifies an end date and time for the listing. The output list shows only files from backups or the archives (or data in the change log for the -changelog option) that occurred at or before the specified date and time. Use the same format as for the start date.

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

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.

-hoursago hours

Includes the images that were written up to this many hours ago. This option is equivalent to a specification of a start time (-d) of the current time minus hours. hours must be 1 or greater.

-idonly

Produces an abbreviated list. For an image list, the list contains the creation time, backup ID, and schedule type of each image. For instance, if the list criterion is a window of time, the image list contains the following: For each image that is created in this window, only the creation time, backup ID, and schedule type of the image.

For a media list, the list contains only the applicable media IDs. For instance, if the list criterion is a window of time, the list contains only the media IDs that are written in this window.

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 report is a media report.

-inter-domain

Displays placeholder copies of images that have been replicated from the source and replicated images that are pending import on the target.

-json

Prints the data in json format and spans multiple lines.

-json_compact

Prints the data in json format on a single line.

-keyword "keyword_phrase"

Specifies a keyword phrase for NetBackup to use when it searches. The phrase must match the one that was previously associated with the image. For instance, the -k option of the bpbackup or the bparchive command associates a keyword with the image when the image is created.

-L

Generates the report in Long mode. For instance, for the Media List report, the report lists the information for each media ID as a series of attribute = value pairs. The density value is provided as both a descriptive term and a number. Long mode is the default condition.

-l

Reports in Short mode, which produces a terse listing. This option is useful for the scripts or programs that rework the listing contents into a customized report format.

-M master_server,...

Specifies a list of one or more alternative master servers. This list is a comma-delimited list of hostnames. If this option is present, each master server in the list runs the bpimagelist 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 return. bpimagelist 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 bpimagelist command.

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

-media

Specifies that the listing reports on the removable media that are based on a set of criteria. If -media is not in the command line, the report is on images, not media.

-min_changelog_key key

Prints records with the specified log key and newer. Newer change log entries have greater change log key values.

[-new_images] [-updated_images] [-deleted_images]

Limits the change log report to new, updated, or deleted images. The default condition is to report all change log images.

-option option_name,...

Specifies one or more criteria for finding images to list. option_name is one of the following character strings in uppercase or lowercase:

  • INCLUDE_PRE_IMPORT - Report the images that completed phase 1 of an import.

  • INCLUDE_TIR - Report the images that true-image-recovery backups created.

  • LIST_COMPLETE_COPIES - Do not report fragments of a duplicate copy that is still in process.

  • LIST_OLD_TO_NEW - Report images by oldest to newest date.

  • ONLY_PRE_IMPORT - Report only the images that completed phase 1 of an import.

  • ONLY_TIR - Report only the images that true-image-recovery backups created.

The default is no restrictions on the selected images.

-oracle_copilot_ir

Searches for and displays the images that may be used for Oracle Copilot Instant Recovery.

-policy name

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

-pt policy_type

Specifies a policy type. By default, bpimagelist searches for all policy types.

The policy_type is one of the following character strings:

BigData
DataStore
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
FlashBackup-Windows
Hyper-V
Informix-On-BAR
LotusNotes
MS-Exchange-Server
MS-SharePoint
MS-SQL-Server
MS-Windows
NDMP
Oracle
PureDisk-Export
SAP
Split-Mirror
Standard
Sybase
Vault
VMware
-rl retention_level

Specifies the retention_level. The retention_level is an integer between 0 and 100. By default, bpimagelist searches for all retention levels.

Note:

If you run this command on a pre-NetBackup 8.0 media server, you can only specify a retention level between 0 and 24.

-server server_name

Specifies the name of a NetBackup server or ALL. If -server specifies a server name, then the images or media in the report are only those that reside on that server. The images also satisfy the other criteria that bpimagelist specifies. For instance, if -hoursago 2 is specified, the media must contain an image that was created in the past two hours.

The query goes to the image catalog that resides on the local master server. The master server must allow access by the system running bpimagelist.

The default is to report all media in the image catalog on the local master server, which is equivalent to the specification of -server ALL.

-sl sched_label

Specifies a schedule label for the image selection. The default is all schedules.

-st sched_type

Specifies a schedule type for the image selection. The default is any schedule type. Valid values are as follows:

  • FULL (full backup)

  • INCR (differential-incremental backup)

  • CINC (cumulative-incremental backup)

  • UBAK (user backup)

  • UARC (user archive)

  • NOT_ARCHIVE (all backups except user archive)

-stl_complete

Reports only the images that the storage lifecycle completely processed. This option cannot be used with the stl_incomplete option.

-stl_incomplete

Reports only the images that the storage lifecycle has not completely processed. This option cannot be used with the stl_complete option.

-stl_name storage_lifecycle_name

Specifies a storage lifecycle name to be used when you select images. Only images with the specified storage lifecycle name are selected.

-tape

Displays in the list only the images that have at least one fragment that resides on removable or tape-based media. Any disk-based fragments in these images are ignored. If an image has fragments on both tape and disk, this option displays only the tape-based fragments.

-U

Generates the report in User mode. The report is formatted. It includes a banner that lists the column titles. The status is a descriptive term instead of a number.

-v

Selects the verbose mode. This option causes bpimagelist to log additional information for debugging purposes. The information goes into the NetBackup administration daily debug log. This option is meaningful only when the debug log function is enabled; that is, when the following directory is defined:

UNIX systems: /usr/openv/netbackup/logs/admin

Windows systems: install_path\NetBackup\logs\admin

EXAMPLES

Example 1 - Show the last time the media IDs available to the server had a backup image that was written during the specified time:

# bpimagelist -media -d 01/05/2012 18:00:46 -e 01/06/2012 23:59:59 
-U
    Media ID   Last Written       Server
    --------   ----------------   ----------
    IBM000     01/06/2012 01:06   hatt
    AEK800     01/06/2012 03:01   hatt
    C0015      01/06/2012 02:01   hatt
    143191     01/05/2012 23:00   hatt

Example 2 - List all images that were written today:

# bpimagelist -U
Backed Up        Expires     Files     KB C Sched Type   Policy
---------------  -------- -------- ------ - ------------ ----------
01/27/2012 01:08 02/03/2012  1122  202624 N Full Backup  3590Grau
01/27/2012 01:01 02/03/2012  1122  202624 N Full Backup  IBM35pol
01/27/2012 03:01 02/03/2012   531 1055104 N Full Backup  DELLpol
01/27/2012 02:01 02/03/2012   961   31776 N Full Backup  QUALpol
01/27/2012 01:08 02/03/2012  2063  603328 N Full Backup  IBM35pol
01/27/2012 01:01 02/03/2012  2063  603328 N Full Backup  3590Grau

Example 3 - List all the images that the storage lifecycle has not completely processed that were written today:

# bpimagelist -U -stl_incomplete -idonly
Time:     12/6/2011 1:03:46 PM   ID: escape_1323198226         FULL (0)
Time:    12/6/2011 12:48:22 PM   ID: gordito19_1323197302      INCR (1)
Time:     12/6/2011 1:02:42 PM   ID: louisebl8vm1_1323198162   FULL (0)
Time:     12/6/2011 1:03:28 PM   ID: monterrey_1323198208      FULL (0)
Time:     12/6/2011 1:03:10 PM   ID: oprahbl14vm3_1323198190   FULL (0)
Time:     12/6/2011 1:03:11 PM   ID: oprahbl14vm4_1323198191   FULL (0)
Time:     12/6/2011 1:03:12 PM   ID: oprahbl15vm3_1323198192   FULL (0)
Time:     12/6/2011 1:03:17 PM   ID: oprahbl15vm4_1323198197   FULL (0)
Time:     12/6/2011 1:02:22 PM   ID: oprahbl8vm5_1323198142    FULL (0)
Time:     12/6/2011 1:02:41 PM   ID: thelmabl1vm1_1323198161   FULL (0)
Time:     12/6/2011 1:02:54 PM   ID: thelmabl1vm2_1323198174   FULL (0)
Time:     12/6/2011 1:03:01 PM   ID: thelmabl2vm1_1323198181   FULL (0)

Example 4 - List all the incomplete images that were written today for the pem_tort policy:

# bpimagelist -U -stl_incomplete -policy pem_torture

Backed Up         Expires    Files      KB  C  Sched Type  ...  Policy
----------------  ---------- ----- -------  -  ------------   ---------
12/06/2011 13:03  12/12/2011    86    1632  N  Full Backup ... pem_tort
12/06/2011 13:02  12/12/2011    12   12512  N  Full Backup ... pem_tort
12/06/2011 13:03  12/12/2011     5      32  N  Full Backup ... pem_tort
12/06/2011 13:03  12/12/2011  3742   95936  N  Full Backup ... pem_tort
12/06/2011 13:03  12/12/2011  3762   95936  N  Full Backup ... pem_tort
12/06/2011 13:03  12/12/2011     8      64  N  Full Backup ... pem_tort
12/06/2011 13:03  12/12/2011     9      32  N  Full Backup ... pem_tort
12/06/2011 13:02  12/12/2011  5041  223104  N  Full Backup ... pem_tort
12/06/2011 13:02  12/12/2011     6      32  N  Full Backup ... pem_tort
12/06/2011 13:02  12/12/2011  3559   95808  N  Full Backup ... pem_tort
12/06/2011 13:03  12/12/2011     5      32  N  Full Backup ... pem_tort

Example 5 - List the new and updated change log entries entered since May 2, 2012:

# bpimagelist -changelog -new_images -updated_images -d 05/02/2012 10:18:00 
-json
Image Change Log Key:      2
Backup ID:                 jumpmanvm2_1335967123
Client Type:               Standard (0)
Image Change Log Oper. Id: Updated (2)
Image Change Log Time:     Wed 02 May 2012 10:39:09 AM CDT (1335973149)

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/log.mmddyy
/usr/openv/netbackup/db/images

Windows systems:

install_path\NetBackup\logs\admin\log.mmddyy
install_path\NetBackup\db\images

SEE ALSO

See bp.

See bparchive.

See bpbackup.

See bprestore.