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

bpgetconfig — get configuration information

SYNOPSIS

bpgetconfig -M [-x | -X | -d | -D] [config_item ...]

bpgetconfig [-u | -h] [-x | -X | -d | -D] [config_item ...]

bpgetconfig -g server [-L | -U | -l] [-c] [-A]

bpgetconfig -s server [-L | -U | -l] [-c] [-A]

 

bpgetconfig -i | -e filenameclient [policy [schedule]]

bpgetconfig -private_exld_list

 

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\

DESCRIPTION

bpgetconfig can be used as a stand-alone program or as a helper program for the backuptrace and the restoretrace commands to obtain configuration information. This command is available for all NetBackup server platforms. It displays the configuration information of a specified server in various formats.

bpgetconfig also retrieves general host information from a specified host server by using the -g or -s option.

You must have administrator privileges to run this command.

OPTIONS

-A

Displays all available system information. The -A option can be used only with the -g or -s option.

-c

Displays the ciphers, one per line, that are appended to the -g or -s option output. The -c option can be used only with the -g or -s option.

-D | -d

The -D option returns a listing of configuration entry names, the existing configuration values in brackets, and the default configuration values in parentheses. This operation can be performed locally or remotely. The remote machine with an identical version of NetBackup is installed. The -D and -d options may be combined with the -M, -h, and -u options.

The following is a portion of a full display of all configuration items:

...
REQUEST_DELIVERY_TIMEOUT         [300]              (300)
DISABLE_SCSI_RESERVE             [NO]               (NO)
Time_Overlap                     [60]               (60)
Buffer_Size                      [16]               (16)
Use_Archive_Bit                  [YES]              (YES)
Perform_Default_Search           [YES]              (YES)
Accumulate_Files                 [NO]               (NO)
...

The -d option functions like the -D option, except -d displays only the entries that are changed from the configuration defaults. The following is an example display:

...
PEM_VERBOSE                      [-1]                     (0)
JM_VERBOSE                       [-1]                     (0)
RB_VERBOSE                       [-1]                     (0)
CONNECT_OPTIONS                  [**configured**]         ()
Exclude                          [**configured**]         ()
Browser                          [host1.min.vrts.com]     ()
AUTHENTICATION_DOMAIN            [**not configured**]     ()
VXSS_NETWORK                     [**not configured**]     ()
PREFERRED_NETWORK                [**not configured**]     ()
...
-e filenameserver [class [schedule]]

Retrieves the exclude_list file from server and writes it to the location specified by filename. The policy and schedule qualifiers allow the exclude_list.policy file and the exclude_list.policy.schedule to be retrieved. The files in the exclude list are excluded from being backed up.

This option applies only to UNIX.

-g server

Selects the host server (server) for which the following general NetBackup information appears:

  • Master or Client

  • NetBackup Client Platform

  • NetBackup Client Protocol Level

  • Product Type

  • Version Name

  • Version number

  • Installed Path for NetBackup Bin

  • Installed OS for host server

The -g option is not supported for the MSDP server.

-h

Displays the default local host configuration.

-i filenameserver [class [schedule]]

Retrieves the include_list file from server and writes it to the location specified by filename. The class (policy) and schedule qualifiers allow the include_list.class file and the include_list.class.schedule to be retrieved. The files in the include list are the exceptions to the exclude list. They are therefore included in a backup operation.

This option applies only to UNIX.

-L

Displays a long, user-readable list. The -L option can be used only with the -g or -s option.

-l

Displays a compact, machine-readable list. The -l option can be used only with the -g or -s option.

-M host

Specifies the host whose configuration appears.

-private_exld_list

Lists all the directories and files that are excluded by default from a backup.

-s server

Selects the host server (server) for which bpgetconfig outputs the following field information:

  • Field 1 = Server type (master, media, or client)

  • Field 2 = OS type of the specified server

  • Field 3 = NetBackup client protocol level

  • Field 4 = NetBackup product type (e.g., NetBackup)

  • Field 5 = NetBackup version name (e.g., 8.0)

  • Field 6 = NetBackup version number (e.g., 800000)

  • Field 7 = Installation path to the NetBackup bin on the server

  • Field 8 = Installed OS for host server

The -s option is not supported for the MSDP server.

-t

Displays the tier information, one item per line, that is appended to the -s option output. The -t option can be used only with the -g or -s option.

-U

Displays a brief, user-readable list (default). The -U option can be used only with the -g or -s option.

-u

Displays the current user configuration.

-X

Lists all configuration items by default. The -x and -X options may be combined with the -M, -h, and -u options. The -x and -X options have no effect if one or more configuration items are specified on the command line.

If config_item is specified, it appears on the specified configuration items.

-x

Excludes the items not explicitly listed in the configuration.

EXAMPLES

Example 1 - Retrieve the VERSIONINFO option setting from the bp.conf file.

# bpgetconfig VERSIONINFO
VERSIONINFO = "SunOS" "5.9" "Unknown" "NetBackup" "8.0" 800000

Example 2 - Retrieve all available system information and display a long, user-readable list.

# bpgetconfig -s hagar -A -L
Client/Master = Master
NetBackup Client Platform = Solaris9
NetBackup Client Protocol Level = 8.0
Product = NetBackup
Version Name = 8.0
Version Number = 800000
NetBackup Installation Path = /usr/openv/netbackup/bin
Client OS/Release = SunOS 5.9 
Cipher = 
Patch Level = 8.0

Example 3 - On a UNIX system, retrieve the file exclude_list from client sun01 and write it to sun01_exclude_list in directory /usr/openv/netbackup/lists.

# bpgetconfig -e /usr/openv/netbackup/lists/sun01_exclude_list sun01

Example 4 - Retrieve the list of directories and files that are by default excluded from a backup.

#bpgetconfig -private_exld_list

Total Number of Entries in Exclude List : 23
/usr/openv/var/global/vxss/
/usr/openv/var/global/wsl/credentials/
/usr/openv/var/session/
/usr/openv/var/vxss/at/
/usr/openv/var/vxss/credentials/
/usr/openv/var/vxss/crl/
/usr/openv/var/websvccreds/
/usr/openv/var/global/wmc/cloud/*.pem
/usr/openv/var/global/webrootcert.pem
/usr/openv/var/global/.yekcnedwssap
/usr/openv/var/global/jkskey
/usr/openv/var/keyfile.dat
/opt/VRTSnbu/var/global/vxss/
/opt/VRTSnbu/var/global/wsl/credentials/
/opt/VRTSnbu/var/session/
/opt/VRTSnbu/var/vxss/at/
/opt/VRTSnbu/var/vxss/credentials/
/opt/VRTSnbu/var/vxss/crl/
/opt/VRTSnbu/var/websvccreds/
/opt/VRTSnbu/var/global/webrootcert.pem
/opt/VRTSnbu/var/global/.yekcnedwssap
/opt/VRTSnbu/var/global/jkskey
/opt/VRTSnbu/var/keyfile.dat

SEE ALSO

See bpsetconfig.

See nbgetconfig .

See nbsetconfig .