Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.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.  
      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.  
      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.  
      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.  
      nbpem
    152.  
      nbpemreq
    153.  
      nbmlb
    154.  
      nbperfchk
    155.  
      nbplupgrade
    156.  
      nbrb
    157.  
      nbrbutil
    158.  
      nbregopsc
    159.  
      nbreplicate
    160.  
      nbrepo
    161.  
      nbrestorevm
    162.  
      nbseccmd
    163.  
      nbsetconfig
    164.  
      nbsnapimport
    165.  
      nbsnapreplicate
    166.  
      nbsqladm
    167.  
      nbstl
    168.  
      nbstlutil
    169.  
      nbstop
    170.  
      nbsu
    171.  
      nbsvrgrp
    172.  
      resilient_clients
    173.  
      restoretrace
    174.  
      stopltid
    175.  
      tldd
    176.  
      tldcd
    177.  
      tpautoconf
    178.  
      tpclean
    179.  
      tpconfig
    180.  
      tpext
    181.  
      tpreq
    182.  
      tpunmount
    183.  
      verifytrace
    184.  
      vltadm
    185.  
      vltcontainers
    186.  
      vlteject
    187.  
      vltinject
    188.  
      vltoffsitemedia
    189.  
      vltopmenu
    190.  
      vltrun
    191.  
      vmadd
    192.  
      vmchange
    193.  
      vmcheckxxx
    194.  
      vmd
    195.  
      vmdelete
    196.  
      vmoprcmd
    197.  
      vmphyinv
    198.  
      vmpool
    199.  
      vmquery
    200.  
      vmrule
    201.  
      vmupdate
    202.  
      vnetd
    203.  
      vssat
    204.  
      vwcp_manage
    205.  
      vxlogcfg
    206.  
      vxlogmgr
    207.  
      vxlogview
    208.  
      W2KOption
  3.  
    Index

Name

bpgetconfig — get configuration information

SYNOPSIS

bpgetconfig -M master [-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

-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 master

Specifies the master server (master) whose host 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

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