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
- bpcleanrestore
- 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
- configureCerts
- configureMQ
- configurePorts
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- 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
- Index
Name
vltrun — Run a NetBackup Vault session
SYNOPSIS
-haltdups -vjobs vault_jobid [profile | robot/vault/profile] [-preview] [-verbose | -v] [-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
vltrun drives a NetBackup Vault session by issuing a sequence of calls to the vault engine. Optionally, the session can include callouts to user-provided notify scripts.
OPTIONS
- profile | robot/vault/profile
Specifies the name of a profile or a nested robot number, vault, and profile in the vault parameter file. If profile is used without robot and vault, the profile must be unique within the vault parameter file. This option is required.
- -vjob vault_jobid
Specifies the job ID of an active vault job that is currently duplicated.
- -haltdups
Terminates all associated, active vault duplication jobs.
- -preview
Generates the preview list of images to be vaulted in a vault session. The results go to the file preview.list in the session directory.
- -verbose | -v
Reports verbosely on the session in the vault debug log.
- -version
Displays the vltrun version and exit.
USAGE
The vltrun session follows this sequence:
Run the vlt_start_notify script.
Inventory media.
Initialize Media Manager database for the vault media that is returned to the robot.
Generate the list of preview images to be vaulted.
Duplicate images.
Inventory Media Manager database (first time).
Assign media for the NetBackup catalog backup.
Inventory Media Manager database (second time).
Inventory images.
Suspend media.
Run the vlt_end_notify script.
Re-inventory images.
Assign slot IDs.
Back up the NetBackup catalog.
Inventory the Media Manager database (third and final time).
Run the vlt_ejectlist_notify script.
Generate the eject list.
Run the vlt_starteject_notify script.
Eject and report.
Run the vlt_end_notify script.
vltrun can be run in any of the following ways:
Directly from the command line.
By NetBackup policy scheduling. In this case, the policy must consist of type Vault, and the policy's file list must consist of a vltrun command.
By running the command Start Session for a profile in the Vault interface or vltadm
vltrun uses the option profile|robot/vault/profile to run a vault session. You can use the profile form of the option if there is no other profile with the same name in your vault configuration. In this case, the profile name is sufficient to uniquely identify the configuration information.
If there is more than one profile with the same name, then use the robot/vault/profile form to uniquely identify the configuration.
Do not modify your vault configuration while a vault session is running.
When the session starts, it creates a directory to hold the files that vltrun and the vault engine create during the session.
The vault session uses the following directory:
UNIX systems:
/usr/openv/netbackup/vault/sessions/vault_name/sidxxx
Windows systems:
install_path\NetBackup\vault\sessions\vault_name\sidxxx
The xxx variable is an integer uniquely assigned to this session. For each vault name, session identifiers are sequentially assigned, starting with 1.
If you have configured an email address in your vault properties, then email is sent to this address at the end of the session. The email reports the results. By default, email is sent to root.
vltrun produces an overview of the session, called summary.log, in the session directory.
Control the vault process at several points in the session by installing notify scripts in the directory for NetBackup binaries, /usr/openv/netbackup/bin. Refer to the NetBackup Vault Administrator's Guide for more information on notify scripts.
You can monitor the progress of your vltrun session in the NetBackup Activity Monitor.
The Operation field on the main Activity Monitor window shows the progress of your vault session by using the following statuses:
Choosing Images.
Duplicating Images.
Choosing Media.
Catalog Backup.
Eject and Report.
Done.
If you create the following directory with public-write access, vltrun creates a daily debug log on this directory:
UNIX systems:
usr/openv/netbackup/logs/vault
Windows systems:
install_path\netbackup\logs\vault
The log is called log.DDMMYY (where DDMMYY is the current date). You can then use this file for troubleshooting.
Public-write access is needed because not all executables that write to this file run as administrator or root.
You can adjust the level of logging information that is provided in this log file by adjusting the following: the vault logging level parameter on the Logging page of the master server's properties through Host Properties on the NetBackup Administration Console.
You can terminate active vault duplication jobs by using the vltrun -haltdups command. Initiate a -haltdups script that sends a SIGUSR2 signal to the main vault job (currently at the duplication step). It then automatically propagates the signal to all of the vault duplication instances without waiting for any current duplication job instance to finish. After this step completes, the main vault job proceeds with the remaining steps.
After the SIGUSR2 signal is received, the job details of the following message of the terminated vault duplication job appears: termination requested by administrator (150).
You must have administrator privileges to run this command.
EXAMPLES
Example 1 - Vault the profile my_profile.
# vltrun my_profile
Example 2 - Vault the images for robot 0, vault Financials, and profile Weekly.
# vltrun 0/Financials/Weekly
Example 3 - Terminate an active vault duplication job with the ID of 1.
# vltrun -haltdups -vjob 1
RETURN VALUES
On UNIX systems, vault may exit with a status code greater than 255. For these extended exit status codes, the status that is returned to the system is 252. The actual exit status is written to stderr in the format: EXIT status = exit status.
FILES
UNIX systems:
/usr/openv/netbackup/vault /usr/openv/netbackup/bp.conf /usr/openv/netbackup/logs/bpcd/log.mmddyy /usr/openv/netbackup/logs/vault/log.mmddyy /usr/openv/netbackup/db/vault/vault.xml /usr/openv/netbackup/vault/sessions/vault_name/sidxxx /usr/openv/netbackup/vault/sessions/vault_name/sidxxx/summar y.log /usr/openv/netbackup/vault/sessions/vault_name/sidxxx/detail .log
Windows systems:
install_path\NetBackup\vault install_path\NetBackup\bp.conf install_path\NetBackup\logs\bpbrmvlt\mmddyy.log install_path\NetBackup\logs\bpcd\mmddyy.log install_path\NetBackup\logs\vault\mmddyy.log install_path\NetBackup\db\vault\vault.xml install_path\NetBackup\vault\sessions\vault_name\sidxxx install_path\NetBackup\vault\sessions\vault_name\sidxxx\summ ary.log install_path\NetBackup\vault\sessions\vault_name\sidxxx\deta il.log