Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configurePorts
- configureTPCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- manageClientCerts
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbinstallcmd
- nbjm
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
bpstulist — display NetBackup storage units or storage unit groups
SYNOPSIS
-label storage_unit_label [,...] [-L | -l | -U | -show_available | -lsa ] [ -g | -go ] [-verbose] [-M master_server [,...]] [-reason "string"]
-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 instance, a robot-type entry might be TL4 (7) (7 is NetBackup's internal value for a TL4 robot).
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
- Disk Pool
- Snapshots
- Replication Primary
- Replication Source
- Replication Target
- Mirror
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
- File System Export
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 instance, a robot-type value might be TL4, instead of 7.
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
- DiskPool
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 Disk Pool: simSnapVaultA Snapshots: yes Replication Primary: no Replication Source: yes Replication Target: yes Mirror: 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
UNIX systems:
/usr/openv/netbackup/logs/admin/*
Windows systems:
install_path\NetBackup\logs\admin\*
EMM database