Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCertsForPlugins
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- csconfig reinitialize
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
vltoffsitemedia — list off-site parameter values for a group of media, or change the off-site parameter value for a single media
SYNOPSIS
-list [-W] [-vault vault_name] [-voldbhost host_name]
-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]
-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/.conffile (UNIX) and theinstall_path\VERITAS\msg\LC.CONFfile (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/.conffile (UNIX) and theinstall_path\VERITAS\msg\LC.CONFfile (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.