NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (10.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.  
      bpcleanrestore
    22.  
      bpclient
    23.  
      bpclimagelist
    24.  
      bpclntcmd
    25.  
      bpclusterutil
    26.  
      bpcompatd
    27.  
      bpconfig
    28.  
      bpdbjobs
    29.  
      bpdbm
    30.  
      bpdgclone
    31.  
      bpdown
    32.  
      bpduplicate
    33.  
      bperror
    34.  
      bpexpdate
    35.  
      bpfis
    36.  
      bpflist
    37.  
      bpgetconfig
    38.  
      bpgetdebuglog
    39.  
      bpimage
    40.  
      bpimagelist
    41.  
      bpimmedia
    42.  
      bpimport
    43.  
      bpinst
    44.  
      bpkeyfile
    45.  
      bpkeyutil
    46.  
      bplabel
    47.  
      bplist
    48.  
      bpmedia
    49.  
      bpmedialist
    50.  
      bpminlicense
    51.  
      bpnbat
    52.  
      bpnbaz
    53.  
      bppficorr
    54.  
      bpplcatdrinfo
    55.  
      bpplclients
    56.  
      bppldelete
    57.  
      bpplinclude
    58.  
      bpplinfo
    59.  
      bppllist
    60.  
      bpplsched
    61.  
      bpplschedrep
    62.  
      bpplschedwin
    63.  
      bppolicynew
    64.  
      bpps
    65.  
      bprd
    66.  
      bprecover
    67.  
      bprestore
    68.  
      bpretlevel
    69.  
      bpschedule
    70.  
      bpschedulerep
    71.  
      bpsetconfig
    72.  
      bpstsinfo
    73.  
      bpstuadd
    74.  
      bpstudel
    75.  
      bpstulist
    76.  
      bpsturep
    77.  
      bptestbpcd
    78.  
      bptestnetconn
    79.  
      bptpcinfo
    80.  
      bpup
    81.  
      bpverify
    82.  
      cat_convert
    83.  
      cat_export
    84.  
      cat_import
    85.  
      configureCerts
    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.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcallhomeproxyconfig
    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.  
      nbfp
    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

bpgetconfig — get configuration information

SYNOPSIS

bpgetconfig -M host [-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 filename client [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 filename server [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 filename server [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 .