Veritas NetBackup™ Commands Reference Guide

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

Valid robot types for NetBackup Server follow:

none, tl4, tl8, 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.