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

vlteject — eject media and generate reports for previously run sessions

SYNOPSIS

vlteject

vlteject -eject [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-auto y|n] [-eject_delay seconds]

vlteject -report [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-legacy]

vlteject -eject -report [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-auto y|n] [-eject_delay seconds] [-version] [-legacy]

vlteject -preview [-vault vault_name [-profile profile_name]] [-profile robot_no / vault_name / profile_name] [-robot robot_name][-sessionid id]

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

vlteject ejects media and generates the corresponding reports (as configured in the profiles) for vault sessions for which media have not yet been ejected. vlteject can process the pending ejects and reports for all sessions, for a specific robot, for a specific vault, or for a specific profile. To process all pending ejects and reports, do not use the -profile, -robot, or -vault option.

vlteject operates only on sessions for which the session directory still exists. After that directory is cleaned up (removed by NetBackup), vlteject can no longer eject or report for that session.

Whether vlteject can run interactively or not depends on how it is called. Run interactively when you plan to eject more media than that amount that fits in the media access port.

Do not modify your vault configuration while vlteject is running.

vlteject can be run in any of the following ways:

  • Directly from the command line

  • By using the NetBackup policy schedule. The policy must be of type Vault, and the policy's file list must consist of a vlteject command.

  • By using vltopmenu to run an eject operation or a consolidated eject or consolidated report operation

If the following directory exists and has public write access, vlteject writes to its daily debug log file:

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

Windows systems: install_path\netbackup\logs\vault

The daily debug log file is log.DDMMYY; the DDMMYY is the current date.

Public-write access is required because not all executable files that write to this file can run as administrator or root user. The host property "Keep vault logs for n days" determines how long the vault session directories are retained.

Any authorized user can run this command.

For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.

OPTIONS

-auto y|n

Specifies automatic (y) or interactive mode (n). In automatic mode (y), vlteject runs without input from the user and does not display output. In interactive mode (default), vlteject runs interactively. It accepts input and displays output.

-eject

Ejects the media for the indicated sessions. -eject is optional if eject was completed and you only want to generate reports.

-eject_delay seconds

The number of seconds to delay before the media is ejected. This option is useful if an operation such as backing up or duplication recently occurred on the affected media. The default is 0. The maximum is 3600 (1 hour).

-legacy

Generates the reports by using the old-style consolidation. Valid only with the -report option.

-preview

Lists the sessions and the media that are ejected for the sessions. Does not eject the media.

-profile robot _no / vault_name / profile_name

Identifies a robot number, vault name, and profile name from which to eject media and generate reports. All three options must be used with -profile. To process all pending ejects and reports, use -profile with profile_name only.

-report

Generates the reports for the indicated sessions. If the corresponding eject process has completed, it generates and distributes any pending reports from the selected sessions. The reports are not generated again if vlteject is run again. If the eject has not completed, the subset of reports that does not depend on completion of eject are generated. These reports are generated again if vlteject -report is run again after eject has completed.

-robot robot_no

Specifies the robot number that identifies the robot which you want to eject media and generate reports. All vaults in the robot should use the same off-site volume group. To process all pending ejects and reports, do not use the -profile, -robot, or -vault option.

-sessionid id

The numeric session ID. If -profile, -robot, or -vault is specified, but -session id is not specified, vlteject operates on all sessions for the specified profile, robot, or vault.

-vault vault_name

The vault for which to eject media and generate reports. To process all pending ejects and reports; do not use the -profile, -robot, or -vault option.

-version

Displays the vlteject version and exit.

EXAMPLES

Example 1 - Eject media and generate reports for all robots that have sessions for which media have not yet been ejected:

# vlteject -eject -report

Example 2 - Eject all media that have not yet been ejected for all sessions for the CustomerDB vault and generate corresponding reports:

# vlteject -vault CustomerDB -eject -report

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 Troubleshooting Guide and in the NetBackup Troubleshooting Wizard.

FILES

UNIX systems:

/usr/openv/netbackup/db/vault/vault.xml
/usr/openv/netbackup/logs/vault/log.mmddyy
/usr/openv/netbackup/vault/sessions/vlt_name/sidxxx/detail.log
/usr/openv/netbackup/vault/sessions/vlt_name/sidxxx/summary.log
/usr/openv/netbackup/vault/sessions/vlt_name/sidxxx/vlteject_status
/usr/openv/netbackup/vault/sessions/vlteject.mstr
/usr/openv/netbackup/bp.conf

Windows systems:

install_path\NetBackup\db\vault\vault.xml
install_path\NetBackup\logs\bpbrmvlt\mmddyy.log
install_path\NetBackup\logs\vault\mmddyy.log
install_path\NetBackup\vault\sessions\vlt_name\sidxxx\detail.log
install_path\NetBackup\vault\sessions\vlt_name\sidxxx\summary.log
install_path\NetBackup\vault\sessions\vlt_name\sidxxx\vlteject.status
install_path\NetBackup\vault\sessions\vlteject.mstr
install_path\NetBackup\bp.conf

SEE ALSO

See vltopmenu.