Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig
    86.  
      duplicatetrace
    87.  
      importtrace
    88.  
      jbpSA
    89.  
      jnbSA
    90.  
      ltid
    91.  
      mklogdir
    92.  
      nbauditreport
    93.  
      nbcatsync
    94.  
      NBCC
    95.  
      NBCCR
    96.  
      nbcertcmd
    97.  
      nbcertupdater
    98.  
      nbcomponentupdate
    99.  
      nbcplogs
    100.  
      nbdb_admin
    101.  
      nbdb_backup
    102.  
      nbdb_move
    103.  
      nbdb_ping
    104.  
      nbdb_restore
    105.  
      nbdb_unload
    106.  
      nbdbms_start_server
    107.  
      nbdbms_start_stop
    108.  
      nbdc
    109.  
      nbdecommission
    110.  
      nbdelete
    111.  
      nbdeployutil
    112.  
      nbdevconfig
    113.  
      nbdevquery
    114.  
      nbdiscover
    115.  
      nbdna
    116.  
      nbemm
    117.  
      nbemmcmd
    118.  
      nbexecute
    119.  
      nbfindfile
    120.  
      nbfirescan
    121.  
      nbftadm
    122.  
      nbftconfig
    123.  
      nbgetconfig
    124.  
      nbhba
    125.  
      nbholdutil
    126.  
      nbhypervtool
    127.  
      nbjm
    128.  
      nbkmsutil
    129.  
      nboraadm
    130.  
      nbpem
    131.  
      nbpemreq
    132.  
      nbperfchk
    133.  
      nbplupgrade
    134.  
      nbrb
    135.  
      nbrbutil
    136.  
      nbregopsc
    137.  
      nbreplicate
    138.  
      nbrestorevm
    139.  
      nbseccmd
    140.  
      nbsetconfig
    141.  
      nbsnapimport
    142.  
      nbsnapreplicate
    143.  
      nbsqladm
    144.  
      nbstl
    145.  
      nbstlutil
    146.  
      nbsu
    147.  
      nbsvrgrp
    148.  
      resilient_clients
    149.  
      restoretrace
    150.  
      stopltid
    151.  
      tl4d
    152.  
      tl8d
    153.  
      tl8cd
    154.  
      tldd
    155.  
      tldcd
    156.  
      tlhd
    157.  
      tlhcd
    158.  
      tlmd
    159.  
      tpautoconf
    160.  
      tpclean
    161.  
      tpconfig
    162.  
      tpext
    163.  
      tpreq
    164.  
      tpunmount
    165.  
      verifytrace
    166.  
      vltadm
    167.  
      vltcontainers
    168.  
      vlteject
    169.  
      vltinject
    170.  
      vltoffsitemedia
    171.  
      vltopmenu
    172.  
      vltrun
    173.  
      vmadd
    174.  
      vmchange
    175.  
      vmcheckxxx
    176.  
      vmd
    177.  
      vmdelete
    178.  
      vmoprcmd
    179.  
      vmphyinv
    180.  
      vmpool
    181.  
      vmquery
    182.  
      vmrule
    183.  
      vmupdate
    184.  
      vnetd
    185.  
      vxlogcfg
    186.  
      vxlogmgr
    187.  
      vxlogview
    188.  
      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
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)

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