Search <book_title>...

Veritas NetBackup™ Commands Reference Guide

Last Published: 2017-07-21

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

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