bpimage

bpimage — perform functions on stored images in a database

SYNOPSIS

admin_dir_pathbpimage -[de]compress [-allclients | -client name]

admin_dir_pathbpimage [-M master_server,...,master_server]

admin_dir_pathbpimage -npc copy # -backupid backupid [-client name]

admin_dir_pathbpimage -newserver newserver_name [-oldserver oldserver_name] [-id id]

admin_dir_pathbpimage -deletecopy # -backupid backupid

admin_dir_pathbpimage -testlock # -backupid backupid

admin_dir_pathbpimage -prunetir [-allclients | -client name] -cleanup

admin_dir_pathbpimage -create_image_list -client name

admin_dir_pathbpimage -index index_number -client name

admin_dir_pathbpimage -wff path_bytes -backupid backupid [-client name]

admin_dir_pathbpimage -update [-secinfo 0|1 | -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]

On Windows systems, admin_dir_path is <install_path>\NetBackup\bin\

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.

  • Create an image list file that can be used to qualify an image.

  • Index a client.

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.

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

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

-create_image_list

Creates an image_list file and an image_info file that can be used quickly to qualify an image.

-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 /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 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 #

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.

-id id

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

-index n

Indexes the database. The n variable is the index level and has a range from 1 to 9. A value of 9 provides the most optimum index. This option applies only to ASCII.

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

-objdesc string

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

-newserver name | -oldserver name

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

-npc copy #

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.

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

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

-secinfo 0|1

Use the Extended Security information on the NetWare client type.

-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
NetWare
Oracle
OS/2
Standard
Sybase
NDMP

The following policy types apply only to NetBackup Enterprise Server:

AFS
DataTools-SQL-BackTrack
DB2
FlashBackup
SAP
Split-Mirror
-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.