NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.1.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.  
      bpcleanrestore
    22.  
      bpclient
    23.  
      bpclimagelist
    24.  
      bpclntcmd
    25.  
      bpclusterutil
    26.  
      bpcompatd
    27.  
      bpconfig
    28.  
      bpdbjobs
    29.  
      bpdbm
    30.  
      bpdgclone
    31.  
      bpdown
    32.  
      bpduplicate
    33.  
      bperror
    34.  
      bpexpdate
    35.  
      bpfis
    36.  
      bpflist
    37.  
      bpgetconfig
    38.  
      bpgetdebuglog
    39.  
      bpimage
    40.  
      bpimagelist
    41.  
      bpimmedia
    42.  
      bpimport
    43.  
      bpinst
    44.  
      bpkeyfile
    45.  
      bpkeyutil
    46.  
      bplabel
    47.  
      bplist
    48.  
      bpmedia
    49.  
      bpmedialist
    50.  
      bpminlicense
    51.  
      bpnbat
    52.  
      bpnbaz
    53.  
      bppficorr
    54.  
      bpplcatdrinfo
    55.  
      bpplclients
    56.  
      bppldelete
    57.  
      bpplinclude
    58.  
      bpplinfo
    59.  
      bppllist
    60.  
      bpplsched
    61.  
      bpplschedrep
    62.  
      bpplschedwin
    63.  
      bppolicynew
    64.  
      bpps
    65.  
      bprd
    66.  
      bprecover
    67.  
      bprestore
    68.  
      bpretlevel
    69.  
      bpschedule
    70.  
      bpschedulerep
    71.  
      bpsetconfig
    72.  
      bpstsinfo
    73.  
      bpstuadd
    74.  
      bpstudel
    75.  
      bpstulist
    76.  
      bpsturep
    77.  
      bptestbpcd
    78.  
      bptestnetconn
    79.  
      bptpcinfo
    80.  
      bpup
    81.  
      bpverify
    82.  
      cat_convert
    83.  
      cat_export
    84.  
      cat_import
    85.  
      configureCerts
    86.  
      configureMQ
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig reinitialize
    93.  
      csconfig throttle
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      mklogdir
    100.  
      msdpcldutil
    101.  
      nbauditreport
    102.  
      nbcallhomeproxyconfig
    103.  
      nbcatsync
    104.  
      NBCC
    105.  
      NBCCR
    106.  
      nbcertcmd
    107.  
      nbcertupdater
    108.  
      nbcldutil
    109.  
      nbcloudrestore
    110.  
      nbcomponentupdate
    111.  
      nbcplogs
    112.  
      nbcredkeyutil
    113.  
      nbdb_admin
    114.  
      nbdb_backup
    115.  
      nbdb_move
    116.  
      nbdb_ping
    117.  
      nbdb_restore
    118.  
      nbdb_unload
    119.  
      nbdb2adutl
    120.  
      nbdbms_start_server
    121.  
      nbdbms_start_stop
    122.  
      nbdc
    123.  
      nbdecommission
    124.  
      nbdelete
    125.  
      nbdeployutil
    126.  
      nbdevconfig
    127.  
      nbdevquery
    128.  
      nbdiscover
    129.  
      nbdna
    130.  
      nbemm
    131.  
      nbemmcmd
    132.  
      nbfindfile
    133.  
      nbfirescan
    134.  
      nbfp
    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.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbserviceusercmd
    164.  
      nbsetconfig
    165.  
      nbsmartdiag
    166.  
      nbsnapimport
    167.  
      nbsnapreplicate
    168.  
      nbsqladm
    169.  
      nbstl
    170.  
      nbstlutil
    171.  
      nbstop
    172.  
      nbsu
    173.  
      nbsvrgrp
    174.  
      netbackup_deployment_insights
    175.  
      resilient_clients
    176.  
      restoretrace
    177.  
      stopltid
    178.  
      tldd
    179.  
      tldcd
    180.  
      tpautoconf
    181.  
      tpclean
    182.  
      tpconfig
    183.  
      tpext
    184.  
      tpreq
    185.  
      tpunmount
    186.  
      verifytrace
    187.  
      vltadm
    188.  
      vltcontainers
    189.  
      vlteject
    190.  
      vltinject
    191.  
      vltoffsitemedia
    192.  
      vltopmenu
    193.  
      vltrun
    194.  
      vmadd
    195.  
      vmchange
    196.  
      vmcheckxxx
    197.  
      vmd
    198.  
      vmdelete
    199.  
      vmoprcmd
    200.  
      vmphyinv
    201.  
      vmpool
    202.  
      vmquery
    203.  
      vmrule
    204.  
      vmupdate
    205.  
      vnetd
    206.  
      vssat
    207.  
      vwcp_manage
    208.  
      vxlogcfg
    209.  
      vxlogmgr
    210.  
      vxlogview
    211.  
      W2KOption

Name

vmquery — query EMM database, or assign and unassign volumes

SYNOPSIS

vmquery [-h EMM_server | volume_database_host, ... -h EMM_server | -h volume_database_host, ... -h volume_database_host] [-vltcid vault_container_id] [-b | -w | -W | l] -a | -m media_id | -v volume_group | -rn robot_number | -rt robot_type | -mt media_type | -p pool_number | -pn pool_name | -res robot_type robot_number robot_control_host robot_coord1 robot_coord2 | -assignbyid media_id media_type pool_number stat asg_time | -deassignbyid media_id pool_number stat

 

On UNIX systems, the directory path to this command is /usr/openv/volmgr/bin/

On Windows systems, the directory path to this command is install_path\Volmgr\bin\

DESCRIPTION

Query the EMM database for volume information. The -h, -b, -W, and -w options are not required, but you must choose one and only one of the other (twelve) options.

The -b or -w option can be used with any of the other 11 options, but the -b or -w options cannot be specified together.

Any authorized user can run this command.

For more information about NetBackup authorization, refer to the NetBackup Security and Encryption Guide.

OPTIONS

-h EMM_Server | volume_database_host

This option is only applicable for NetBackup Enterprise Server.

The name of the Enterprise Media Manager database host that contains information about volumes. If no host is specified, the configured EMM server is used by default.

-b

Specifies the brief output format for volume information. This option can be used with any of the other 11 options.

-w

Specifies the wide output format for volume information. This option includes any additional information that the -b option does not show and can be used with any of the other 11 options.

-a

Shows all volumes.

-m media_id

Queries the volumes by media ID. The media ID is a maximum of 6 ASCII characters.

-v volume_group

Queries the volumes by volume group. A volume group is a logical grouping that identifies a set of volumes that reside at the same physical location.

-rn robot_number

Queries the volumes by robot number. A robot number is a unique, logical identification number for the robot where the volume is located.

-rt robot_type

Queries the volumes by the type of robot where the volume is located.

Valid robot types for NetBackup Enterprise Server follow:

none, acs, tld.

Valid robot types for NetBackup Server follow:

none, tld.

-mt media_type

Queries the volumes by media type.

Valid media types for NetBackup Enterprise Server follow:

4mm, 8mm, 8mm2, 8mm3, dlt, dlt2, dlt3, dtf, hcart, hcart2, hcart3, qcart, 4mm_clean, 8mm_clean, 8mm2_clean, 8mm3_clean, dlt_clean, dlt2_clean, dlt3_clean, dtf_clean, hcart_clean, hcart2_clean, hcart3_clean.

Valid media types for NetBackup Server follow:

4mm, 8mm, dlt, hcart, qcart, 4mm_clean, 8mm_clean, dlt_clean, hcart_clean.

-p pool_number

Queries the volumes by pool number. Pool number is an index into the volume pool. You can use vmpool -listall to determine the index for a given pool name.

-pn pool_name

Queries the volumes by pool name.

-res robot_type robot_number robot_host rob_slot

Queries the volumes by residence.

robot_host

Specifies the host that controls the robot where the volume is located.

rob_slot

Specifies the slot number in the robot (robot coordinate 1) where the volume resides.

-assignbyid media_id media_type pool_number stat asg_time

Assigns the volume by media ID, pool, and status. This option can only assign non-NetBackup media. Non-NetBackup media include the media that the following use: Veritas Storage Migrator, Veritas Data Lifecycle Manager, or by the users that work outside of the NetBackup policy framework (for example, those using tpreq directly).

The -assignbyid option cannot be used with media of status (stat) 0 (regular NetBackup tapes) or 1 (NetBackup catalog tapes).

stat

Status applies only to volumes that are assigned to NetBackup or Storage Migrator. Possible stat values are:

0 - the volume is assigned to NetBackup regular backups.

1 - Volume is assigned to NetBackup catalog backups.

2 - Volume is assigned to Storage Migrator.

asg_time

This option applies only to volumes that are assigned to NetBackup or Storage Migrator.

Specifies the time when the volume was assigned. It is the number of seconds since 00:00:00 UTC, January 1, 1970. asg_time was originally created by using the time() call.

-deassignbyid media_id pool_number stat

Unassigns the volume by media ID, pool, and status. This option can only deassign non-NetBackup media. Non-NetBackup media includes the media that the following use: Veritas Storage Migrator, Veritas Data Lifecycle Manager, or the users that work outside of the NetBackup policy framework (for example, those using tpreq directly). To deassign NetBackup tapes, use the bpexpdate command.

The -deassignbyid option cannot be used with media of status (stat) 0 (regular NetBackup tapes) or 1 (NetBackup catalog tapes).

-vltcid vault_container_id

Lists the volumes that are stored in the container. The vault_container_id variable can be a string of up to 29 alphanumeric characters.

-W

Specifies the parsable output format for volume information.

The output data lines are space separated fields except in the following conditions:

  • The MediaID field is padded to six characters by adding spaces to the end of the string.

  • The MediaType field is padded to eight characters by adding spaces to the end of the string.

  • The MediaDescription field may contain spaces within the field.

  • For Vault containers, the output includes the length of the container description (DescriptionLength), the container description, and the container ID. The output header line is a space-separated line of column labels.

NOTES

Only limited validation of the option parameters is done.

EXAMPLES

Example 1 - List all volume information, in brief format from the EMM database on the host that is named llama:

# vmquery -h llama -b -a

Example 2 - Assign volume A23456, which is in pool 1 (NetBackup). It sets the status to 0 and the assign time to 12/31/98 15:50:22:

# vmquery -assignbyid A23456 8mm 1 0 915141022

Example 3 - Unassign volume A23456, which is in pool 2 (Storage Migrator), with a status of 0:

# vmquery -deassignbyid A23456 0

SEE ALSO

See vmadd.

See vmchange.

See vmdelete.

See vmpool.