Veritas NetBackup™ Commands Reference Guide
- Appendix A. NetBackup Commands
bpimage — perform functions on stored images in a database
-[de]compress [-allclients | -client name] [-M master_server,...][-update_compression]
-npc copy_number -backupid backupid [-client name] [-M master_server,...]
-newserver newserver_name [-oldserver oldserver_name] [-id id] [-M master_server,...]
-deletecopy copy_number -backupid backupid [-M master_server,...]
-testlock copy_number -backupid backupid [-M master_server,...]
-prunetir [-allclients | -client name] -cleanup [-notimmediate] [-M master_server,...]
-cleanup_image_change_log [-M master_server,...]
-gendrreport -backupid backupid [-M master_server,...]
-wff path bytes -backupid backupid [-client name] [-M master_server,...]
-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
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.
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.
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.
Deletes expired images, compresses the images that are scheduled to be compressed, and prunes the TIR information from the specified images.
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.
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. 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/.conffile (UNIX) and the
install_path\VERITAS\msg\LC.CONFfile (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.
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.
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.
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.
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
Determines if the copy for the specified backup ID is locked.
Updates an image that is based on the chosen parameter.
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
.ffile) for the backup that is specified with -backupID.
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