Important Update: Cohesity Products Documentation
All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.
NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- 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
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- msdpimgutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- 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
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhsmcmd
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tiermover
- 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
Name
vlteject — eject media and generate reports for previously run sessions
SYNOPSIS
-eject [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-auto y|n] [-eject_delay seconds]
-report [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-legacy]
-eject -report [-profile profile_name] [-robot robot_name] [-vault vault_name [-sessionid id]] [-auto y|n] [-eject_delay seconds] [-version] [-legacy]
-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.