NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  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.  
      backupdbtrace
    3.  
      backuptrace
    4.  
      bmrc
    5.  
      bmrconfig
    6.  
      bmrepadm
    7.  
      bmrprep
    8.  
      bmrs
    9.  
      bmrsrtadm
    10.  
      bp
    11.  
      bparchive
    12.  
      bpbackup
    13.  
      bpbackupdb
    14.  
      bpcatarc
    15.  
      bpcatlist
    16.  
      bpcatres
    17.  
      bpcatrm
    18.  
      bpcd
    19.  
      bpchangeprimary
    20.  
      bpcleanrestore
    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.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configureCerts
    84.  
      configureMQ
    85.  
      configureWebServerCerts
    86.  
      create_nbdb
    87.  
      csconfig cldinstance
    88.  
      csconfig cldprovider
    89.  
      csconfig meter
    90.  
      csconfig reinitialize
    91.  
      csconfig throttle
    92.  
      duplicatetrace
    93.  
      importtrace
    94.  
      jbpSA
    95.  
      jnbSA
    96.  
      ltid
    97.  
      mklogdir
    98.  
      msdpcldutil
    99.  
      nbauditreport
    100.  
      nbcallhomeproxyconfig
    101.  
      nbcatsync
    102.  
      NBCC
    103.  
      NBCCR
    104.  
      nbcertcmd
    105.  
      nbcertupdater
    106.  
      nbcldutil
    107.  
      nbcmdrun
    108.  
      nbcomponentupdate
    109.  
      nbcplogs
    110.  
      nbcredkeyutil
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdb2adutl
    118.  
      nbdbms_start_server
    119.  
      nbdbms_start_stop
    120.  
      nbdc
    121.  
      nbdecommission
    122.  
      nbdelete
    123.  
      nbdeployutil
    124.  
      nbdevconfig
    125.  
      nbdevquery
    126.  
      nbdiscover
    127.  
      nbdna
    128.  
      nbemm
    129.  
      nbemmcmd
    130.  
      nbepicfile
    131.  
      nbfindfile
    132.  
      nbfirescan
    133.  
      nbfp
    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.  
      nboracmd
    152.  
      nbpem
    153.  
      nbpemreq
    154.  
      nbmariadb
    155.  
      nbmlb
    156.  
      nbperfchk
    157.  
      nbplupgrade
    158.  
      nbrb
    159.  
      nbrbutil
    160.  
      nbreplicate
    161.  
      nbrepo
    162.  
      nbrestorevm
    163.  
      nbseccmd
    164.  
      nbserviceusercmd
    165.  
      nbsetconfig
    166.  
      nbshvault
    167.  
      nbsmartdiag
    168.  
      nbsnapimport
    169.  
      nbsnapreplicate
    170.  
      nbsqladm
    171.  
      nbsqlite
    172.  
      nbstl
    173.  
      nbstlutil
    174.  
      nbstop
    175.  
      nbsu
    176.  
      nbsvrgrp
    177.  
      netbackup_deployment_insights
    178.  
      resilient_clients
    179.  
      restoretrace
    180.  
      stopltid
    181.  
      tldd
    182.  
      tldcd
    183.  
      tpautoconf
    184.  
      tpclean
    185.  
      tpconfig
    186.  
      tpext
    187.  
      tpreq
    188.  
      tpunmount
    189.  
      verifytrace
    190.  
      vltadm
    191.  
      vltcontainers
    192.  
      vlteject
    193.  
      vltinject
    194.  
      vltoffsitemedia
    195.  
      vltopmenu
    196.  
      vltrun
    197.  
      vmadd
    198.  
      vmchange
    199.  
      vmcheckxxx
    200.  
      vmd
    201.  
      vmdelete
    202.  
      vmoprcmd
    203.  
      vmphyinv
    204.  
      vmpool
    205.  
      vmquery
    206.  
      vmrule
    207.  
      vmupdate
    208.  
      vnetd
    209.  
      vssat
    210.  
      vwcp_manage
    211.  
      vxlogcfg
    212.  
      vxlogmgr
    213.  
      vxlogview
    214.  
      W2KOption

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}