Search <book_title>...

Veritas NetBackup™ Commands Reference Guide

Last Published: 2021-06-07

Product(s): NetBackup (9.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. 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. configureCerts
85. configureCertsForPlugins
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. manageClientCerts
101. mklogdir
102. nbauditreport
103. nbcallhomeproxyconfig
104. nbcatsync
105. NBCC
106. NBCCR
107. nbcertcmd
108. nbcertupdater
109. nbcldutil
110. nbcloudrestore
111. nbcomponentupdate
112. nbcplogs
113. nbcredkeyutil
114. nbdb_admin
115. nbdb_backup
116. nbdb_move
117. nbdb_ping
118. nbdb_restore
119. nbdb_unload
120. nbdb2adutl
121. nbdbms_start_server
122. nbdbms_start_stop
123. nbdc
124. nbdecommission
125. nbdelete
126. nbdeployutil
127. nbdevconfig
128. nbdevquery
129. nbdiscover
130. nbdna
131. nbemm
132. nbemmcmd
133. nbfindfile
134. nbfirescan
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

nbsmartdiag — detects performance issues for registered NetBackup processes and collects appropriate troubleshooting information.

SYNOPSIS

nbsmartdiag -install

nbsmartdiag -uninstall

nbsmartdiag -start

nbsmartdiag -terminate

nbsmartdiag -version

nbsmartdiag -help

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 nbsmartdiag utility detects performance issues such as CPU utilization, memory usage, and deadlocks for the registered NetBackup processes. When nbsmartdiag detects these issues, it begins to collect the appropriate evidence for further troubleshooting without any user intervention.

This utility is designed to collect evidence to assist with troubleshooting. Veritas recommends that you stop the utility once the evidence is collected.

The nbsmartdiag utility runs as Local System or root.

The behavior of the utility is defined by modifying bp.conf or registry values. The bp.conf file values are set on the master server with the bpsetconfig command or the nbsetconfg command on client.

After the configuration is complete, start the service with the nbsmartdiag -start command. On Windows you can also start the utility from Service Control Manager.

The evidence is gathered in the nbsmartdiag folder at the location that is specified in the NBSD_EVIDENCE_PATH value. For each instance of the process, there is a subfolder inside the process name folder. Under that process ID folder, the evidence is collected for each occurrence of an event.

Java processes have a common run-time name. To monitor the NetBackup Administrative Console use adminconsole. For NetBackup Web Management Service use nbwmc in the process names.

Table: bp.conf values and Windows registry key names

Value	Details
NBSD_POLL_INTERVAL	Description Interval in seconds after which the service checks the process. Registry key type DWORD Default value 600
NBSD_DUMP_COUNT	Description Number of dumps to take once threshold is detected. Registry key type DWORD Default value 3 Valid range for this value is 0 to 10. Any invalid input results in this value being reset to the default.
NBSD_MONITOR_CPU	Description Process to be monitored for CPU usage threshold in percentage. Format is **ProcessName:cpu_in_percent. Do not specify the percent sign. Registry key type REG_SZ** Default value PROC_NAME1:CPU_percent, PROC_NAME2:CPU_percent, PROC_NAME3:CPU_percent
NBSD_MONITOR_MEMORY	Description Process to be monitored for Memory usage threshold. Format is ProceessName:MemSize. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value PROC_NAME1:MEM_SIZE1, PROC_NAME2:MEM_SIZE2, PROC_NAME3:MEM_SIZE3
NBSD_MEMORY_UNIT	Description This value determines the units the utility uses for memory calculations. If the unit is PERCENT then the memory threshold calculations are done as the percent of memory the process uses out of the total system memory. If the unit is ABSOLUTE then the absolute value in megabytes is used for threshold calculations. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value ABSOLUTE
NBSD_MONITOR_DEADLOCK	Description Process to be monitored for Deadlock. If CPU and Memory usage are constant for a long interval, Veritas assumes that it is a deadlock. The default value is 60 minutes. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value PROC_NAME1, PROC_NAME2, PROC_NAME3
NBSD_DEADLOCK_INTERVAL	Description The interval, in minutes, after which the process is considered inactive. Registry key type DWORD Default value 60
NBSD_ALWAYS_DUMP	Description Capture the process dump without taking into account the average of last 5 readings. When this parameter is set to 1, the utility captures the process dump every time the threshold is reached. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_CAPTURE_PROCESS_DUMP	Description Set this value to 1 to capture the Process Dump when the threshold is reached. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_INCREASE_LOG_LEVEL	Description Increase the logging for the process automatically. Changes to this value result in changes in the `nblog.conf` file. This value is for the VxUL processes. This value does not change the log level for legacy processes as it leads to large log files. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_CAPTURE_NETWORK_STAT	Description Set the value as 1 to monitor network connections at the time of event. Registry key type DWORD Default value 1 Valid values are either 0 or 1.
NBSD_CAPTURE_DISK_IO	Description Set this value to 1 to capture system disk IO stats at the point of event. Registry key type DWORD Default value 1 Valid values are either 0 or 1.
NBSD_NUMBER_OF_READINGS	Description This setting defines the number of readings to capture in case of the threshold event. Registry key type DWORD Default value 50
NBSD_READING_INTERVAL	Description Specifies the interval when the reading should be taken. Registry key type DWORD Default value 5
NBSD_PURGE_OLD_EVIDENCE	Description Purges the old evidence logs present in the directory that is given in the NBSD_EVIDENCE_PATH value. Be sure to make copies of the evidence otherwise the information is lost. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_CAPTURE_WITHOUT_THRESHOLD	Description When this option is set, nbsmartdiag captures the evidence even if the threshold had not reached for the registered process. This flag overrides all the threshold values. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_JDK_HOME	Description Path to JDK Home folder. This option is required to execute JSTACK on Java processes. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value None
NBSD_EVIDENCE_PATH	Description Path to evidence collection folder. This value is a required value. Ensure that the folder has sufficient space to gather logs. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value None. This value is mandatory for the service to launch.
NBSD_VERBOSE	Description Enable verbose logs for the NetBackup Performance Smart Diagnosis (NBSD). Registry key type DWORD Default value 0 Valid values are either 0 or 1.

REQUIREMENTS

This utility only works for Windows, RHEL, and SUSE operating systems.

For Linux, the commands that are shown must be present on the computer to gather all supporting evidence: gcore, gstack, iostat, mpstat, netstat, pmap, top, and vmstat

For Windows, you must install the utility on Windows Server 2012 R2 or later. The utility uses process snapshot APIs which were introduced in Windows Server 2012 R2. Attempts to install the utility on older versions of Windows result in failure.

You must manually start the nbsmartdiag service. The bpup, bp.start_all, and netbackup start, commands do not start the service. This behavior is by design.

Note:

Cyrillic characters in the evidence path are not supported.

OPTIONS

-help: Displays the help output for the nbsmartdiag utility.

-install: Installs the nbsmartdiag utility.

-start: Starts the nbsmartdiag utility.

-terminate: Stops the nbsmartdiag utility.

-uninstall: Uninstalls the nbsmartdiag utility.

-version: Displays the version information for the nbsmartdiag utility.