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
- bpcleanrestore
- 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
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcloudrestore
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nbpem
- nbpemreq
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- 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
bpstsinfo — display information on storage servers, LSUs, images, and plugins
SYNOPSIS
-comparedbandstu | -cdas -servername | -sn server_name | -storage_server storage_server -serverprefix server_prefix | -stype server_type [-lsuname lsu_name],... -oldservervolume old_sts_server:old_volume [-oldservervolume old_sts_server:old_volume ...] [-remote remote_server...]
-deleteimage | -di -servername | -sn server_name -serverprefix server_prefix -lsuname lsu_name -imagename image_name -imagedate image_date [-remote remote_server...]
-deleteimagegroup | -dig -servername | -sn server_name | -storage_server storage_server -serverprefix server_prefix -lsuname lsu_name -imagename image_name -imagedate image_date [-remote remote_server...]
-diskspaceinfo | -dsi -stype storage_type
-imagegrouplist | -igl [-servername | -sn server_name] [-serverprefix server_prefix] [-lsuname lsu_name,...] [-imagename image_name] [[-imagedatestart image_date] [-imagedateend image date]] [-imagetype STS_FULL_ONLY | STS_INCR_ONLY ] [-remote remote_server...]
-imageinfo | -ii [-servername | -sn server_name] [-serverprefix server_prefix] [-lsuname lsu_name,...] [-imagename image_name] [-imagedate image_date] [[-imagedatestart image_date] [-imagedateend image date]] [-imagetype STS_FULL_ONLY | STS_INCR_ONLY] [-remote remote_server...]
-lsuinfo | -li [-servername | -sn server_name] [-serverprefix server_prefix] [-lsuname lsu_name,...] [-filteronimagemodetype [ STS_SA_IMAGE | STS_SA_OPAQUEF | STS_SA_CLEARF] [-remote remote_server...]
-plugininfo | -pi [-serverprefix server_prefix] [-stype server_type] [-remote remote_server...]
-servercap | -sc [-stype server_type] -storage_server storage_server [-remote remote_server...]
-serverinfo | -si [-servername | -sn server_name] [-serverprefix server_prefix] [-remote remote_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 bpstsinfo command displays the attributes for plugins, storage servers, logical storage units (LSUs), and the images that reside on disk. The command also compares images old and current servers and volumes, displays all image IDs for an image group, and deletes a specified image. A log of the command activity is sent to the NetBackup admin log file for the current day. All errors for this command go to stderr.
Only authorized users can run this command.
For more about NetBackup authorization, see the NetBackup Security and Encryption Guide.
OPTIONS
Only one of the following options can be specified on a single command line.
- -comparedbandstu | -cdas
Compares the image information in the catalog to image information on the storage server physical media. -comparedbandstu compares the specified previous OpenStorage server(s) and volume(s) to the current OpenStorage server and volume.
- -deleteimage | -di
Deletes the specified image.
- -deleteimagegroup | -dig
Deletes the specified image group.
- -diskspaceinfo | -dsi
Prints the aggregated space for a specified disk type.
- -imagegrouplist | -igl
For a given image and image group type, print all associate image IDs
- -imageinfo | -ii
Prints the image information.
- -lsuinfo | -li
Prints the LSU information.
- -plugininfo | -pi
Prints the plugin information for internal and external plugins on the system. When you use -plugininfo with no sub-options, all plugins are printed. Use with -serverprefix to restrict the printout to only the plugin with the specified prefix. Use -stype to restrict the printout to only plugins of the specified storage server type.
- -serverinfo | -si
Prints the storage server information.
- -servercap | -sc
Prints the storage server capabilities.
SUB-OPTIONS
- -filteronimagemodetype [STS_SA_IMAGE | STS_SA_OPAQUEF | STS_SA_CLEARF]
Limits the LSUs to be printed on the system to the specified image mode type.
- -imagedate image_date
Specifies a single image. The following are acceptable formats:
03/08/2009 09:41:22
1110296416
This option can be used with -imageinfo only; it cannot be used with -imagedatestart or -imagedateend.
- -imagedateend image_date
Optional filter argument. By default, all images are used. Specify MM/DD/YYYY hh:mm:ss to the images to something that is equal to or newer than the image_date.
- -imagedatestart image_date
Optional filter argument. By default, all images are used. Specify MM/DD/YYYY hh:mm:ss to limit the images to something that is equal to or newer than the image_date.
- -imagename image_name
Optional filter argument. By default, all images are used. Specify image_name to limit to only the images that match.
- -imagetype STS_FULL_ONLY | STS_INCR_ONLY
Optional filter argument. By default, both the full and the incremental images are used. STS_FULL_ONLY or STS_INCR_ONLY to limit to only images from a full backup or an incremental backup.
- -lsuname lsu_name,...
Optional filter argument. By default, all LSUs are used. Specify lsu_name to limit to one LSU for each -lsuname supplied.
- -remote remote_server...
Specifies the name of a remote server to query for disk information. The remote server performs the bpstsinfo operation instead of the host on which the bpstsinfo command is executed. You can specify multiple remote servers, one for each -remote supplied.
- -servername server_name
Specifies the hostname of the STS server. If -servername is not specified, the hostname of the local host is used.
- -serverprefix server_prefix
Limits server prefixes to the one that server_prefix specifies. Optional filter argument. By default, all server prefixes are used. This option can be used with -serverinfo, -lsuinfo, and -imageinfo. The following are valid prefixes:
ntap:
STSBasicDisk:
PureDisk:
- -stype server_type
Specifies a string that identifies the storage server type. The server_type value can originate from one of the following sources:
Veritas provided storage. Possible values are AdvancedDisk and PureDisk.
Third-party disk appliances. The vendor supplies the server_type string.
Cloud storage. Use the csconfig cldprovider -l command to determine the possible stype values. The cloud stype values reflect the cloud storage provider. Cloud storage stype values can also incorporate a suffix (for example,
amazon_crypt). Possible suffixes are:_raw: The NetBackup backup image is sent to the cloud in raw format. Use this option if you do not want to compress or encrypt data before sending to cloud storage.
_rawc: Compresses the data before it is written to the cloud storage.
_crypt: Encrypt the data using AES-256 encryption before writing the data to cloud storage. You must have KMS configured in NetBackup to use this option._cryptc: Compress and encrypt the data before writing to cloud storage.
The storage server type is case sensitive.
When used with the -diskspaceinfo option, -stype specifies the disk type that is to display the aggregated space. An example of the output display:
Disktype: AdvancedDisk TotalCapacity: 100000000 TotalUsed: 10000000
Licensing is based on the TotalCapacity and TotalUsed values.
EXAMPLES
Example 1 - List the attributes of the lsu SnapMirrorA1 on storage server apricot:
# bpstsinfo -lsuinfo -serverprefix "ntap:" -servername apricot /
-lsuname /vol/dsu1
LsuInfo:
Server Name: ntapdfm
LSU Name: SnapMirrorA1
Allocation: STS_LSU_AT_STATIC
Storage: STS_LSU_ST_NONE
Description:
Configuration:
Media: (STS_LSUF_DISK | STS_LSUF_REP_ENABLED)
Save As: (STS_SA_SNAPSHOT | STS_SA_MIRROR)
Replication Sources: 1 ( simdisk:ntapdfm:SnapVaultA )
Replication Targets: 0 ( )
Maximum Transfer: 0
Block Size: 4096
Allocation Size: 0
Size: 171798691840
Bytes Used: 8895016960
Physical Bytes Used: 0
Resident Images: 0
Example 2 - List all capabilities for storage server sigt32.
# bpstsinfo -sc -stype Network_MWS -storage_server sigt32 Network_MWS:sigt32 STS_SRVC_ASYNC_WAIT STS_SRVC_CLAIM STS_SRVC_CLOSE_IMAGE STS_SRVC_CLOSE_IMAGE_LIST STS_SRVC_CLOSE_LSU_LIST STS_SRVC_CLOSE_SERVER STS_SRVC_COPY_IMAGE ... STS_SRVC_NAMED_ASYNC_ROLLBACK_SNAP STS_SRVC_NAMED_ASYNC_VALIDATE_SNAP_BYNAME STS_SRVC_NAMED_ASYNC_WAIT_SNAP STS_SRVC_OPEN_SNAP_LIST STS_SRVC_VALIDATE_ROLLBACK STS_SRVC_VALIDATE_SNAP_BYNAME