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

vltrun — Run a NetBackup Vault session

SYNOPSIS

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

SEE ALSO

See vltadm.

See vlteject.

See vltinject.

See vltoffsitemedia.

See vltopmenu.