Search <book_title>...

Important Update: Cohesity Products Documentation

All Cohesity product documentation are now managed via the Cohesity Docs Portal: https://docs.cohesity.com/HomePage/Content/home.htm. Some documentation available here may not reflect the latest information or may no longer be accessible.

NetBackup™ Commands Reference Guide

Last Published: 2025-11-24

Product(s): NetBackup (11.1)

Introduction
Appendix A. NetBackup Commands
1. acsd
2. backupdbtrace
3. backuptrace
4. bmrc
5. bmrconfig
6. bmrepadm
7. bmrprep
8. bmrs
9. bmrsrtadm
10. bp
11. bparchive
12. bpbackup
13. bpbackupdb
14. bpcatarc
15. bpcatlist
16. bpcatres
17. bpcatrm
18. bpcd
19. bpchangeprimary
20. bpcleanrestore
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. bpup
79. bpverify
80. cat_convert
81. cat_export
82. cat_import
83. configureCerts
84. configureMQ
85. configureWebServerCerts
86. create_nbdb
87. csconfig cldinstance
88. csconfig cldprovider
89. csconfig meter
90. csconfig reinitialize
91. csconfig throttle
92. duplicatetrace
93. importtrace
94. jbpSA
95. jnbSA
96. ltid
97. mklogdir
98. msdpcldutil
99. msdpimgutil
100. nbauditreport
101. nbcallhomeproxyconfig
102. nbcatsync
103. NBCC
104. NBCCR
105. nbcertcmd
106. nbcertupdater
107. nbcldutil
108. nbcmdrun
109. nbcomponentupdate
110. nbcplogs
111. nbcredkeyutil
112. nbdb_admin
113. nbdb_backup
114. nbdb_move
115. nbdb_ping
116. nbdb_restore
117. nbdb_unload
118. nbdb2adutl
119. nbdbms_start_server
120. nbdbms_start_stop
121. nbdc
122. nbdecommission
123. nbdelete
124. nbdeployutil
125. nbdevconfig
126. nbdevquery
127. nbdiscover
128. nbdna
129. nbemm
130. nbemmcmd
131. nbepicfile
132. nbfindfile
133. nbfirescan
134. nbfp
135. nbftadm
136. nbftconfig
137. nbgetconfig
138. nbhba
139. nbholdutil
140. nbhostidentity
141. nbhostmgmt
142. nbhsmcmd
143. nbhypervtool
144. nbidpcmd
145. nbimageshare
146. nbinstallcmd
147. nbjm
148. nbkmiputil
149. nbkmscmd
150. nbkmsutil
151. nblogparser
152. nbmariadb
153. nbmysql
154. nbmlb
155. nborair
156. nboracmd
157. nbpem
158. nbpemreq
159. nbmariadb
160. nbmlb
161. nbperfchk
162. nbpgsql
163. nbplupgrade
164. nbrb
165. nbrbutil
166. nbreplicate
167. nbrepo
168. nbrestorevm
169. nbseccmd
170. nbserviceusercmd
171. nbsetconfig
172. nbshvault
173. nbsmartdiag
174. nbsnapimport
175. nbsnapreplicate
176. nbsqlcmd
177. nbsqlite
178. nbstl
179. nbstlutil
180. nbstop
181. nbsu
182. nbsvrgrp
183. netbackup_deployment_insights
184. resilient_clients
185. restoretrace
186. stopltid
187. tiermover
188. tldd
189. tldcd
190. tpautoconf
191. tpclean
192. tpconfig
193. tpext
194. tpreq
195. tpunmount
196. verifytrace
197. vltadm
198. vltcontainers
199. vlteject
200. vltinject
201. vltoffsitemedia
202. vltopmenu
203. vltrun
204. vmadd
205. vmchange
206. vmcheckxxx
207. vmd
208. vmdelete
209. vmoprcmd
210. vmphyinv
211. vmpool
212. vmquery
213. vmrule
214. vmupdate
215. vnetd
216. vssat
217. vwcp_manage
218. vxlogcfg
219. vxlogmgr
220. vxlogview
221. W2KOption

Name

bpstulist — display NetBackup storage units or storage unit groups

SYNOPSIS

bpstulist -group storage_unit_group [-verbose] [-M master_server [,...]

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\

DESCRIPTION

The bpstulist command displays the attributes for a NetBackup storage unit or storage unit group. If no storage label or storage unit group name is specified, bpstulist displays the attributes for all NetBackup storage units or storage unit groups. In addition, this command accepts a comma-separated list of storage unit labels and displays the information for each of the storage units. The -show_available and -lsa flags enable you to list all of the configured media servers for a particular storage unit.

Errors are sent to stderr. A log of the command's activity is sent to the NetBackup admin log file for the current day.

For more about storage units, see the NetBackup Administrator's Guide, Volume I.

Any authorized user can run this command.

For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.

OPTIONS

List-type options:

-L

The list type is long. This option produces a listing with one storage unit attribute per line, in the format storage-unit attribute: value. Some attribute values are expressed in both interpreted form and raw form.

For a disk storage unit, a long listing has these attributes for each storage unit:

Label
Storage Unit Type (For example, Disk (0))
Media Subtype (For example, BasicDisk (1))
Host Connection
Concurrent Jobs
On Demand Only
Max MPX
Max Fragment Size
Block Sharing
OK On Root

A long listing has these attributes for each DiskPool disk storage unit:

Label
Storage Unit Type
Media Subtype (DiskPool (6))
Host Connection (one host per line)
Concurrent Jobs
On Demand Only
Max Fragment Size
Max MPX
Block sharing
Use WORM
File System Export
Disk Pool
Snapshots
Replication Primary
Replication Source
Replication Target
Mirror

A long listing has these attributes for each Media Manager storage unit:

Label
Storage Unit Type (For example, Tape (0))
Host Connection
Concurrent Jobs
On Demand Only
Robot Type
Max Fragment Size
Max MPX/drive

-l

The list type is short, which produces a terse listing. This option is useful for the scripts or the programs that rework the listing contents into a customized report format. This option is the default list type.

A single line contains the information for a storage unit, with all attribute values expressed in raw form. The fields on this line are:

label
storage unit type
host
density
concurrent_jobs
initial_mpx
path
on_demand_only
max_mpx
maxfrag_size
ndmp_attach_host
throttle (SnapVault only)
subtype
disk_flags
high_water_mark
low_water_mark
ok_on_root
disk_pool
host_list (one or more comma delimited)

-U

The list type is user. This option produces a listing with one storage-unit attribute per line, in the format storage-unit attribute: value. Attribute values are expressed in interpreted form.

For a disk storage unit, a user-type list has these attributes for each storage unit:

Label
Storage Unit Type (the storage-unit type)
Storage Unit Subtype
Host Connection
Concurrent Jobs
On Demand Only
Max MPX
Path
Max Fragment Size
Stage data
High Water Mark
Ok On Root

For a DiskPool disk storage unit, a user-type list has these attributes for each storage unit:

Label
Storage Unit Type
Host Connection (one host per line)
Concurrent Jobs
On Demand Only
Max Fragment Size
Max MPX
Use WORM
DiskPool
WORM Capable

For a Media Manager storage unit, a user-type list has these attributes for each storage unit:

Label
Storage Unit Type
Storage Unit Subtype
Host Connection
Concurrent Jobs
On Demand Only
Max MPX/drive
Robot Type
Max Fragment Size

-g

This list type causes the storage unit list to include the storage unit groups. The format of this option produces a listing with one storage unit group per line, in the format group_name: group_members. This option also includes the Selection Method value at the beginning of the Storage Unit Group List.

-go: This list type causes the storage unit list to include only information on the storage unit groups.

-label storage_unit_label1 [,storage_unit_label2...]: Specifies the name of the storage unit. This list is a comma-separated list of storage unit labels. If this option is not present, the listing is for all storage units. The maximum length for a storage-unit label is 128 characters.

-group storage_unit_group

Specifies a list of defined storage units and storage unit groups. For the list of storage units, the list type is short, which produces a terse listing. The list of storage unit groups is in the format group_name: group_members.

-lsa

Lists all storage units in the database including any available media servers on the media server list.

-M master_server1 [,master_server2...]

Specifies a comma-separated list of master servers. If this option is present, the command is run on each of the master servers in this list. The master servers must allow access by the system that issued the command. If an error occurs for any master server, the process stops at that point in the list. The default is the master server for the system where the command is entered.

-reason "string"

Indicates the reason why you choose this command action. The reason text string that you enter is captured and appears in the audit report. Enclose this string with double quotes ("..."). The string must not exceed 512 characters. It cannot begin with a dash character (-) nor contain a single quotation mark (').

-show_available

Lists all storage units in the database including any available media servers on the media server list.

-verbose

Select verbose mode for logging. This mode is meaningful when only you run with the debug log function on (that is, when the following directory is defined):

UNIX systems:

/usr/openv/netbackup/logs/admin

Windows systems:

install_path\NetBackup\logs\admin

EXAMPLES

Example 1 - List the storage units that are defined on the master server apricot by using the -U display option:

# bpstulist -U -M apricot

Label:               redtest
Storage Unit Type:   Disk
Host Connection:     apricot
Concurrent Jobs:     1
On Demand Only:      yes
Max MPX:             4
Max Fragment Size:   512000 MB 
Block Sharing:       yes
OK On Root:          no
Use WORM:            no
Disk Pool:           simSnapVaultA
Snapshots:           yes
Replication Primary: no
Replication Source:  yes
Replication Target:  yes
Mirror:              no
WORM Capable:        no

Example 2 - The following output is realized by using the following bpstuadd command to create a regular disk staging storage unit:

# bpstuadd -label pear -path /tmp/pear -flags STAGE_DATA

Short output:

pear 0 felix.example.com 0 -1 -1 1 0 "/tmp/pear" 1 1 2000 
*NULL* 0 1 0 98 80 1 pear felix.example.com

Long output:

Label:               pear
Media Type:          Disk (0)
Host Connection:     felix.example.com
Concurrent Jobs:     1
On Demand Only:      yes
Path:                "/tmp/pear"
Robot Type:          (not robotic)
Max Fragment Size:   512000  
Max MPX:             1
Stage data:          no
Block Sharing:       no
File System Export:  no
High Water Mark:     98
Low Water Mark:      80
OK On Root:          no

FILES