Search <book_title>...

NetBackup™ Commands Reference Guide

Last Published: 2022-03-28

Product(s): NetBackup (10.0)

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. bpcleanrestore
22. bpclient
23. bpclimagelist
24. bpclntcmd
25. bpclusterutil
26. bpcompatd
27. bpconfig
28. bpdbjobs
29. bpdbm
30. bpdgclone
31. bpdown
32. bpduplicate
33. bperror
34. bpexpdate
35. bpfis
36. bpflist
37. bpgetconfig
38. bpgetdebuglog
39. bpimage
40. bpimagelist
41. bpimmedia
42. bpimport
43. bpinst
44. bpkeyfile
45. bpkeyutil
46. bplabel
47. bplist
48. bpmedia
49. bpmedialist
50. bpminlicense
51. bpnbat
52. bpnbaz
53. bppficorr
54. bpplcatdrinfo
55. bpplclients
56. bppldelete
57. bpplinclude
58. bpplinfo
59. bppllist
60. bpplsched
61. bpplschedrep
62. bpplschedwin
63. bppolicynew
64. bpps
65. bprd
66. bprecover
67. bprestore
68. bpretlevel
69. bpschedule
70. bpschedulerep
71. bpsetconfig
72. bpstsinfo
73. bpstuadd
74. bpstudel
75. bpstulist
76. bpsturep
77. bptestbpcd
78. bptestnetconn
79. bptpcinfo
80. bpup
81. bpverify
82. cat_convert
83. cat_export
84. cat_import
85. configureCerts
86. configureMQ
87. configurePorts
88. configureWebServerCerts
89. create_nbdb
90. csconfig cldinstance
91. csconfig cldprovider
92. csconfig meter
93. csconfig reinitialize
94. csconfig throttle
95. duplicatetrace
96. importtrace
97. jbpSA
98. jnbSA
99. ltid
100. mklogdir
101. nbauditreport
102. nbcallhomeproxyconfig
103. nbcatsync
104. NBCC
105. NBCCR
106. nbcertcmd
107. nbcertupdater
108. nbcldutil
109. nbcloudrestore
110. nbcomponentupdate
111. nbcplogs
112. nbcredkeyutil
113. nbdb_admin
114. nbdb_backup
115. nbdb_move
116. nbdb_ping
117. nbdb_restore
118. nbdb_unload
119. nbdb2adutl
120. nbdbms_start_server
121. nbdbms_start_stop
122. nbdc
123. nbdecommission
124. nbdelete
125. nbdeployutil
126. nbdevconfig
127. nbdevquery
128. nbdiscover
129. nbdna
130. nbemm
131. nbemmcmd
132. nbfindfile
133. nbfirescan
134. nbfp
135. nbftadm
136. nbftconfig
137. nbgetconfig
138. nbhba
139. nbholdutil
140. nbhostidentity
141. nbhostmgmt
142. nbhypervtool
143. nbidpcmd
144. nbimageshare
145. nbinstallcmd
146. nbjm
147. nbkmiputil
148. nbkmscmd
149. nbkmsutil
150. nboraadm
151. nborair
152. nbpem
153. nbpemreq
154. nbmlb
155. nbperfchk
156. nbplupgrade
157. nbrb
158. nbrbutil
159. nbregopsc
160. nbreplicate
161. nbrepo
162. nbrestorevm
163. nbseccmd
164. nbserviceusercmd
165. nbsetconfig
166. nbsmartdiag
167. nbsnapimport
168. nbsnapreplicate
169. nbsqladm
170. nbstl
171. nbstlutil
172. nbstop
173. nbsu
174. nbsvrgrp
175. netbackup_deployment_insights
176. resilient_clients
177. restoretrace
178. stopltid
179. tldd
180. tldcd
181. tpautoconf
182. tpclean
183. tpconfig
184. tpext
185. tpreq
186. tpunmount
187. verifytrace
188. vltadm
189. vltcontainers
190. vlteject
191. vltinject
192. vltoffsitemedia
193. vltopmenu
194. vltrun
195. vmadd
196. vmchange
197. vmcheckxxx
198. vmd
199. vmdelete
200. vmoprcmd
201. vmphyinv
202. vmpool
203. vmquery
204. vmrule
205. vmupdate
206. vnetd
207. vssat
208. vwcp_manage
209. vxlogcfg
210. vxlogmgr
211. vxlogview
212. W2KOption
Index

Name

vxlogmgr — manages the log files generated by the products that support Unified Logging

SYNOPSIS

vxlogmgr { -c | -m } -f AbsoluteDir [-a]

vxlogmgr { -d | -F } [-a]

vxlogmgr {-c | -m | -A filename} -f AbsoluteDir [-p ProductID] [-o OriginatorID] [-n Days] [-t Time] [-b StartDate] [-g LogSet] [-e EndDate] [-q] [-z]

vxlogmgr {-c | -m | -A filename} -f AbsoluteDir -w QueryString [-q] [-z]

vxlogmgr {-d | -F | -s} [-p ProductID] [-o OriginatorID] [-n Days] [-t Time] [-b StartDate] [-g LogSet] [-e EndDate] [-q] [-z]

vxlogmgr {-d | -F | -s} -w QueryString [-q] [-z]

vxlogmgr -v

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

The vxlogmgr utility manages the log files that the unified logging-enabled applications generate. Log file management includes actions such as deleting or moving the log files that are based on log management configuration settings.

Unified logging uses a standardized naming format for log files, as follows:

productID-originatorID-hostID-date-rotation.log

For more information about the unified logging naming format, and the logging originator IDs, refer to the NetBackup Logging Reference Guide.

OPTIONS

Specify the log management action to perform.

-A, --arch FileName

Creates an archive named FileName for the specified set of conditions. The compressed zip file requires WinZip and wzzip on Windows to produce a zip file. On UNIX, a tar utility and GnuZip are required to produce a tar.gzip file.

-a, --auto

Retrieves the log files that are based on individual configuration settings for NumberOfLogFiles. The actions are taken based on the given action type (such as move, copy, or delete). When the -a option is specified, the other options cannot be used.

-b, --stdate 'StartDate'

Manages the log files that are created at the specified start date.

The required date and time values format in NetBackup commands varies according to your locale. The /usr/openv/msg/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.

See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.

It is surrounded by single quotes in UNIX and double quotes in Windows. For example:

UNIX: --stdate '1/1/2013 12:00:00 AM'

Windows: --stdate "1/1/2013 12:00:00 AM"

-c, --cp

Copies log files from the folder that is configured by the product to the specified folder.

-d, --del

Deletes the log files from the folder that the product configures.

-e, --endate 'EndDate'

Manages the log files that are created up to the specified EndDate.

See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.

This option must be surrounded by single quotes in UNIX and double quotes in Windows.

UNIX: --endate '1/1/2013 12:00:00 PM'

Windows: --stdate "1/1/2013 12:00:00 AM"

-f, --dir AbsoluteDir

Specifies the absolute name of the directory into which the log files are to be copied.

On UNIX systems, this directory must be on the same device as the opt/openv/netbackup/logs directory, because the logs are hard linked rather than copied.

This option is valid only with the -c option.

-F, --flush

Deletes all log files for the host that originates this command except the most current log file. If the host that runs this command uses a shared directory, all log files for all hosts that use the same directory are removed. Only the most current file is preserved for the host that originated the flush command.

-m, --mv

Moves log files from the folder that the product that is configured to the specified folder.

-n --days NumberOfDays

Manages the log files that are created in last NumberOfDays days for the specified action.

-o, --origid OriginatorID

Manages the log files that are identified by a given originator ID (OriginatorID).

-p, --prodid ProductID

Manages the log files that are identified by a given product ID (ProductID) for the specified action. Instead of an identifier, the user can provide the product name.

-q, --quiet

Prevents messages from being displayed (Quiet Mode).

-s, --vw

Views the log files for a given query.

-t, --tail hh:mm:ss

Manages the log files for the last hh:mm:ss hours.

-v, --version

Displays the version information for this command.

-w, --where QueryString

Retrieves a subset of logs that is based on a query string or condition (QueryString).

-z, --displaytimezone

Displays the time zone information along with the log file display.

EXIT STATUS

The following exit values are returned:

0 Successful completion.

-1 An error occurred.

QUERY STRINGS

A query string is a text expression, similar to a database WHERE clause, that is used to retrieve log entries from the unified logging system. The expression is a combination of relational operators, constant integers, constant strings, and names of log fields that evaluate to a single value. Logical operators, such as AND and OR, are used to group expressions.

Supported relation operators include:

< Less than

> Greater than

<= Less than and equal to

>= Greater than and equal to

= Equal to

!= Not equal to

Supported logical operators include && (logical AND) and || (logical OR).

Predefined log fields include:

PRODID Product identifier (integer or string)

ORGID Originator identifier (integer or string)

STDATE Locale-specific start date (long integer or string [such as 'mm/dd/yy'])

ENDATE Locale-specific end date (long integer or string [such as 'mm/dd/yy'])

PREVTIME Previous time (string [hh:mm:ss])

EXAMPLES

Example 1 - Automatically move the older log files that NetBackup created to the folder /tmp/nblogs. The --auto option depends on the configuration setting NumberOfLogFiles.

# vxlogmgr -m --auto --dir /tmp/nblogs

Example 2 - Delete the last 15 days of NetBackup log files:

# vxlogmgr -d --prodid NB -n 15

Example 3- Copy the log files created from date 01/22/12 by NetBackup:

# vxlogmgr -c --where "(prodid = NB) && (stdate >= '01/22/12')"

UNIX systems:

--dir /usr/openv/logs

Windows systems:

--dir c:\temp\logfiles

Example 4 - Copy the log files that are created between 10/10/11 and 10/28/11 inclusive by product ID 100:

# vxlogmgr -c --where "(PRODID == 100) && ((STDATE >= '10/10/11')