NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.5)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      backupdbtrace
    3.  
      backuptrace
    4.  
      bmrc
    5.  
      bmrconfig
    6.  
      bmrepadm
    7.  
      bmrprep
    8.  
      bmrs
    9.  
      bmrsrtadm
    10.  
      bp
    11.  
      bparchive
    12.  
      bpbackup
    13.  
      bpbackupdb
    14.  
      bpcatarc
    15.  
      bpcatlist
    16.  
      bpcatres
    17.  
      bpcatrm
    18.  
      bpcd
    19.  
      bpchangeprimary
    20.  
      bpcleanrestore
    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.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configureCerts
    84.  
      configureMQ
    85.  
      configureWebServerCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig reinitialize
    91.  
      csconfig throttle
    92.  
      duplicatetrace
    93.  
      importtrace
    94.  
      jbpSA
    95.  
      jnbSA
    96.  
      ltid
    97.  
      mklogdir
    98.  
      msdpcldutil
    99.  
      nbauditreport
    100.  
      nbcallhomeproxyconfig
    101.  
      nbcatsync
    102.  
      NBCC
    103.  
      NBCCR
    104.  
      nbcertcmd
    105.  
      nbcertupdater
    106.  
      nbcldutil
    107.  
      nbcmdrun
    108.  
      nbcomponentupdate
    109.  
      nbcplogs
    110.  
      nbcredkeyutil
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdb2adutl
    118.  
      nbdbms_start_server
    119.  
      nbdbms_start_stop
    120.  
      nbdc
    121.  
      nbdecommission
    122.  
      nbdelete
    123.  
      nbdeployutil
    124.  
      nbdevconfig
    125.  
      nbdevquery
    126.  
      nbdiscover
    127.  
      nbdna
    128.  
      nbemm
    129.  
      nbemmcmd
    130.  
      nbepicfile
    131.  
      nbfindfile
    132.  
      nbfirescan
    133.  
      nbfp
    134.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nblogparser
    150.  
      nbmariadb
    151.  
      nbmysql
    152.  
      nbmlb
    153.  
      nboraadm
    154.  
      nborair
    155.  
      nboracmd
    156.  
      nbpem
    157.  
      nbpemreq
    158.  
      nbmariadb
    159.  
      nbmlb
    160.  
      nbperfchk
    161.  
      nbpgsql
    162.  
      nbplupgrade
    163.  
      nbrb
    164.  
      nbrbutil
    165.  
      nbreplicate
    166.  
      nbrepo
    167.  
      nbrestorevm
    168.  
      nbseccmd
    169.  
      nbserviceusercmd
    170.  
      nbsetconfig
    171.  
      nbshvault
    172.  
      nbsmartdiag
    173.  
      nbsnapimport
    174.  
      nbsnapreplicate
    175.  
      nbsqladm
    176.  
      nbsqlcmd
    177.  
      nbsqlite
    178.  
      nbstl
    179.  
      nbstlutil
    180.  
      nbstop
    181.  
      nbsu
    182.  
      nbsvrgrp
    183.  
      netbackup_deployment_insights
    184.  
      resilient_clients
    185.  
      restoretrace
    186.  
      stopltid
    187.  
      tldd
    188.  
      tldcd
    189.  
      tpautoconf
    190.  
      tpclean
    191.  
      tpconfig
    192.  
      tpext
    193.  
      tpreq
    194.  
      tpunmount
    195.  
      verifytrace
    196.  
      vltadm
    197.  
      vltcontainers
    198.  
      vlteject
    199.  
      vltinject
    200.  
      vltoffsitemedia
    201.  
      vltopmenu
    202.  
      vltrun
    203.  
      vmadd
    204.  
      vmchange
    205.  
      vmcheckxxx
    206.  
      vmd
    207.  
      vmdelete
    208.  
      vmoprcmd
    209.  
      vmphyinv
    210.  
      vmpool
    211.  
      vmquery
    212.  
      vmrule
    213.  
      vmupdate
    214.  
      vnetd
    215.  
      vssat
    216.  
      vwcp_manage
    217.  
      vxlogcfg
    218.  
      vxlogmgr
    219.  
      vxlogview
    220.  
      W2KOption

Name

bpchangeprimary — promote a copy of a backup to be the primary copy

SYNOPSIS

bpchangeprimary -copy number | -pool volume_pool | -group volume_group [-id backup_id] [-M master_server]

bpchangeprimary -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\

DESCRIPTION

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.

OPTIONS

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/.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 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
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
SAP
Split-Mirror
Standard
Sybase
Universal-share
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)

EXAMPLES

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