Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.0)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig
    86.  
      duplicatetrace
    87.  
      importtrace
    88.  
      jbpSA
    89.  
      jnbSA
    90.  
      ltid
    91.  
      mklogdir
    92.  
      nbauditreport
    93.  
      nbcatsync
    94.  
      NBCC
    95.  
      NBCCR
    96.  
      nbcertcmd
    97.  
      nbcertupdater
    98.  
      nbcomponentupdate
    99.  
      nbcplogs
    100.  
      nbdb_admin
    101.  
      nbdb_backup
    102.  
      nbdb_move
    103.  
      nbdb_ping
    104.  
      nbdb_restore
    105.  
      nbdb_unload
    106.  
      nbdbms_start_server
    107.  
      nbdbms_start_stop
    108.  
      nbdc
    109.  
      nbdecommission
    110.  
      nbdelete
    111.  
      nbdeployutil
    112.  
      nbdevconfig
    113.  
      nbdevquery
    114.  
      nbdiscover
    115.  
      nbdna
    116.  
      nbemm
    117.  
      nbemmcmd
    118.  
      nbexecute
    119.  
      nbfindfile
    120.  
      nbfirescan
    121.  
      nbftadm
    122.  
      nbftconfig
    123.  
      nbgetconfig
    124.  
      nbhba
    125.  
      nbholdutil
    126.  
      nbhypervtool
    127.  
      nbjm
    128.  
      nbkmsutil
    129.  
      nboraadm
    130.  
      nbpem
    131.  
      nbpemreq
    132.  
      nbperfchk
    133.  
      nbplupgrade
    134.  
      nbrb
    135.  
      nbrbutil
    136.  
      nbregopsc
    137.  
      nbreplicate
    138.  
      nbrestorevm
    139.  
      nbseccmd
    140.  
      nbsetconfig
    141.  
      nbsnapimport
    142.  
      nbsnapreplicate
    143.  
      nbsqladm
    144.  
      nbstl
    145.  
      nbstlutil
    146.  
      nbsu
    147.  
      nbsvrgrp
    148.  
      resilient_clients
    149.  
      restoretrace
    150.  
      stopltid
    151.  
      tl4d
    152.  
      tl8d
    153.  
      tl8cd
    154.  
      tldd
    155.  
      tldcd
    156.  
      tlhd
    157.  
      tlhcd
    158.  
      tlmd
    159.  
      tpautoconf
    160.  
      tpclean
    161.  
      tpconfig
    162.  
      tpext
    163.  
      tpreq
    164.  
      tpunmount
    165.  
      verifytrace
    166.  
      vltadm
    167.  
      vltcontainers
    168.  
      vlteject
    169.  
      vltinject
    170.  
      vltoffsitemedia
    171.  
      vltopmenu
    172.  
      vltrun
    173.  
      vmadd
    174.  
      vmchange
    175.  
      vmcheckxxx
    176.  
      vmd
    177.  
      vmdelete
    178.  
      vmoprcmd
    179.  
      vmphyinv
    180.  
      vmpool
    181.  
      vmquery
    182.  
      vmrule
    183.  
      vmupdate
    184.  
      vnetd
    185.  
      vxlogcfg
    186.  
      vxlogmgr
    187.  
      vxlogview
    188.  
      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]

 

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.

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.

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

-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. Possible values are amazon, att, azure, and rackspace. 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

Example 2 - List all disk pools of type PureDisk (Media Server Deduplication Pool) in the system.

# nbdevquery -stype PureDisk -dp disk-pool-1 
V7.5 Disk-Pool-1 0 97456 97480 10 80 90 server1,server2,server3

Example 3 - 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
Num Repl Sources    : 1
Num Repl Targets    : 1
Replication Source  : ntapdfm:@aaaa@:PrimarySnapshot
Replication Target  : ntapdfm:SnapMirrorA1

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