Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.2)
  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.  
      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.  
      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.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCertsForPlugins
    85.  
      configureMQ
    86.  
      configurePorts
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig throttle
    93.  
      csconfig reinitialize
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      manageClientCerts
    100.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcloudrestore
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdbms_start_server
    118.  
      nbdbms_start_stop
    119.  
      nbdc
    120.  
      nbdecommission
    121.  
      nbdelete
    122.  
      nbdeployutil
    123.  
      nbdevconfig
    124.  
      nbdevquery
    125.  
      nbdiscover
    126.  
      nbdna
    127.  
      nbemm
    128.  
      nbemmcmd
    129.  
      nbfindfile
    130.  
      nbfirescan
    131.  
      nbftadm
    132.  
      nbftconfig
    133.  
      nbgetconfig
    134.  
      nbhba
    135.  
      nbholdutil
    136.  
      nbhostidentity
    137.  
      nbhostmgmt
    138.  
      nbhypervtool
    139.  
      nbimageshare
    140.  
      nbinstallcmd
    141.  
      nbjm
    142.  
      nbkmsutil
    143.  
      nboraadm
    144.  
      nborair
    145.  
      nbpem
    146.  
      nbpemreq
    147.  
      nbperfchk
    148.  
      nbplupgrade
    149.  
      nbrb
    150.  
      nbrbutil
    151.  
      nbregopsc
    152.  
      nbreplicate
    153.  
      nbrepo
    154.  
      nbrestorevm
    155.  
      nbseccmd
    156.  
      nbsetconfig
    157.  
      nbsnapimport
    158.  
      nbsnapreplicate
    159.  
      nbsqladm
    160.  
      nbstl
    161.  
      nbstlutil
    162.  
      nbstop
    163.  
      nbsu
    164.  
      nbsvrgrp
    165.  
      resilient_clients
    166.  
      restoretrace
    167.  
      stopltid
    168.  
      tl4d
    169.  
      tl8d
    170.  
      tl8cd
    171.  
      tldd
    172.  
      tldcd
    173.  
      tlhd
    174.  
      tlhcd
    175.  
      tlmd
    176.  
      tpautoconf
    177.  
      tpclean
    178.  
      tpconfig
    179.  
      tpext
    180.  
      tpreq
    181.  
      tpunmount
    182.  
      verifytrace
    183.  
      vltadm
    184.  
      vltcontainers
    185.  
      vlteject
    186.  
      vltinject
    187.  
      vltoffsitemedia
    188.  
      vltopmenu
    189.  
      vltrun
    190.  
      vmadd
    191.  
      vmchange
    192.  
      vmcheckxxx
    193.  
      vmd
    194.  
      vmdelete
    195.  
      vmoprcmd
    196.  
      vmphyinv
    197.  
      vmpool
    198.  
      vmquery
    199.  
      vmrule
    200.  
      vmupdate
    201.  
      vnetd
    202.  
      vssat
    203.  
      vwcp_manage
    204.  
      vxlogcfg
    205.  
      vxlogmgr
    206.  
      vxlogview
    207.  
      W2KOption

Name

vltcontainers — move volumes logically into containers

SYNOPSIS

vltcontainers -run [-rn robot_number]

vltcontainers -run -usingbarcodes [-rn robot_number]

vltcontainers -run -vltcid container_id -vault vault_name -sessionid session_id

vltcontainers -run -vltcid container_id -f file_name [-rn robot_number] [-usingbarcodes]

vltcontainers -view [-vltcid container_id]

vltcontainers -change -vltcid container_id -rd return_date

vltcontainers -delete -vltcid container_id

vltcontainers -version

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\

DESCRIPTION

vltcontainers logically adds to containers the media that was ejected from one or more vault sessions. It can view, set, or change the return date of containers that go off-site or are already at the off-site vault. vltcontainers can also delete a container from the NetBackup and Media Manager catalogs.

You can add media IDs to containers as follows:

  • Use the keyboard to enter the container and the media IDs.

  • Use a keyboard interface barcode reader to scan the container IDs and media IDs. Keyboard interface readers are also known as keyboard wedge readers because they connect (or wedge) between the keyboard and the keyboard port on your computer.

  • Use an input file that contains the media IDs or numeric equivalents of barcodes of all the media that are added to one container. To add media to more than one container, enter the IDs by using the keyboard or a keyboard interface barcode reader. Or, run the vltcontainers command again and specify different container and file name options.

  • Add all the media that a specific session ejects to one container. To add media from a single eject session into more than one container, enter IDs using the keyboard or a keyboard interface barcode reader.

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.

See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.

Run the vltcontainers command from a NetBackup master server that is licensed for Vault.

If the following directory with public-write access exists, vltcontainers writes to its daily debug log file (log.DDMMYY where DDMMYY is current date):

UNIX systems: usr/openv/netbackup/logs/vault

Windows systems: install_path\netbackup\logs\vault

Public-write access is required because not all executable files that write to this file can run as administrator or root user.

OPTIONS

-change

Changes the default return date for the container. The default return date of a container is the date of the volume in the container that is returned the latest. It requires the -vltcid container_id option.

-delete

Deletes the container record from the NetBackup and Media Manager catalogs. You can delete a container only if it contains no media.

-f file_name

Specifies the file from which to read media IDs. All the listed media in the file are added to the container that the -vltcid option specifies. The file can be a list of media IDs (one per line). Or it can be the numeric equivalents of barcodes (one per line) scanned into a file by a barcode reader.

-rd return_date

Specifies the return date for the container.

The return date format depends on the locale setting.

-rn robot_number

Specifies the robot, which is used to determine the EMM Server from which the vltcontainers command should obtain media information. If -rn robot_number is not used, the master server is considered as the EMM server. The only media that can be added to containers is the media in the database on the EMM server.

-run

Logically adds media to the container. If you specify no other options, you must enter the container IDs and the media IDs by using the keyboard. To use a barcode reader to scan the container and the media IDs, specify the -usingbarcodes option. To add the media that a specific session ejects, use the -vault vault_name and -sessionid session_id options. To add the media that is specified in a file, use the -f file_name option. To specify an EMM server other than the master server, use the -rn robot_number option.

-sessionid session_id

The ID of a vault session. All media that the specified session ejects are added to the container that the -vltcid option specifies.

-usingbarcodes

Specifies a keyboard interface barcode reader that scans container IDs and media IDs, or the barcode numbers that are used in the file that -f file_name specifies. Keyboard interface barcode readers (also called keyboard wedge barcode readers) connect between the keyboard and the keyboard port on your computer.

-vault vault_name

The name of the vault to which the profile that ejected the media belongs. You also must specify the ID of the session (-sessionid) that ejected the media to be added to the container.

-version

Displays the vltcontainers version and exit.

-view [-vltcid container_id]

Shows the return date that is assigned to all containers. Use the -vltcid container_id option and argument to show the return date of a specific container.

-vltcid container_id

Specifies the container ID. Container ID can be a string of up to 29 alphanumeric characters (no spaces). The -rd return_date option and argument are required to change a container return date.

EXAMPLES

Example 1 - Use the following command to:

  • Add the volumes that are ejected from robot number 0 to containers.

  • Use a barcode reader to scan the container ID and media ID.

# vltcontainers -run -usingbarcodes -rn 0

Example 2 - View the return date of container ABC123:

# vltcontainers -view -vltcid ABC123

Example 3 - Change the return date of container ABC123 to December 07, 2012:

# vltcontainers -change -vltcid ABC123 -rd 12/07/2012

Example 4 - Delete container ABC123 from the NetBackup and Media Manager catalogs, use the following command:

# vltcontainers -delete -vltcid ABC123

Example 5 - Add all media that was ejected to container ABC123 by session 4 of vault MyVault_Cntr, use the following command:

# vltcontainers -run -vltcid ABC123 -vault MyVault_Cntr -sessionid 4

Example 6 - Add the media that is listed in the medialist file that is ejected from robot number 0 to container ABC123:

UNIX systems:

# vltcontainers -run -vltcid ABC123 -f 
/home/jack/medialist -rn 0

Windows systems:

# vltcontainers -run -vltcid ABC123 -f 
C:\home\jack\medialist -rn 0

Example 7 - Use the following command to:

  • Add media to container ABC123 that was ejected from a robot that is attached to the master server

  • Read the barcodes for that media from the medialist file

UNIX systems: # vltcontainers -run -vltcid ABC123 -f 
/home/jack/medialist -usingbarcodes
Windows systems: # vltcontainers -run -vltcid ABC123 -f 
C:\home\jack\medialist -usingbarcodes

RETURN VALUES

Vault may exit with a status code greater than 255. Such status codes are called extended exit status codes. For such a case, the exit status that returned to the system is 252. The actual exit status is written to stderr in the format EXIT status = exit status

The extended exit status values are documented in the NetBackup Troubleshooting Guide and in the NetBackup Troubleshooting Wizard.

FILES

UNIX systems:

/usr/openv/netbackup/vault/sessions/cntrDB
/usr/openv/netbackup/db/vault/vault.xml
/usr/openv/netbackup/logs/vault

Windows systems:

install_path\NetBackup\vault\sessions\cntrDB
install_path\NetBackup\db\vault\vault.xml
install_path\netbackup\logs\vault

SEE ALSO

See vltoffsitemedia.

See vltopmenu.