Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.2)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
    6.  
      Removal of nbexecute command
  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.  
      configurePorts
    85.  
      configureTPCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig throttle
    91.  
      duplicatetrace
    92.  
      importtrace
    93.  
      jbpSA
    94.  
      jnbSA
    95.  
      ltid
    96.  
      manageClientCerts
    97.  
      mklogdir
    98.  
      nbauditreport
    99.  
      nbcatsync
    100.  
      NBCC
    101.  
      NBCCR
    102.  
      nbcertcmd
    103.  
      nbcertupdater
    104.  
      nbcldutil
    105.  
      nbcloudrestore
    106.  
      nbcomponentupdate
    107.  
      nbcplogs
    108.  
      nbdb_admin
    109.  
      nbdb_backup
    110.  
      nbdb_move
    111.  
      nbdb_ping
    112.  
      nbdb_restore
    113.  
      nbdb_unload
    114.  
      nbdbms_start_server
    115.  
      nbdbms_start_stop
    116.  
      nbdc
    117.  
      nbdecommission
    118.  
      nbdelete
    119.  
      nbdeployutil
    120.  
      nbdevconfig
    121.  
      nbdevquery
    122.  
      nbdiscover
    123.  
      nbdna
    124.  
      nbemm
    125.  
      nbemmcmd
    126.  
      nbfindfile
    127.  
      nbfirescan
    128.  
      nbftadm
    129.  
      nbftconfig
    130.  
      nbgetconfig
    131.  
      nbhba
    132.  
      nbholdutil
    133.  
      nbhostidentity
    134.  
      nbhostmgmt
    135.  
      nbhypervtool
    136.  
      nbinstallcmd
    137.  
      nbjm
    138.  
      nbkmsutil
    139.  
      nboraadm
    140.  
      nborair
    141.  
      nbpem
    142.  
      nbpemreq
    143.  
      nbperfchk
    144.  
      nbplupgrade
    145.  
      nbrb
    146.  
      nbrbutil
    147.  
      nbregopsc
    148.  
      nbreplicate
    149.  
      nbrepo
    150.  
      nbrestorevm
    151.  
      nbseccmd
    152.  
      nbsetconfig
    153.  
      nbsnapimport
    154.  
      nbsnapreplicate
    155.  
      nbsqladm
    156.  
      nbstl
    157.  
      nbstlutil
    158.  
      nbstop
    159.  
      nbsu
    160.  
      nbsvrgrp
    161.  
      resilient_clients
    162.  
      restoretrace
    163.  
      stopltid
    164.  
      tl4d
    165.  
      tl8d
    166.  
      tl8cd
    167.  
      tldd
    168.  
      tldcd
    169.  
      tlhd
    170.  
      tlhcd
    171.  
      tlmd
    172.  
      tpautoconf
    173.  
      tpclean
    174.  
      tpconfig
    175.  
      tpext
    176.  
      tpreq
    177.  
      tpunmount
    178.  
      verifytrace
    179.  
      vltadm
    180.  
      vltcontainers
    181.  
      vlteject
    182.  
      vltinject
    183.  
      vltoffsitemedia
    184.  
      vltopmenu
    185.  
      vltrun
    186.  
      vmadd
    187.  
      vmchange
    188.  
      vmcheckxxx
    189.  
      vmd
    190.  
      vmdelete
    191.  
      vmoprcmd
    192.  
      vmphyinv
    193.  
      vmpool
    194.  
      vmquery
    195.  
      vmrule
    196.  
      vmupdate
    197.  
      vnetd
    198.  
      vssat
    199.  
      vwcp_manage
    200.  
      vxlogcfg
    201.  
      vxlogmgr
    202.  
      vxlogview
    203.  
      W2KOption

Name

bpstulist — display NetBackup storage units or storage unit groups

SYNOPSIS

bpstulist -label storage_unit_label [,...] [-L | -l | -U | -show_available | -lsa ] [ -g | -go ] [-verbose] [-M master_server [,...]] [-reason "string"]

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

SEE ALSO

See bpstsinfo.

See bpstuadd.

See bpstudel.

See bpsturep.