Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.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.  
      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.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    103.  
      nbcallhomeproxyconfig
    104.  
      nbcatsync
    105.  
      NBCC
    106.  
      NBCCR
    107.  
      nbcertcmd
    108.  
      nbcertupdater
    109.  
      nbcldutil
    110.  
      nbcloudrestore
    111.  
      nbcomponentupdate
    112.  
      nbcplogs
    113.  
      nbcredkeyutil
    114.  
      nbdb_admin
    115.  
      nbdb_backup
    116.  
      nbdb_move
    117.  
      nbdb_ping
    118.  
      nbdb_restore
    119.  
      nbdb_unload
    120.  
      nbdb2adutl
    121.  
      nbdbms_start_server
    122.  
      nbdbms_start_stop
    123.  
      nbdc
    124.  
      nbdecommission
    125.  
      nbdelete
    126.  
      nbdeployutil
    127.  
      nbdevconfig
    128.  
      nbdevquery
    129.  
      nbdiscover
    130.  
      nbdna
    131.  
      nbemm
    132.  
      nbemmcmd
    133.  
      nbfindfile
    134.  
      nbfirescan
    135.  
      nbftadm
    136.  
      nbftconfig
    137.  
      nbgetconfig
    138.  
      nbhba
    139.  
      nbholdutil
    140.  
      nbhostidentity
    141.  
      nbhostmgmt
    142.  
      nbhypervtool
    143.  
      nbidpcmd
    144.  
      nbimageshare
    145.  
      nbinstallcmd
    146.  
      nbjm
    147.  
      nbkmiputil
    148.  
      nbkmscmd
    149.  
      nbkmsutil
    150.  
      nboraadm
    151.  
      nborair
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmlb
    155.  
      nbperfchk
    156.  
      nbplupgrade
    157.  
      nbrb
    158.  
      nbrbutil
    159.  
      nbregopsc
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbsmartdiag
    167.  
      nbsnapimport
    168.  
      nbsnapreplicate
    169.  
      nbsqladm
    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
  3.  
    Index

Name

vltoffsitemedia — list off-site parameter values for a group of media, or change the off-site parameter value for a single media

SYNOPSIS

vltoffsitemedia -list [-W] [-vault vault_name] [-voldbhost host_name]

vltoffsitemedia -change -m media_id [-voldbhost host_name] [-d media_description] [-vltname vault_name] [-vltsent date][-vltreturn date] [-vltslot slot_no] [-vltcid container_id] [-vltsession session_id]

vltoffsitemedia -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

vltoffsitemedia allows the user to change the vault-specific parameters of a given media. This command lets the user change one or more parameters by using a single command. It lets the user view the various vault parameters of all media for a particular EMM server or vault.

If you create the following directory with public-write access, vltoffsitemedia creates a daily debug log in this directory:

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

Windows: install_path\netbackup\logs\vault

The log is called log.DDMMYY (where DDMMYY is the current date). You then can use this file that for troubleshooting.

Public-write access is needed because not all executables that write to this file can run as root.

OPTIONS

-change

Changes the attributes of the specified volume.

-d media_description

Specifies the description for the volume.

To configure NetBackup so that the media description field is cleared automatically when volumes are returned to the robot, set the VAULT_CLEAR_MEDIA_DESC parameter in EMM.

-list

Lists the off-site parameters for the media in the local EMM database. To restrict the list to a specific vault for the local EMM database, include the -vault option with the command. To list the off-site parameters for media for a specific EMM database, include the -voldbhost option with the command.

-m media_id

Media ID of the volume whose vault parameters are to be changed.

-vault vault_name

Specifies the name of the vault for which all media IDs and their vault-specific parameters are listed.

-version

Displays the vltoffsitemedia version and exit.

-vltcid container_id

Specifies the container in which a volume is stored. container_id (a string of up to 29 alphanumeric characters (no spaces) specifies the new container for the volume. You must specify an existing container ID. You cannot assign media from one EMM server to a container that has media from a different EMM server. Use the -m option to specify the media ID of the volume.

-vltname vault_name

Specifies the name of the logical vault that is configured for the robot that ejected the volume.

-vltreturn date

Specifies the date and time the media was requested for return from the vault vendor. For Catalog Backup volumes, this date is the date that the media is requested for return from the vault vendor.

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.

-vltsent date

Specifies the date and time the media was sent to the off-site vault.

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.

mm/dd/yyyy [hh[:mm[:ss]]]
-vltsession session_id

Specifies the identifier of the Vault session that ejected this media.

-vltslot slot_no

Specifies the vault vendor's slot number for the slot that this volume occupies.

-voldbhost host_name

Specifies the name of the EMM server.

-W

Specifies the parsable output format for the media off-site parameters. For containers, the output includes the length of the container description, the container description, and the container ID. The output header line is a space that is separated line of column labels; the output data lines are space-separated fields.

EXAMPLES

Example 1 - Change the vault name and the vault sent dates of the media with the ID BYQ.

vltoffsitemedia -change -m BYQ -vltname THISTLE -vltsent 08/01/2012 
12:22:00

Example 2 - Change the vault slot number to 100 for a media with ID 000012.

vltoffsitemedia -change -m 000012 -vltslot 100

Example 3 - Clear out the vault-specific fields for a media.

vltoffsitemedia -change -m 000012 -vltname "" -vltsession 0 -vltslot 
0 -vltsent 0 -vltreturn 0

or:

vltoffsitemedia -change -m 000012 -vltname - -vltsession 0 -vltslot 
0 -vltsent 00/00/00 -vltreturn 00/00/00

Example 4 - Clear the container ID and media description of volume ABC123.

vltoffsitemedia -change -m ABC123 -vltcid - -d ""

or:

vltoffsitemedia -change -m ABC123 -vltcid "" -d ""

The vltoffsitemedia command uses the Media Manager commands to query or update the EMM database.

If the vltoffsitemedia command fails, look at the debug log on the following directory for detailed information about the actual Media Manager command that failed:

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

Windows systems: install_path\netbackup\logs\vault

For more information on the status codes that Media Manager commands return, see the NetBackup Status Codes Reference Guide.

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 is 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 Status Codes Reference Guide and in the NetBackup Troubleshooter Wizard.