Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  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.  
      configureCerts
    85.  
      configureCertsForPlugins
    86.  
      configureMQ
    87.  
      configurePorts
    88.  
      configureWebServerCerts
    89.  
      create_nbdb
    90.  
      csconfig cldinstance
    91.  
      csconfig cldprovider
    92.  
      csconfig meter
    93.  
      csconfig reinitialize
    94.  
      csconfig throttle
    95.  
      duplicatetrace
    96.  
      importtrace
    97.  
      jbpSA
    98.  
      jnbSA
    99.  
      ltid
    100.  
      manageClientCerts
    101.  
      mklogdir
    102.  
      nbauditreport
    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.  
      nbftadm
    135.  
      nbftconfig
    136.  
      nbgetconfig
    137.  
      nbhba
    138.  
      nbholdutil
    139.  
      nbhostidentity
    140.  
      nbhostmgmt
    141.  
      nbhypervtool
    142.  
      nbidpcmd
    143.  
      nbimageshare
    144.  
      nbinstallcmd
    145.  
      nbjm
    146.  
      nbkmiputil
    147.  
      nbkmscmd
    148.  
      nbkmsutil
    149.  
      nboraadm
    150.  
      nborair
    151.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

vmchange — change media information in EMM database

SYNOPSIS

vmchange [-h EMM_server | volume_database_host] -vg_res -rt robot_type -rn robot_number -rh robot_control_host -v volume_group

vmchange [-h EMM_server | volume_database_host] -res -m media_id -mt media_type -rt robot_type -rn robot_number -rh robot_control_host -v volume_group -rc1 rob_slot

vmchange [-h EMM_server | volume_database_host] -exp date -m media_id

vmchange [-h EMM_server | volume_database_host] -barcode barcode -m media_id [-rt robot_type]

vmchange [-h EMM_server | volume_database_host] -m media_id -vltcid vault_container_id

vmchange [-h EMM_server | volume_database_host] -barcode barcode -vltcid vault_container_id

vmchange [-h EMM_server | volume_database_host] -d "media_description" -m media_id

vmchange [-h EMM_server | volume_database_host] -p pool_number -m media_id

vmchange [-h EMM_server | volume_database_host] -maxmounts max_mounts -m media_id

vmchange [-h EMM_server | volume_database_host] -clean cleanings left -m media_id

vmchange [-h EMM_server | volume_database_host] -n num_mounts -m media_id

vmchange [-h EMM_server | volume_database_host] -new_mt media_type -m media_id

vmchange [-h EMM_server | volume_database_host] -new_rt robot_type -m media_id -rn robot_number

vmchange [-h EMM_server | volume_database_host] -new_v volume_group [-m media_id |{-b barcode -mt media_type -rt robot_type}]

vmchange [-h EMM_server | volume_database_host] -vltname vault_name -m media_id

vmchange [-h EMM_server | volume_database_host] -vltsent date -m media_id

vmchange [-h EMM_server | volume_database_host] -vltreturn date -m media_id

vmchange [-h EMM_server | volume_database_host] -vltslot vault_slot -m media_id

vmchange [-h EMM_server | volume_database_host] -vltsession vault_session_id -m media_id

vmchange -api_eject -map map_id:mapid:...:mapid | any -w [-h EMM_server | volume_database_host] -res -ml media_id:media_id: ...:media_id -rt robot_type -rn robot_number -rh robot_control_host [-v volume_group]

vmchange -multi_eject -w [-h EMM_server | volume_database_host] -res -ml media_id:media_id: ...:media_id -rt robot_type -verbose -rn robot_number -rh robot_control_host

vmchange -multi_inject -w [-h EMM_server | volume_database_host] -res -rt robot_type -verbose -rn robot_number -rh robot_control_host

vmchange [-h EMM_server | volume_database_host] -res -robot_info -verbose -rn robot_number -rt robot_type -rh robot_control_host

 

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

Change volume information in the Enterprise Media Manager database.

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.

-vg_res

Change volume group residence.

-rt robot_type

Specifies the robot type of the 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

-rn robot_number

Unique, logical identification number for the robot where the volume is located.

-rh robot_control_host

Name of the host that controls the robot, where the volume is located.

-v volume_group

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

-res

Changes the volume's residence.

-m media_id

Specifies the media ID of the volume to change.

-mt media_type

Specifies the media type of the volume to change.

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

-rc1 rob_slot

Robot coordinate 1 is the robot slot number where the volume is located.

The following applies only to NetBackup Enterprise Server:

Do not enter slot information for API robot types. The robot software tracks the slot locations for these robots.

-exp date

Expiration date for this volume.

The required date and time values format in NetBackup commands varies according to your locale. The /usr/openv/msg/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.

See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.

-barcode barcode

Specifies the barcode that is attached to the volume.

-d "media_description"

Media description for the volume. The double quote marks are required if the description contains any spaces.

-p pool_number

Index of the volume pool that contains this volume. You can get the pool index using vmpool -listall.

-maxmounts max_mounts

Maximum number of mounts that are allowed for this volume. Only used for non-cleaning media.

-n num_mounts

For non-cleaning media, num_mounts is the number of times this volume has been mounted.

-clean cleanings_left

For cleaning media, cleanings_left is the number of cleanings that remain for this cleaning tape.

-new_mt media_type

Specifies the media type of the volume to change. See the -mt option for a list of media types.

-new_rt robot_type

Specifies the robot type. See the -rt option for a list of robot types.

-new_v volume_group

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

-b barcode

Specifies the barcode that is attached to the volume.

-vltcid vault_container_id

Changes the container in which a volume is stored. vault_container_id (a string of up to 29 alphanumeric characters) specifies the new container for the volume. Use the -m or -barcode option to specify the volume.

-vltname vault_name

Specifies the name of the logical vault that is configured for the robot that ejected the volume.

-vltsent date

Specifies the date the volume was sent off site.

The format of date depends on the user's locale setting. For the C locale, the date syntax is as follows:

mm/dd/yyyy [hh[:mm[:ss]]]

-vltreturn date

Specifies the date the volume was requested for return from the vault vendor. For catalog backup volumes, this date is the date that the volume is requested for return from the vault vendor.

The required date and time values format in NetBackup commands varies according to your locale. The /usr/openv/msg/.conf file (UNIX) and the install_path\VERITAS\msg\LC.CONF file (Windows) contain information such as the date-time formats for each supported locale. The files contain specific instructions on how to add or modify the list of supported locales and formats.

See the "About specifying the locale of the NetBackup installation" topic in the NetBackup Administrator's Guide, Volume II for more information.

-vltslot vault_slot

Specifies the vault vendor's slot number for the slot that this volume occupies.

-vltsession vault_session_id

Specifies the ID of the vault session that ejected this media.

-api_eject

Eject ACS volumes from the specified robot. The ejection timeout period is one week.

-map map_id:mapid: ...:mapid | any

For ACS robots, this option can specify multiple media access ports (MAPs) to use for eject operations. The map_id (also known as the CAP ID) can be all or ALL, which specifies all MAPs in the robot. Or it can be a colon-separated list of MAP IDs in the format of ACS,LSM,CAP. When the -map option is used, media are ejected to the MAPs that are specified by using a nearest MAP algorithm. The algorithm assumes that the LSMs are connected in a line.

-w

Wait flag. This flag must be used with the eject, multiple eject, and multiple inject commands.

-verbose

Selects the verbose mode.

-ml media_id:media_id: ...:media_id

Specifies a list of media to be ejected from the robot.

-multi_eject

Uses the robotic library's media access port to eject multiple volumes. This option is only valid for TLD robot types. The ejection timeout period is 30 minutes.

-multi_inject

Uses the robotic library's media access port to inject multiple volumes. This option is only valid for TLD robot types. The user must run the vmupdate command after this operation to update the EMM database.

-robot_info

Retrieves the information about a robotic library. This option is only valid for TL8 robot types

  • Field 1 = Number of slots

  • Field 2 = Number of mail slots

  • Field 3 = Number of drives

  • Field 4 = Robot type and subtype (e.g., tld -> 0)

  • Field 5 = Barcode reader. If a barcode reader exists on this robotic device, this field contains the following string: This robot has a barcode reader.

  • Field 6 = Starting slot

  • Field 7 = Ending slot

  • Field 8 = Primary inquiry string (e.g., HP~~~~~~C6240-8000~~~~~~2912)

CAUTIONS

Some robotic libraries implement different functionality for their media access ports. For example, some libraries have the front-panel inject and the eject features that conflict with NetBackup's use of the media access port. (For example, Spectra Logic Bullfrog.) Other libraries require front-panel interaction when you use the media access port (for example, Spectra Logic Gator).

The media is returned to (injected into) the robot in the following situation: you use an eject option and the media is not removed and a timeout condition occurs. If this action occurs, inventory the robot and then eject the media that was returned to the robot.

Make sure that you read the operator manual for your robotic library to gain an understanding of its media access port functionality. Libraries such as those that are noted may not be fully compatible with NetBackup inject and eject features if not properly handled. Other libraries may not be compatible at all. In addition, NetBackup performs limited validation of these option parameters.

EXAMPLES

Example 1 - Change the expiration date of volume AJS100:

# vmchange -exp 12/31/12 23:59:59 -m AJS100

Example 2 - Change the pool (which contains volume AJS999) to pool 1 (the NetBackup pool):

# vmchange -p 1 -m AJS999

Example 3 - Eject volumes abc123 and abc124 from ACS robot number 700. The residences for these two volumes are changed to standalone.

# vmchange -res -api_eject -w -ml abc123:abc124 -rt acs -rn 700 -rh 
verbena -map 0,0,0

Example 4 - Change the container ID of volume ABC123:

# vmchange -vltcid Container001 -m ABC123

SEE ALSO

See vmadd.

See vmdelete.

See vmpool.

See vmquery.