Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (9.1)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  2. 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
  3.  
    Index

Name

bpstsinfo — display information on storage servers, LSUs, images, and plugins

SYNOPSIS

bpstsinfo -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...]

bpstsinfo -deleteimage | -di -servername | -sn server_name -serverprefix server_prefix -lsuname lsu_name -imagename image_name -imagedate image_date [-remote remote_server...]

bpstsinfo -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...]

bpstsinfo -diskspaceinfo | -dsi -stype storage_type

bpstsinfo -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...]

bpstsinfo -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...]

bpstsinfo -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...]

bpstsinfo -plugininfo | -pi [-serverprefix server_prefix] [-stype server_type] [-remote remote_server...]

bpstsinfo -servercap | -sc [-stype server_type] -storage_server storage_server [-remote remote_server...]

bpstsinfo -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

SEE ALSO

See bpstuadd.

See bpstudel.

See bpstulist.

See bpsturep.