bpimagelist

bpimagelist — produce status report on NetBackup images or removable media

SYNOPSIS

<admin_dir_path>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_service_name] [-M master_server,...] [-v]

On Windows systems, <admin_dir_path> 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.

It writes its debug log information to the following directory:

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 information about NetBackup authorization, refer to the NetBackup Administrator's Guide.

OPTIONS

The following is the bpimagelist report-type option:

-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.

The following are the bpimagelist report-format options:

-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.

-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.

-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.

-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.

-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.

-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.

    Refer to the bpimport command description or the NetBackup Administrator's Guide for more information.

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

    Refer to the bpcpinfo command description or the NetBackup Administrator's Guide for more information on this topic.

  • 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.

-backupid backup_id

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

-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. This name must be as it appears in the NetBackup catalog. By default, bpimagelist searches for all clients.

-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.

-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.

-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.

-pt policy_type

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

Informix-On-BAR
MS-Exchange-Server
MS-SQL-Server
MS-SharePoint
MS-Windows-NT
NetWare
Oracle
OS/2
Standard
Sybase
NDMP

Note that the following policy types apply only to the NetBackup Enterprise Server:

AFS
DataTools-SQL-BackTrack
DB2
Enterprise-Vault
FlashBackup
SAP
Split-Mirror
-rl retention_level

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

-d date, -e date

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

-d specifies a start date and time for the listing. The output list shows only images in backups or the archives 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 that occurred at or before the specified date and time. Use the same format as for the start date. The default is the current date and time.

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.

The required date and time values format in NetBackup commands varies according to your locale. The /user/openv/msg/.conf file (UNIX and Linux) 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.

See the "Specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II.

The following is part of the -help USAGE statement for -bpimagelist that shows the -d and -e options:

[-d mm/dd/yy hh:mm:ss] [-e mm/dd/yy hh:mm:ss]

-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.

-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)

-policy name

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

The following are other bpimagelist options:

-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.

-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:

Windows systems: install_path\NetBackup\logs\admin

EXAMPLES

EXAMPLE 1

The first example shows the last time each media ID available to a server had a backup image that was written today:

# bpimagelist -media -U
	Media ID   Last Written	 Server
	--------   ----------------   ----------
	IBM000	 01/06/2009 01:06   hatt
	AEK800	 01/06/2009 03:01   hatt
	C0015	01/06/2009 02:01   hatt

EXAMPLE 2

The following example shows 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/2007 18:00:46 -e 01/06/2007 23:59:59 
-U
	Media ID   Last Written	 Server
	--------   ----------------   ----------
	IBM000	 01/06/2007 01:06   hatt
	AEK800	 01/06/2007 03:01   hatt
	C0015	01/06/2007 02:01   hatt
	143191	 01/05/2007 23:00   hatt

EXAMPLE 3

The following example lists all images that were written today:

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

EXAMPLE 4

The following example lists media written information for 01/05/2006:

# bpimagelist -media -d 01/05/2006 -e 01/05/2006 -U
	Media ID   Last Written	 Server
	--------   --------------   ----------
	IBM000	 01/05/2010 01:13   hatt
	143191	 01/05/2010 23:00   hatt
	AEK800	 01/05/2010 03:07   hatt
	C0015	01/05/2010 02:06   hatt

FILES

Windows systems:

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

SEE ALSO

bp (UNIX and Linux systems), bparchive, bpbackup, bprestore