Search <book_title>...

Veritas NetBackup™ Commands Reference Guide

Last Published: 2018-02-16

Product(s): NetBackup (8.1.1)

Introduction
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. bppolicynew
62. bpps
63. bprd
64. bprecover
65. bprestore
66. bpretlevel
67. bpschedule
68. bpschedulerep
69. bpsetconfig
70. bpstsinfo
71. bpstuadd
72. bpstudel
73. bpstulist
74. bpsturep
75. bptestbpcd
76. bptestnetconn
77. bptpcinfo
78. bpup
79. bpverify
80. cat_convert
81. cat_export
82. cat_import
83. configurePorts
84. create_nbdb
85. csconfig cldinstance
86. csconfig cldprovider
87. csconfig meter
88. csconfig throttle
89. duplicatetrace
90. importtrace
91. jbpSA
92. jnbSA
93. ltid
94. manageClientCerts
95. mklogdir
96. nbauditreport
97. nbcatsync
98. NBCC
99. NBCCR
100. nbcertcmd
101. nbcertupdater
102. nbcldutil
103. nbcomponentupdate
104. nbcplogs
105. nbdb_admin
106. nbdb_backup
107. nbdb_move
108. nbdb_ping
109. nbdb_restore
110. nbdb_unload
111. nbdbms_start_server
112. nbdbms_start_stop
113. nbdc
114. nbdecommission
115. nbdelete
116. nbdeployutil
117. nbdevconfig
118. nbdevquery
119. nbdiscover
120. nbdna
121. nbemm
122. nbemmcmd
123. nbexecute
124. nbfindfile
125. nbfirescan
126. nbftadm
127. nbftconfig
128. nbgetconfig
129. nbhba
130. nbholdutil
131. nbhostidentity
132. nbhostmgmt
133. nbhypervtool
134. nbjm
135. nbkmsutil
136. nboraadm
137. nborair
138. nbpem
139. nbpemreq
140. nbperfchk
141. nbplupgrade
142. nbrb
143. nbrbutil
144. nbregopsc
145. nbreplicate
146. nbrestorevm
147. nbseccmd
148. nbsetconfig
149. nbsnapimport
150. nbsnapreplicate
151. nbsqladm
152. nbstl
153. nbstlutil
154. nbstop
155. nbsu
156. nbsvrgrp
157. resilient_clients
158. restoretrace
159. stopltid
160. tl4d
161. tl8d
162. tl8cd
163. tldd
164. tldcd
165. tlhd
166. tlhcd
167. tlmd
168. tpautoconf
169. tpclean
170. tpconfig
171. tpext
172. tpreq
173. tpunmount
174. verifytrace
175. vltadm
176. vltcontainers
177. vlteject
178. vltinject
179. vltoffsitemedia
180. vltopmenu
181. vltrun
182. vmadd
183. vmchange
184. vmcheckxxx
185. vmd
186. vmdelete
187. vmoprcmd
188. vmphyinv
189. vmpool
190. vmquery
191. vmrule
192. vmupdate
193. vnetd
194. vwcp_manage
195. vxlogcfg
196. vxlogmgr
197. vxlogview
198. 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