Important Update: Cohesity Products Documentation


All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.

NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (11.1)
  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.  
      msdpimgutil
    100.  
      nbauditreport
    101.  
      nbcallhomeproxyconfig
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcmdrun
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbcredkeyutil
    112.  
      nbdb_admin
    113.  
      nbdb_backup
    114.  
      nbdb_move
    115.  
      nbdb_ping
    116.  
      nbdb_restore
    117.  
      nbdb_unload
    118.  
      nbdb2adutl
    119.  
      nbdbms_start_server
    120.  
      nbdbms_start_stop
    121.  
      nbdc
    122.  
      nbdecommission
    123.  
      nbdelete
    124.  
      nbdeployutil
    125.  
      nbdevconfig
    126.  
      nbdevquery
    127.  
      nbdiscover
    128.  
      nbdna
    129.  
      nbemm
    130.  
      nbemmcmd
    131.  
      nbepicfile
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbfp
    135.  
      nbftadm
    136.  
      nbftconfig
    137.  
      nbgetconfig
    138.  
      nbhba
    139.  
      nbholdutil
    140.  
      nbhostidentity
    141.  
      nbhostmgmt
    142.  
      nbhsmcmd
    143.  
      nbhypervtool
    144.  
      nbidpcmd
    145.  
      nbimageshare
    146.  
      nbinstallcmd
    147.  
      nbjm
    148.  
      nbkmiputil
    149.  
      nbkmscmd
    150.  
      nbkmsutil
    151.  
      nblogparser
    152.  
      nbmariadb
    153.  
      nbmysql
    154.  
      nbmlb
    155.  
      nborair
    156.  
      nboracmd
    157.  
      nbpem
    158.  
      nbpemreq
    159.  
      nbmariadb
    160.  
      nbmlb
    161.  
      nbperfchk
    162.  
      nbpgsql
    163.  
      nbplupgrade
    164.  
      nbrb
    165.  
      nbrbutil
    166.  
      nbreplicate
    167.  
      nbrepo
    168.  
      nbrestorevm
    169.  
      nbseccmd
    170.  
      nbserviceusercmd
    171.  
      nbsetconfig
    172.  
      nbshvault
    173.  
      nbsmartdiag
    174.  
      nbsnapimport
    175.  
      nbsnapreplicate
    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.  
      tiermover
    188.  
      tldd
    189.  
      tldcd
    190.  
      tpautoconf
    191.  
      tpclean
    192.  
      tpconfig
    193.  
      tpext
    194.  
      tpreq
    195.  
      tpunmount
    196.  
      verifytrace
    197.  
      vltadm
    198.  
      vltcontainers
    199.  
      vlteject
    200.  
      vltinject
    201.  
      vltoffsitemedia
    202.  
      vltopmenu
    203.  
      vltrun
    204.  
      vmadd
    205.  
      vmchange
    206.  
      vmcheckxxx
    207.  
      vmd
    208.  
      vmdelete
    209.  
      vmoprcmd
    210.  
      vmphyinv
    211.  
      vmpool
    212.  
      vmquery
    213.  
      vmrule
    214.  
      vmupdate
    215.  
      vnetd
    216.  
      vssat
    217.  
      vwcp_manage
    218.  
      vxlogcfg
    219.  
      vxlogmgr
    220.  
      vxlogview
    221.  
      W2KOption

Name

bpduplicate — create a copy of backups that NetBackup has created

SYNOPSIS

bpduplicate -npc new_primary_copy -backupid backup_id [-local] [-client name]

bpduplicate [-number_copies number] [-dstunit destination_storage_unit_label[,copy2,...]] [-dp destination_volume_pool_name[,copy2,...] [-p | -pb | -PD | -PM] [-Bidfile file_name] [-v] [-local] [-client name] [-st sched_type] [-sl sched_label] [-L output_file [-en]] [-shost source_host] [-policy name] [-s date] [-e date] [-pt policy_type] [-hoursago hours] [[-cn copy_number] | [-primary]] [-dcn copy_number_1[copy_number_2,...,copy_number_n]] [-M master_server] [-altreadhost hostname] [-backupid backup_id] [-id media_id] [-rl retention_level[,rl-copy2,...]] [-fail_on_error 0|1[,...,0|1]] [-mpx] [-priority number] [-set_primary copy_index] [-bc_only] [-granular_proxy hostname] [-owner media_share_group[,copy2,...]][-worm_unlock_match_expiration]

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 bpduplicate command allows a copy of a backup to be created. The bpduplicate command can also change the primary copy to enable restoring from a duplicated backup. The primary copy is used to satisfy restore requests and is initially the original copy.

Multiplexed duplications can be created by using the -mpx option. Refer to the discussion of the -mpx option for more information.

The duplicated backup has a separate expiration date from the original. Initially, the expiration date of the copy is set to the expiration date of the original. You can change the expiration date of the copy or the original by using the bpexpdate command.

Use bpduplicate to create up to 10 copies of unexpired backups.

OPTIONS

-altreadhost hostname

Specify an alternate host from which to read the media. The default condition is that bpduplicate reads the source media from the host that performed the backup.

-backupid backup_id

Specifies the backup ID of a single backup to duplicate or for which to change the primary copy.

-bc_only

Catalogs the granular information (that is, it builds the catalog only). Running this option precludes the need to make another copy of the image, which can improve performance of future browse or restore operations.

-Bidfile file_name

file_name specifies a file that contains a list of backup IDs to be duplicated. List one backup ID per line in the file. If this parameter is specified, other selection criteria are ignored.

Also, file_name is removed during the execution of that command line interface (CLI) because the NetBackup GUIs commonly use this parameter. They expect the command-line interface to remove the temporary file that was used for the -Bidfile option upon completion. Direct command-line interface users can also use the option; however, it removes the file.

-client name

Specifies the name of the client that produced the originals and is used as search criteria for backups to duplicate. The default is all clients.

When you specify -client with the -npc option to change the primary copy, NetBackup first searches for the backup ID that belongs to the client. This search is useful if the client name has changed.

-cn copy_number | -primary

Determines the copy number to duplicate. Valid values are 1 through 10. The default is 1.

-primary means to search or duplicate the primary copy.

-dcn copy_number_1[copy_number_2,...,copy_number_n]

The destination copy number option specifies the copy number of the new copy that is made with the bpduplicate command. The option accepts multiple numbers that are separated with commas. If multiple copy numbers are specified, you must use - number_copies. The - number_copies option must match the number of copies specified. For example, if -dcn 3,4 is specified, then you must specify - number_copies 2. If -dcn 3 is specified, then you can specify - number_copipes 1 or you can omit it.

Please be aware if you cannot have multiple copies with the same copy number. If you specify a copy number that already exists, the command fails. If you omit this option, the bpduplicate command assigns the next available copy number.

-dp destination_volume_pool_name[,copy2,...]

Specifies the volume pool for the duplicates. NetBackup does not verify that the media ID that is selected for the duplicate copy is not the same media ID where the original resides. Therefore, to avoid the possibility of a deadlock, specify a different volume pool than where the original media ID resides. The default pool name is NB_duplicates.

Specify a pool for each copy that you specify.

-dstunit destination_storage_unit_label[,copy2,...]

Specifies the destination storage unit. This parameter is required to duplicate backups. Do not specify this option to preview backups to be duplicated (-p, -pb, -PM, or -PD options) or to change the primary copy (-npc option). This option does not have a default.

Specify a storage unit for each copy that you specify.

-e date, -s date

Specifies the end (-e) or start (-s) of the range of dates and times that include all backups to duplicate. The default end date is the current date and time. The default start time is 24 hours before the current date and time.

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

-fail_on_error 0|1[,0|1,...,0|1]

Specifies whether to fail the other duplications if the copy fails, where:

0 - Do not fail the other copies

1 - Fail the other copies

Specify one for each copy that you specify.

-granular_proxy

Overrides the defined Exchange granular restore proxy host for a duplication operation. This host catalogs the granular information if duplicated to tape. By default, the defined Exchange granular restore proxy host is the original Exchange client for the backup. You can configure the proxy host in the client host Exchange properties of the backup client.

-hoursago hours

Specifies the number of hours before the current time to search for backups. Do not use with the -s option. The default is the previous midnight.

-id media_id

Search the image catalog for backups to duplicate that are on this media ID. If the original is fragmented between different media IDs, NetBackup duplicates only the backups that exist on the specified media ID. Backups that span media are duplicated, but not any other backups on the spanned media ID.

-L output_file [-en]

Specifies the name of a file in which to write progress information. The default is not to use a progress file.

Example for UNIX systems,/usr/openv/netbackup/logs/user_ops

Example for Windows systems, install_path\NetBackup\logs\user_ops

Include the -en option to generate a log in English. The name of the log contains the string _en. This option is useful to support the personnel that assist in a distributed environment where different locales may create logs of various languages.

Only default paths are allowed for this option and It is recommended to use the default paths. If you cannot use the NetBackup default path in your setup, you should add custom paths to the NetBackup configuration.

For more information on how to add a custom path, see the "BPCD_ALLOWED_PATH option for NetBackup servers and clients" topic in the NetBackup Administrator's Guide, Volume I.

-local

When bpduplicate runs from a host other than the master server and -local is not used (default), the following occurs: It starts a remote copy of the command on the master server. The remote copy allows the command to be terminated from the Activity Monitor.

Use this option to prevent the creation of a remote copy on the master server. You can also run bpduplicate only from the host where it was initiated.

If the -local option is used, bpduplicate cannot be canceled from the Activity Monitor.

-M master_server

Specifies the master server that manages the media catalog that has the media ID. If this option is not specified, the default is one of the following:

The NetBackup server supports only one server (the master) with no remote media servers. Therefore, the default in this case is always the NetBackup server master where you run the command.

On the NetBackup Enterprise Server, if the command is run on a master server, then that server is the default. If the command is run on a media server that is not the master, then the master for that media server is the default.

-mpx

Specifies that when you duplicate multiplexed backups, NetBackup creates multiplexed backups on the destination media, which reduces the time to duplicate multiplexed backups.

Multiplexed duplication is not supported for the following operations:

  • Non-multiplexed backups

  • Backups from disk type storage units

  • Backups to disk type storage units

  • FlashBackup or NDMP backups

If backups in the previous categories are encountered during duplication, NetBackup duplicates them first and uses non-multiplexed duplication. It then duplicates the multiplexed backups by using multiplexed duplication.

If all the backups in a multiplexed group are not duplicated, the duplicated multiplexed group has a different fragment layout. (A multiplexed group is a set of backups that are multiplexed together during a single multiplexing session.)

If this option is not specified, all backups are duplicated by using non-multiplexed duplication.

For more information about multiplex operations, see the NetBackup Administrator's Guide, Volume I.

-npc new_primary_copy

Allows the primary copy to be changed. The value can be 1 through 10. The -backupid option must be specified with this option.

-number_copies number

Specifies the number of copies to be created. Without the Inline Tape Copy option or NetBackup Vault extension that is installed, the value can be set to 1 only. The default is 1.

Use with -dstunit, -dp, -fail_on_error, and -r1:

-number_copies 2 -dstunit stunit-copy1,stunit-copy2
-number_copies 2 -dp pool1, pool2
-owner media_share_group [,share_group_copy2,...]

Specifies the share group for the duplicate. Specify a share group for each copy that you specify.

-p

Previews backups to be duplicated according the option settings, but does not perform the duplication. Displays the media IDs, server name, backups that are not candidates for duplication (and why), and information about the backups to be duplicated.

-pb

Previews the duplication but does not perform the duplication. Similar to the -p option, but does not display information about the backups.

-PD

Same as the -PM option, except that it sorts and displays the backups by date and time (newest to oldest).

-PM

Displays the information on the backups to be duplicated according to the option settings, but does not perform the duplication. This format first displays the backup IDs that cannot be duplicated and the reason why (for example, the backup already has two copies). It displays the following information about the backup: Date and time of the backup, policy, schedule, backup ID, host, media ID or path, copy number, and whether the copy is the primary copy:

1 = Primary copy

0 = Not primary copy

-policy name

Searches for backups to duplicate in the specified policy. The default is all policies.

-priority number

Sets a backup policy to run at a lesser or a higher priority than disk staging duplication.

-pt policy_type

Search for the backups that the specified policy type created. The default is any policy type.

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
-rl retention_level[,rl-copy2,...]

Provides a retention level for each copy that you specify.

If no retention levels are specified, the expiration date of the original copy is used for each copy. If a retention period is indicated, the expiration date for the copy is the backup date plus the retention period.

For example, if a backup was created on May 14, 2012, and its retention period is one week, the new copy's expiration date is May 21, 2012.

A value of -1 indicates that the original expiration date is used for the copy.

-set_primary copy_index

Specify a new copy to become the primary copy.

copy_index is one of the following:

0 = Do not change the primary copy (default)

1 = First new copy is the primary copy

2 = Second new copy is the primary copy

3 = Third new copy is the primary copy, and so on.

copy_index cannot be greater than the -number_copies value.

If the copy specified to be the primary copy fails, but other copies are successful, the primary copy does not change from its current value.

-shost source_host

Specifies that only the backups that are created on the specified backup server are considered for duplication. The default is to consider all backups regardless of the backup server.

-sl sched_label

Search for backups to duplicate that the specified schedule created. The default is all schedules.

-st sched_type

Search for backups to duplicate that the specified schedule type created. The default is any schedule type.

Valid values are:

FULL (full backup)

INCR (differential-incremental backup)

CINC (cumulative-incremental backup)

UBAK (user backup)

UARC (user archive)

NOT_ARCHIVE (all backups except user archive)

-v

Selects the verbose mode. When you specify the debug logs or progress logs, it includes more information.

-worm_unlock_match_expiration

Sets the WORM Unlock Time equal to the copy Expiration Time. This option only applies to duplications to a destination storage unit which uses WORM.

With the option set, the new copy WORM Unlock Time is set equal to the new copy Expire Time.

Without this option, the WORM Unlock Time is set equal to the retention period that is applied from the end of the duplication.

EXAMPLES

Example 1 - List backups with a copy number of 1. They were backed up by the policy that is named stdpol, and created between July 1, 2013, and August 1, 2013.

# bpduplicate -PM -cn 1 -policy stdpol -s 07/01/13 -e 08/01/13

Example 2 - Duplicate copy 1 of the backups that are listed in file bidfile in the tmp directory. The destination storage unit is unit1 and the destination pool is dup_pool. Progress information is written to bpdup.ls. The command can be all on one line, or you can use a backslash continuation character.

UNIX systems:

# bpduplicate -dstunit unit1 -Bidfile 
/tmp/bidfile 
-L /usr/openv/netbackup/logs/user_ops/bpdup.ls
-dp dup_pool -cn 1

Windows systems:

# bpduplicate -dstunit unit1 -Bidfile 
C:\tmp\bidfile 
-L install_path\NetBackup\logs\user_ops\bpdup.ls 
-dp dup_pool -cn 1

Example 3 - This example is the same as Example 2, except that multiplexed backups are duplicated when you select multiplexed duplication. The command can be all on one line, or you can use a backslash continuation character.

UNIX systems:

# bpduplicate -dstunit unit1 -Bidfile 
/tmp/bidfile -mpx 
-L /usr/openv/netbackup/logs/user_ops/bpdup.ls
 -dp dup_pool -cn 1

Windows systems:

# bpduplicate -dstunit unit1 -Bidfile 
C:\tmp\bidfile -mpx 
-L install_path\NetBackup\logs\user_ops\bpdup.ls 
-dp dup_pool -cn 1

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/images/*

Windows systems:

install_path\NetBackup\db\images\*
install_path\NetBackup\logs\admin\*

SEE ALSO

See nbreplicate.