Search <book_title>...

Veritas NetBackup™ Commands Reference Guide

Last Published: 2018-09-19

Product(s): NetBackup (8.1.2)

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

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 value 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.

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.

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')