Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (9.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.  
      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.  
      nbcallhomeproxyconfig
    104.  
      nbcatsync
    105.  
      NBCC
    106.  
      NBCCR
    107.  
      nbcertcmd
    108.  
      nbcertupdater
    109.  
      nbcldutil
    110.  
      nbcloudrestore
    111.  
      nbcomponentupdate
    112.  
      nbcplogs
    113.  
      nbcredkeyutil
    114.  
      nbdb_admin
    115.  
      nbdb_backup
    116.  
      nbdb_move
    117.  
      nbdb_ping
    118.  
      nbdb_restore
    119.  
      nbdb_unload
    120.  
      nbdb2adutl
    121.  
      nbdbms_start_server
    122.  
      nbdbms_start_stop
    123.  
      nbdc
    124.  
      nbdecommission
    125.  
      nbdelete
    126.  
      nbdeployutil
    127.  
      nbdevconfig
    128.  
      nbdevquery
    129.  
      nbdiscover
    130.  
      nbdna
    131.  
      nbemm
    132.  
      nbemmcmd
    133.  
      nbfindfile
    134.  
      nbfirescan
    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.  
      nbregopsc
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbsmartdiag
    167.  
      nbsnapimport
    168.  
      nbsnapreplicate
    169.  
      nbsqladm
    170.  
      nbstl
    171.  
      nbstlutil
    172.  
      nbstop
    173.  
      nbsu
    174.  
      nbsvrgrp
    175.  
      netbackup_deployment_insights
    176.  
      resilient_clients
    177.  
      restoretrace
    178.  
      stopltid
    179.  
      tldd
    180.  
      tldcd
    181.  
      tpautoconf
    182.  
      tpclean
    183.  
      tpconfig
    184.  
      tpext
    185.  
      tpreq
    186.  
      tpunmount
    187.  
      verifytrace
    188.  
      vltadm
    189.  
      vltcontainers
    190.  
      vlteject
    191.  
      vltinject
    192.  
      vltoffsitemedia
    193.  
      vltopmenu
    194.  
      vltrun
    195.  
      vmadd
    196.  
      vmchange
    197.  
      vmcheckxxx
    198.  
      vmd
    199.  
      vmdelete
    200.  
      vmoprcmd
    201.  
      vmphyinv
    202.  
      vmpool
    203.  
      vmquery
    204.  
      vmrule
    205.  
      vmupdate
    206.  
      vnetd
    207.  
      vssat
    208.  
      vwcp_manage
    209.  
      vxlogcfg
    210.  
      vxlogmgr
    211.  
      vxlogview
    212.  
      W2KOption
  3.  
    Index

Name

vmoprcmd — perform operator functions on drives

SYNOPSIS

vmoprcmd -devmon [pr | ds | hs] [-h device_host] default_operation

vmoprcmd -dp [pr | ds | ad] [-h device_host]

vmoprcmd -down | -up | -upopr | -reset drive_index [-h device_host]

vmoprcmd -downbyname | -upbyname | -upoprbyname | -path drive_path] [-nh ndmp_hostname] [-h device_host]

vmoprcmd -resetbyname drive_name [-h device_host]

vmoprcmd -assign drive_index mount_request_id [-h device_host]

vmoprcmd -assignbyname drive_name mount_request_id [-h device_host]

vmoprcmd -deny | -resubmit mount_request_index [-h device_host]

vmoprcmd -comment drive_index ["comment"] [-h device_host]

vmoprcmd -commentbyname drive_name ["comment"] [-h device_host]

vmoprcmd -crawlreleasebyname drive_name [-h EMM_Server]

vmoprcmd [-activate_host | -deactivate_host] [-h device_host]

vmoprcmd -hoststatus [-h device_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

This command lets you perform operator functions on drives. The -h option is not required, but you must choose only one of the following other options.

Non NDMP Windows device paths appear as {p,b,t,l}: where p is the port, b is the bus, t is the target, and l is the LUN. When vmoprcmd is run by using the -path argument, specify the path in the {p,b,t,l} format.

Any authorized user can run this command.

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

OPTIONS

-assign drive_index mount_request_id

Assign a drive to a mount request.

-assignbyname drive_name mount_request_id

This option is similar to the -assign option, except the drive name specifies the drive instead of the drive index.

The following point applies only to NetBackup server:

The device host is the host where Media Manager is installed.

-comment drive_index ["comment"]

Add a comment for the drive. The quotes are required if your comment contains any spaces. If you do not specify comment, any existing comments for the drive are deleted.

-commentbyname drive_name ["comment"]

This option is similar to the -comment option, except the drive name specified the drive instead of drive index.

-crawlreleasebyname drive_name

This option is only applicable for NetBackup Enterprise Server.

This option forces all hosts (that are registered to use the drive) to issue a SCSI release command to the drive. Issue this option on the host that is the SSO device allocator (DA host) or use the -h option to specify the DA host.

Caution:

Use this option after a PEND status has been seen in Device Monitor. Do not use this option during backups.

-down | -up | -upopr | -reset drive_index

-down Sets the drive to the DOWN state, if it is not assigned.

-up Sets the drive to the UP position in Automatic Volume Recognition (AVR) mode. This mode is the normal mode for all drives.

-upopr Sets the drive to the UP position in Operator (OPR) mode. This mode is normally used only for security reasons. For a drive in a robot, OPR and AVR are treated identically while the robot daemon or process is running.

-reset Resets the specified drive. Also, it unloads the drive (if not assigned in the EMM database). You can use the unload capability to unload the media that is stuck in the drive.

-downbyname | -upbyname | -upoprbyname | -resetbyname drive_name

These options are similar to -down, -up, -upopr, and -reset respectively, except the drive name specifies the drive instead of the drive index.

-deny | -resubmit mount_request_id

-deny Denying a mount request returns an error message to the user.

-resubmit Resubmit a mount request. If a pending action message involves a robot, you must correct the problem and resubmit the request that caused the message.

-dp [pr | ds | ad]

If none of the following optional display parameters are specified, all information is displayed.

pr - Displays any pending requests.

ds - Displays the status of drives under control of Media Manager.

ad - Displays additional status of drives under control of Media Manager.

-devmon [pr | ds | hs] default_operation

The -devmon command lists all of the drive paths that are configured for a given drive name. If none of the following optional display parameters are specified, all information is displayed. Full device pathnames are displayed.

pr Displays any pending requests.

ds Displays the status of drives under control of Media Manager.

hs Displays additional status of drives under control of Media Manager.

-h EMM_Server | device host

Name of the Enterprise Media Manager database host where the drives are attached and configured. If no host option is specified, the device host where you run the command is default.

The device host is the host where the device is attached and configured.

-hoststatus

Displays the current status of the host. The following states can appear:

DEACTIVATED - This state prevents any new jobs from starting on this host.

ACTIVE - The media server is available to run any jobs.

ACTIVE-DISK - The media server is available to run jobs for disk storage units only.

ACTIVE-TAPE - The media server is available to run jobs for tape storage units only.

OFFLINE - The media server is not available to run jobs for either tape storage units or disk storage units. This state occurs because the media server is not active for tape or disk, or because the master server cannot communicate with the media server.

-nh ndmp_hostname

Specifies the host name of the NDMP server.

-activate_host

Makes the host available to run jobs.

-deactivate_host

Makes the host unavailable to run jobs.

-path drivepath

Specifies the system name for the drive. For example, /dev/rmt/0cbn.

-setpath drivepath drive_name ndmp_hostname

Specifies the system name and the drive name of the NDMP host.

NOTES

Only limited validation of the option parameters is done.

tpconfig -d, tpconfig -l, and vmoprcmd may truncate long drive names. Use tpconfig -dl to obtain the full drive name.

vmoprcmd may truncate drive names to 20 characters.

EXAMPLES

Example 1 - Set the drive, with a drive index of 0, to UP mode:

# vmoprcmd -up 0

Example 2 - Display the drive status of all drives:

# vmoprcmd -d ds

Example 3 - Display pending requests and the drive status of all drives on the device host named crab:

# vmoprcmd -h crab

Example 4 - Demonstrate how non-NDMP Windows device paths appear.

# vmoprcmd 

                           HOST STATUS
Host Name                                  Version   Host Status
=========================================  =======   ===========
hamex                                       600000      ACTIVE

                            PENDING REQUESTS
                                <NONE>
                              DRIVE STATUS

Drive Name           Label   Ready  RecMID  ExtMID  Wr.Enbl. Type
    Host                   DrivePath                         Status
===================================================================
IBM.ULTRIUM-TD2.001    No      No                     No     hcart2
    hamex                   {3,1,0,2}                         TLD
    hamex                   {3,1,1,2}                         TLD

IBM.ULTRIUM-TD1.004    No      No                     No     hcart
    hamex                   {3,1,0,7}                         TLD
    hamex                   {3,1,1,7}                         TLD

IBM.ULTRIUM-TD2.005    Yes     Yes    J945L2          Yes    hcart2
    hamex                   {3,1,2,1}                         TLD

IBM.ULTRIUM-TD2.006    No      No                     No     hcart2
    hamex                   {3,1,2,2}                         TLD

# vmoprcmd -downbyname IBM.ULTRIUM-TD1.004 -path {3,1,0,7}