Veritas NetBackup™ Commands Reference Guide
- Appendix A. NetBackup Commands
bpchangeprimary — promote a copy of a backup to be the primary copy
-copy number | -pool volume_pool | -group volume_group [-id backup_id] [-M master_server]
-copy number | -pool volume_pool | -group volume_group [-sl schedule_name] [-pn policy_name] [-st schedule_type] [-pt policy_type] [-cl client_name] [-kw keyword] [-sd date time] [-ed date time] [-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\
The bpchangeprimary command lets you change which copy is the primary copy for a set of backup images. You can choose the copy to be promoted to primary by specifying a copy number, volume pool, or volume group. You can apply several optional criteria to identify the backup images to be affected.
The primary copy of a backup is the copy used by a restore process. Ensure that the primary copy is accessible for restore. For instance, if one copy of a backup was sent off site, change the primary copy to be the copy that remains on site.
The bpchangeprimary command finds all backups that match the specified criteria and updates their copy number to primary. If you use the -copy option, the specified copy number becomes the primary copy. If you use the -group or -pool option, the process identifies all media IDs that belong to the specified volume group or volume pool. It then changes all copies that reside on those media to primary.
One and only one of the following three options is required:
- -copy number
Specifies the number of the backup copy you want to promote to primary.
- -pool volume_pool
Specifies that the copy on the media that belongs to volume_pool is to be promoted to primary.
- -group volume_group
Specifies that the copy on the media that belongs to volume_group is to be promoted to primary.
You can apply combinations of one or more of the following optional criteria to specify which copies are made primary.
- -cl client_name
Specifies that backups of client_name are affected. This name must be as it appears in the NetBackup catalog. For those backup images, this option promotes the copy that corresponds to the specified -pool, -group, or -copy option to primary. The default is all clients.
- -sd date time, -ed date time
Specifies the start date (-sd) or end date (-ed) of the backup images for which the primary copy is changed.
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 information about the locale of your system, see "About specifying the locale of the NetBackup installation" in the NetBackup Administrator's Guide, Volume II.
The default start date is January 1, 1970, which effectively causes a search for all images. If you run bpchangeprimary without using the -sd option, you are prompted to confirm that you want to change the primary copy for the backups that were created after January 1, 1970. The default end date is the current date. The valid range of dates is from 01/01/1970 to 01/19/2038.
- -id backup_id
Specifies the backup ID of the backup image for which the primary copy is changed. For that backup image, -id backup_id changes the copy that corresponds to the specified -pool, -group, or -copy option.
If you specify -id, you can use the -M option to name an alternate master server. Specify -pool, -group, or -copy.
- -kw keyword
Specifies a keyword phrase for NetBackup to use when you identify backup images for which the primary copy is changed.
- -M master_server
Specifies that the backups that belong to master_server are affected. For those backup images, -M master_server promotes the copy that corresponds to the specified -pool, -group, or -copy option to primary.
If you use this option, any other options you specify determine which backup images on the specified master server are affected. The server must allow access by the system that issues the bpchangeprimary command. The default is the master server for the system that runs the bpchangeprimary command.
- -pn policy_name
Specifies the name of the backup policy of the backups for which the primary copy is changed. The default is all policies.
- -pt policy_type
Specifies the type of the backup policies of the backups for which the primary copy is changed. The default is all policy types. The policy_type is one of the following character strings:
Auspex-FastBackup 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
- -sl schedule_name
Specifies the schedule name (label) for the selection of the backup images for which the primary copy is changed. By default, the bpchangeprimary command uses all schedules.
- -st schedule_type
Specifies the schedule type for the selection of the backup images for which the primary copy is changed. By default, bpchangeprimary uses 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)
Example 1 - Promote all copies on the media that belongs to the volume pool
SUN that are created after 08/01/2012 to be the primary copy.
# bpchangeprimary -pool SUN -sd 08/01/2012
Example 2 - Promote copy 2 of all backups of client, oak, created after 01/01/2012 to be the primary copy:
# bpchangeprimary -copy 2 -cl oak -sd 01/01/2012
Example 3 - Promote copy 4 of all backups that the backup policy
Offsite created after 08/01/2011 to be the primary copy:
# bpchangeprimary -copy 4 -pn Offsite -sd 08/01/2011