NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  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.  
      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.  
      nbauditreport
    100.  
      nbcallhomeproxyconfig
    101.  
      nbcatsync
    102.  
      NBCC
    103.  
      NBCCR
    104.  
      nbcertcmd
    105.  
      nbcertupdater
    106.  
      nbcldutil
    107.  
      nbcmdrun
    108.  
      nbcomponentupdate
    109.  
      nbcplogs
    110.  
      nbcredkeyutil
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdb2adutl
    118.  
      nbdbms_start_server
    119.  
      nbdbms_start_stop
    120.  
      nbdc
    121.  
      nbdecommission
    122.  
      nbdelete
    123.  
      nbdeployutil
    124.  
      nbdevconfig
    125.  
      nbdevquery
    126.  
      nbdiscover
    127.  
      nbdna
    128.  
      nbemm
    129.  
      nbemmcmd
    130.  
      nbepicfile
    131.  
      nbfindfile
    132.  
      nbfirescan
    133.  
      nbfp
    134.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nboracmd
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmariadb
    155.  
      nbmlb
    156.  
      nbperfchk
    157.  
      nbplupgrade
    158.  
      nbrb
    159.  
      nbrbutil
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbshvault
    167.  
      nbsmartdiag
    168.  
      nbsnapimport
    169.  
      nbsnapreplicate
    170.  
      nbsqladm
    171.  
      nbsqlite
    172.  
      nbstl
    173.  
      nbstlutil
    174.  
      nbstop
    175.  
      nbsu
    176.  
      nbsvrgrp
    177.  
      netbackup_deployment_insights
    178.  
      resilient_clients
    179.  
      restoretrace
    180.  
      stopltid
    181.  
      tldd
    182.  
      tldcd
    183.  
      tpautoconf
    184.  
      tpclean
    185.  
      tpconfig
    186.  
      tpext
    187.  
      tpreq
    188.  
      tpunmount
    189.  
      verifytrace
    190.  
      vltadm
    191.  
      vltcontainers
    192.  
      vlteject
    193.  
      vltinject
    194.  
      vltoffsitemedia
    195.  
      vltopmenu
    196.  
      vltrun
    197.  
      vmadd
    198.  
      vmchange
    199.  
      vmcheckxxx
    200.  
      vmd
    201.  
      vmdelete
    202.  
      vmoprcmd
    203.  
      vmphyinv
    204.  
      vmpool
    205.  
      vmquery
    206.  
      vmrule
    207.  
      vmupdate
    208.  
      vnetd
    209.  
      vssat
    210.  
      vwcp_manage
    211.  
      vxlogcfg
    212.  
      vxlogmgr
    213.  
      vxlogview
    214.  
      W2KOption

Name

nbdevquery — display NetBackup disk media status

SYNOPSIS

nbdevquery -listconfig [-l | -U] -stype server_type -storage_server storage_server [-EMM emm_server]

nbdevquery -listdp | -listmounts [-l | -U | -D] [-stype server_type] [-dp disk_pool_name] [-M master_server] [-EMM emm_server]

nbdevquery -listdv [-l | -U | -D] -stype server_type [-dp disk_pool_name [-dvlist file]] [-M master_server] [-EMM emm_server]

nbdevquery -listglobals

nbdevquery -listmediaid id [id...] [ [-l | -U] [-EMM emm_server]

nbdevquery -listmounts [-l | -U] [-stype server_type] [-dp disk_pool_name] [-M master_server] [-EMM emm_server]

nbdevquery -listreptargets -stunit label[-U] [[-include Primary | ReplicationSource | Mirror]...] [[-exclude Primary | ReplicationSource | Mirror]...]

nbdevquery -liststs [-l | -U] [-stype server_type] [-storage_server storage_server] [-EMM emm_server]

nbdevquery -liststsprefmedia [-l | -U] -storage_server storage_server -stype server_type -sts_operation sts_operation

 

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 nbdevquery command line utility is the disk equivalent of bpmedialist for tape. The following are the operations that nbdevquery performs:

  • -listdp lists all disk pools in the system.

  • -liststs lists all storage servers in the system.

  • -listdv displays status for disk volumes of imported disk pools. It includes such things as whether the volume is online or offline and the number of current readers (or writers) to the volume.

    When you use the -listdv command with the -D option, nbdevquery returns a large set of data including the following values that NetBackup uses to determine the available free space within the disk pool:

    total_capacity : xxxxxxx-- The total size of the disk as derived from the file system.

    free_space : xxxxxxx-- The amount of free space on the disk as derived from the file system.

    potential_free_space : xxxxxxx-- The total size of all fragments on the disk that have been duplicated as part of a storage lifecycle policy and are eligible for expiration. The potential_free_space value is computed after duplication and expiration sessions. This information is applicable only when capacity managed retention is used for a storage destination.

    committed_space : xxxxxxx-- The amount of data that NetBackup estimates as being written to the disk, based on all in-progress backups.

    precommitted_space : xxxxxxx-- A helper value for committed_space. This value is decreased as a backup job proceeds and the total_capacity and free_space information is updated.

    NetBackup uses free_space, potential_free_space, and committed_space to determine how much space is available on a disk. It uses the following formula:

    available space = free_space + potential_free_space - committed_space

  • -listmediaid lists all disk volumes that have been given a disk media ID.

  • -listmounts lists the disk mount points for the disk pool.

  • -listconfig lists storage server configuration details.

  • -listglobals lists all global disk attributes.

  • -listreptargets lists valid replication target storage units or groups for a specified source storage unit or storage unit group. You can list the set of storage units to configure as targets for storage lifecycle policy replication operations.

  • -liststsprefmedia lists the preferred media servers that are used for storage server operation. When you use the option with the -U option, it also lists the priority of the media server. Additionally, it indicates if media server belongs to the include list or the exclude list. Valid operation values include: CapacityPolling.

OPTIONS

-D

Sets the list type to dump debug data. This option dumps information without further processing. The output format and displayed fields are subject to change without notification.

-dp disk_pool_name

Specifies the name of the disk pool to be queried. This pool is the data storage area for this storage unit.

-dv disk_volume

Displays the status for only the specified disk volume. For BasicDisk, the input value is the path. In all other cases, the input value is the volume name.

-dvlist filename

Specifies the file that contains the volume information.

-include | -exclude [ Primary | ReplicationSource | Mirror ]...

Includes or filters out targets if multiple choices exist.

-l

Sets the list type to short output. This option produces parsable output with all fields on one line, no headers. The first field indicates the version of the output as an aid to the script operation. Date and time values appear in UNIX long format; status values appear in integer form.

-listconfig

Lists the storage server configuration details.

-listdp

Lists all imported disk pools in the NetBackup database. For an OpenStorage disk, -listdp lists all the disk pools that have been configured.

Note:

The following properties do not apply to cloud storage disk pools: Raw Size, Usable Size, High Watermark, and Low Watermark.

You can view the disk pool properties by using the -U option of the listdp command.

-listdv

Lists the status for all disk volumes of imported disk pools and returns a list of all disk volumes in the NetBackup database. See Example 3.

-listglobals

Lists all NetBackup Disk Service Manager global disk attributes. If SPR is enabled, the SCSI Persistent Reservation setting is set to one (1). If LUN masking is enabled, the output shows zero (0) rather than 1.

-listmediaid id...

Lists all disk volumes that have been given the specified disk media IDs.

-listmounts

Lists the disk mount points for the disk pool.

-listreptargets

Lists valid replication target storage units or groups for a source storage unit or storage unit group.

-liststs

Lists all servers that host storage. These include Veritas provided storage such as Media Server Deduplication Pool, third-party appliances, and cloud storage.

-storage_server storage_server

The host name of the storage server. The name was given to the storage server when it was created.

-sts_operation operation

Specifies the storage server operation for which usable media server list is fetched. If CapacityPolling is specified, that indicates the preferred media server can only be specified for disk volume capacity polling.

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

-U

Lists the configuration information about the specified disk pool, storage server, or disk storage (see Example 1). Some of the items cannot be changed.

EXAMPLES

Example 1 - List in user format the configuration information about all servers that host storage in the system.

# nbdevquery -liststs -stype Network_NTAP -U 
Storage Server      : plinko 
Storage Server Type : Network_NTAP 
Storage Type        : Formatted Disk, Direct Attached 
State               : UP 
Flag                : OpenStorage 
Flag                : AdminUp 
Flag                : InternalUp 
Flag                : LifeCycle 
Flag                : CapacityMgmt 
Flag                : FragmentImages 
Flag                : Cpr 
Flag                : RandomWrites 
Flag                : FT-Transfer
Flag                : PrimaryEnabled
Flag                : SnapShotEnabled
Flag                : MirrorEnabled
Flag                : WORM

Example 2 - View all disk pool information for djs_bp in user format. Volume SnapVaultB is a valid source volume for replication because it is a replication source and it has a target parameter, ntapdfm:SnapMirrorA1.

nbdevquery -listdp -stype DjsArray -U
Disk Pool Name      : djs_bp
Disk Type           : DjsArray
Disk Volume Name    : SnapVaultB
Disk Media ID       : @aaaa
Total Capacity (GB) : 68.21
Free Space (GB)     : 55.93
Use%                : 88
Status              : UP
Flag                : ReadOnWrite
Flag                : AdminUp
Flag                : InternalUp
Flag                : ReplicationSource
Flag                : ReplicationTarget
Flag                : Primary
Flag                : Snapshot
Flag                : WORMCapable
Num Repl Sources    : 1
Num Repl Targets    : 1
Replication Source  : ntapdfm:@aaaa@:PrimarySnapshot
Replication Target  : ntapdfm:SnapMirrorA1

Example 3 - Do a disk drive dump of the disk pool sim_dp1 that PureDisk uses.

# nbdevquery -listdp -dp sim_dp1 -stype PureDisk -D
Disk Drive Dump
  name                : <sim_dg1>
  id                  : <sim_dg1>
  server_type         : <PureDisk>
  master_server       : <daloa.example.com>
  access_media_server : <>
  disk_storage_type   : 6
  total_capacity      : 1286602752
  used_space          : 0
  sts_state           : 0
  availability        : 2
  connectivity        : 0
  high_watermark      : 98
  low_watermark       : 80
  num_diskvolumes     : 3
  num_disks           : 0

  num_stservers       : 2
  system_tag          : <Imported from STS>
  user_tag            : <>
Storage Server [0]
  name : <daloa.example.com>
  id                  : <>
  server_type         : <PureDisk>
  storage_type        : 6
  access_media_serv.: <>
Storage Server [1]
  name              : <blackjack.example.com>
  id                : <>
  server_type       : <PureDisk>
  storage_type      : 6
  access_media_serv.: <>

SEE ALSO

See nbemmcmd.

See nbdevconfig.