NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.3.0.1, 10.3)
  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.  
      nbfindfile
    131.  
      nbfirescan
    132.  
      nbfp
    133.  
      nbftadm
    134.  
      nbftconfig
    135.  
      nbgetconfig
    136.  
      nbhba
    137.  
      nbholdutil
    138.  
      nbhostidentity
    139.  
      nbhostmgmt
    140.  
      nbhypervtool
    141.  
      nbidpcmd
    142.  
      nbimageshare
    143.  
      nbinstallcmd
    144.  
      nbjm
    145.  
      nbkmiputil
    146.  
      nbkmscmd
    147.  
      nbkmsutil
    148.  
      nboraadm
    149.  
      nborair
    150.  
      nbpem
    151.  
      nbpemreq
    152.  
      nbmariadb
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbreplicate
    159.  
      nbrepo
    160.  
      nbrestorevm
    161.  
      nbseccmd
    162.  
      nbserviceusercmd
    163.  
      nbsetconfig
    164.  
      nbshvault
    165.  
      nbsmartdiag
    166.  
      nbsnapimport
    167.  
      nbsnapreplicate
    168.  
      nbsqladm
    169.  
      nbsqlite
    170.  
      nbstl
    171.  
      nbstlutil
    172.  
      nbstop
    173.  
      nbsu
    174.  
      nbsvrgrp
    175.  
      netbackup_deployment_insights
    176.  
      resilient_clients
    177.  
      restoretrace
    178.  
      stopltid
    179.  
      tldd
    180.  
      tldcd
    181.  
      tpautoconf
    182.  
      tpclean
    183.  
      tpconfig
    184.  
      tpext
    185.  
      tpreq
    186.  
      tpunmount
    187.  
      verifytrace
    188.  
      vltadm
    189.  
      vltcontainers
    190.  
      vlteject
    191.  
      vltinject
    192.  
      vltoffsitemedia
    193.  
      vltopmenu
    194.  
      vltrun
    195.  
      vmadd
    196.  
      vmchange
    197.  
      vmcheckxxx
    198.  
      vmd
    199.  
      vmdelete
    200.  
      vmoprcmd
    201.  
      vmphyinv
    202.  
      vmpool
    203.  
      vmquery
    204.  
      vmrule
    205.  
      vmupdate
    206.  
      vnetd
    207.  
      vssat
    208.  
      vwcp_manage
    209.  
      vxlogcfg
    210.  
      vxlogmgr
    211.  
      vxlogview
    212.  
      W2KOption

Name

bplabel — write NetBackup label on tape media

SYNOPSIS

bplabel -m media_id -d density [-o] [-p volume_pool_name] [-n drive_name | -u device_number] [-host media_server] [-erase [-l]] [-priority number]

 

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 bplabel command writes a NetBackup label on the specified media. Labels are required only for the media that were last used for NetBackup catalog backups or by a non-NetBackup application. You can use this command to erase and label the media that is unassigned in a volume database. In addition, you can use this command to assign specific media IDs. The NetBackup Device Manager daemon or service (ltid) must be active for bplabel to succeed. You also must manually assign the drive by using the NetBackup Device Monitor unless you include the -u option on the bplabel command.

Caution:

Ensure that the media does not contain required backups. After the media is relabeled, any backups that were on it cannot be restored.

Any authorized user can run this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

The following are some items about how to use this command:

  • The -m and -d options are required.

  • The -p option is required if the media ID is not in the NetBackup volume pool.

  • If the data on the media is in a recognized format and the -o option is not specified, bplabel prompts you to confirm the overwrite. Data format recognition works only if the first block on a variable length media is less than or equal to 32 kilobytes.

  • Use the bplabel command only for tapes.

You must have administrator privileges to run this command.

OPTIONS

-d density

A required option that specifies the density of the tape drive on which the media is mounted. The tape mount request must be performed on a drive type that satisfies the -d option.

Note:

Do not use capital letters when you enter the density. Incorrect density syntax causes the command to fail and an "Invalid Density Drive Type" message to appear.

The valid densities are as follows:

dlt (DLT Cartridge)

hcart (1/2 Inch Cartridge)

-erase [-l]

This option is used to erase the media. Short erase is the default erase. If -l option is specified, the media is long erased. A long erase operation can take a long time depending on the type of drive.

-host media_server

The media_server variable is the host where the drive is attached. This drive is the drive that is used to mount the media. By default, if this option is not used, the command runs on the local system.

-m media_ID

A required option that specifies the external media ID that is written to the tape label as a media ID. You can enter the media ID in either uppercase or lowercase. Internally, it always converts to uppercase. The media ID must be six or fewer alphanumeric characters.

-n drive_name

Unconditionally assigns the stand-alone drive that drive_name specifies. The drive must contain media and be ready. By using this option, manual operator assignment is not required. The name for the drive can be obtained from the Media Manager configuration.

-o

Unconditionally overwrites the selected media ID. If this option is not specified, bplabel prompts for permission to overwrite the media that meets any of the following conditions:

Contains a NetBackup media header.

Is a NetBackup catalog backup media.

Is in TAR, CPIO, DBR, AOS/VS, or ANSI format.

-p volume_pool_name

This option is required if the media ID is defined in the Enterprise Media Manager Database but is not in the NetBackup volume pool.

volume_pool_name must specify the correct pool.

-priority number

Specifies a new priority (number) for the label job that overrides the default job priority.

-u device_number

Unconditionally assigns the stand-alone drive that device_number specifies. The drive must contain media and be ready. By using this option, manual operator assignment is not required. The number for the drive can be obtained from the Media Manager configuration.

NOTES

tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Use tpconfig -dl to obtain the full drive name.

EXAMPLES

Example 1 - Label a DLT cartridge media as dlt001

bplabel -m dlt001 -d dlt

Example 2 - Erase the DLT cartridge media with the label dlt102

bplabel -m dlt102 -d dlt -erase

SEE ALSO

See ltid.