Veritas NetBackup™ Commands Reference Guide
- Introduction
- Appendix A. NetBackup Commands
- acsd
- add_media_server_on_clients
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- 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
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bptpcinfo
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configurePorts
- create_nbdb
- csconfig
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- nbauditreport
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcomponentupdate
- nbcplogs
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_restore
- nbdb_unload
- nbdbms_start_server
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbexecute
- nbfindfile
- nbfirescan
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhypervtool
- nbjm
- nbkmsutil
- nboraadm
- nbpem
- nbpemreq
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbregopsc
- nbreplicate
- nbrestorevm
- nbseccmd
- nbsetconfig
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbstl
- nbstlutil
- nbsu
- nbsvrgrp
- resilient_clients
- restoretrace
- stopltid
- tl4d
- tl8d
- tl8cd
- tldd
- tldcd
- tlhd
- tlhcd
- tlmd
- 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
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Name
vmrule — manage barcode rules
SYNOPSIS
[-h EMM_server | volume_database_host] -listall [-b] | -add barcode_tag media_type pool_name max_mounts "description" | -change barcode_tag media_type pool_name max_mounts "description" | -delete barcode_tag
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
Use vmrule to add, change, delete, or list barcode rules. The -h option is not required, but you must choose one and only one of the other four options.
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 the volumes in a robot. If no host is specified, the configured EMM server is used by default.
- -listall [-b]
Lists the information about all barcode rules. You can use the -b option to specify a brief format for the barcode rule information that is displayed.
The following describes the fields that are included in the output of a vmrule -list_all [-b] command:
Field 1 = Barcode tag of the media
Field 2 = Media type
Field 3 = Volume pool for the media
Field 4 = max mounts / cleanings. The maximum mounts or cleanings for the media.
Field 5 = Rule description
- -add barcode_tag media_type pool_name max_mounts "description"
Adds a new barcode rule.
- -change barcode_tag media_type pool_name max_mounts "description"
Changes a barcode rule.
- -delete barcode_tag
Deletes a barcode rule.
- barcode_tag
Specifies the barcode prefix that activates the barcode rule.
- media_type
Specifies the media type of the volume, a barcode rule attribute. This option affects whether the rule is used. It also affects the media type for the volumes that are added by using a robot inventory update.
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.
- pool_name
Specifies the pool to which the volumes are added.
- max_mounts
Specifies the maximum number of mounts that are allowed for this volume (when the volume is added). This option is used only for non-cleaning media. When this limit is exceeded, the volume can only be mounted for read operations.
Note:
Numbers larger than 99999 are stored in the database, but vmrule displays the max_mounts as 0 if the value is larger than 99999. A value of zero means that the number of mounts is unlimited.
- "description"
Description of the barcode rule. The double quote marks are required if the description contains any spaces.
NOTES
Only limited validation of the option parameters is done.
EXAMPLES
Example 1 - Create a rule that defines any tape with a barcode that starts with ABC is a DLT tape in the NetBackup pool. The tape can be mounted up to 100 times for writes and is given a description.
vmrule -add ABC dlt NetBackup 100 "DLT cleaning tape"
Example 2 - List all barcode rule information.
# vmrule -list_all [-b] ABC,DLT,NetBackup,100,DataStore DLT Rule EFG,DLT,DataStore,0,DataStore DLT Rule
The barcode tags are ABC and EFG. The media type is DLT. The volume pools are NetBackup and DataStore. The max mounts or cleanings are 100 and 0. The rule description is DataStore DLT rule.
SEE ALSO
See vmupdate.