NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdb2adutl
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nblogparser
- nbmariadb
- nbmysql
- nbmlb
- nboraadm
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbpgsql
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbsqlcmd
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
vmquery — query EMM database, or assign and unassign volumes
SYNOPSIS
[-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:
dlt, dlt2, dlt3, hcart, hcart2, hcart3, dlt_clean, dlt2_clean, dlt3_clean, hcart_clean, hcart2_clean, hcart3_clean.
Valid media types for NetBackup Server follow:
dlt, hcart, 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 08/14/23 15:50:22:
# vmquery -assignbyid A23456 hcart 1 0 1692028222
Example 3 - Unassign volume A23456, which is in pool 2 (Storage Migrator), with a status of 0:
# vmquery -deassignbyid A23456 0