NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.3.0.1, 10.3)
  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.  
      nbfindfile
    131.  
      nbfirescan
    132.  
      nbfp
    133.  
      nbftadm
    134.  
      nbftconfig
    135.  
      nbgetconfig
    136.  
      nbhba
    137.  
      nbholdutil
    138.  
      nbhostidentity
    139.  
      nbhostmgmt
    140.  
      nbhypervtool
    141.  
      nbidpcmd
    142.  
      nbimageshare
    143.  
      nbinstallcmd
    144.  
      nbjm
    145.  
      nbkmiputil
    146.  
      nbkmscmd
    147.  
      nbkmsutil
    148.  
      nboraadm
    149.  
      nborair
    150.  
      nbpem
    151.  
      nbpemreq
    152.  
      nbmariadb
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbreplicate
    159.  
      nbrepo
    160.  
      nbrestorevm
    161.  
      nbseccmd
    162.  
      nbserviceusercmd
    163.  
      nbsetconfig
    164.  
      nbshvault
    165.  
      nbsmartdiag
    166.  
      nbsnapimport
    167.  
      nbsnapreplicate
    168.  
      nbsqladm
    169.  
      nbsqlite
    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

Name

vmpool — manage volume pools

SYNOPSIS

vmpool [-h EMM_server | volume_database_host] -list_all [-b|-bx] | -list_scratch | -list_catalog_backup | -create -pn pool_name -description description [-mpf mpf_max] | -update -pn pool_name [-description description] [-reason "string"] [-mpf mpf_max] | -delete pool_name | -set_scratch pool_name | -unset_scratch pool_name | -set_catalog_backup pool_name | -unset_catalog_backup pool_name

 

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 this command to add, change, delete, or list volume pools.

The -h option is not required, but you must choose one and only one of the other seven options (for example, -list_scratch).

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 applies only to the NetBackup Enterprise Server.

Specifies 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.

-list_all [-b | -bx]

Lists the information about all volume pools. Use the -b or -bx option to specify a brief format for volume pool information.

-list_scratch

Lists all configured scratch pools and the pool index number.

-list_catalog_backup

Lists the volume pool to be used for catalog backup.

-create -pn pool_name -description description -mpf mpf_max

Adds a new volume pool. Optionally limits the number of partially full media to be used in this pool by using -mpf. The default value is zero (0), which indicates that the number of partially full media is unlimited.

The -description option describes the volume pool. Double quote marks are required if the description contains any spaces.

-update -pn pool_name [-description description] [-mpf mpf_max]

Changes an existing volume pool. Optionally limits the number of partially full media to be used in this pool by using -mpf. The default value is zero (0), which indicates that the number of partially full media is unlimited.

The -description option describes the volume pool. Double quote marks are required if the description contains any spaces.

-delete pool_name

Deletes a volume pool.

-reason "string"

Indicates the reason why you perform this command action. The reason text string that you enter is captured and appears in the audit report. Enclose this string with double quotes ("...") and do not exceed 512 characters. The string cannot begin with a dash character (-) nor contain a single quotation mark (').

-set_scratch pool_name

If pool_name is a previously defined volume pool, pool_name becomes the scratch pool, and its description is not changed. The NetBackup, Datastore, Catalog Backup, and None volume pools cannot be changed to scratch pools.

If pool_name is a new volume pool, a new pool is created with "Scratch Pool" as the description.

Only one scratch pool at a time can be defined.

-unset_scratch pool_name

Undefines pool_name as the scratch pool and defines it as a regular volume pool. The pool can be deleted by using vmpool -delete pool_name.

-set_catalog_backup pool_name

Specifies the volume pool to back up the NetBackup catalog. You can also create a dedicated catalog backup pool to be used for catalog policies. A dedicated catalog volume pool reduces the number of needed tapes during catalog restores since catalog backup media are not mixed with other backup media.

-unset_catalog_backup pool_name

Defines a volume pool that you do not want to use to back up the NetBackup catalog.

NOTES

Only limited validation of the option parameters is done.

A pool cannot be both a scratch pool and Catalog Backup pool.

The -add and -change options have been deprecated. They can still be used, but do not set the mpf value.

EXAMPLES

Example 1 - Add a new pool named MyPool on the host that is named llama. It has the default host, user ID, and group ID permissions:

vmpool -create -pn MyPool -description "description with spaces" 
-mpf 17

Example 2 - List all pools that are configured on the host where the command is executed:

vmpool -list_all -b