Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.1.1)
  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.  
      bppolicynew
    62.  
      bpps
    63.  
      bprd
    64.  
      bprecover
    65.  
      bprestore
    66.  
      bpretlevel
    67.  
      bpschedule
    68.  
      bpschedulerep
    69.  
      bpsetconfig
    70.  
      bpstsinfo
    71.  
      bpstuadd
    72.  
      bpstudel
    73.  
      bpstulist
    74.  
      bpsturep
    75.  
      bptestbpcd
    76.  
      bptestnetconn
    77.  
      bptpcinfo
    78.  
      bpup
    79.  
      bpverify
    80.  
      cat_convert
    81.  
      cat_export
    82.  
      cat_import
    83.  
      configurePorts
    84.  
      create_nbdb
    85.  
      csconfig cldinstance
    86.  
      csconfig cldprovider
    87.  
      csconfig meter
    88.  
      csconfig throttle
    89.  
      duplicatetrace
    90.  
      importtrace
    91.  
      jbpSA
    92.  
      jnbSA
    93.  
      ltid
    94.  
      manageClientCerts
    95.  
      mklogdir
    96.  
      nbauditreport
    97.  
      nbcatsync
    98.  
      NBCC
    99.  
      NBCCR
    100.  
      nbcertcmd
    101.  
      nbcertupdater
    102.  
      nbcldutil
    103.  
      nbcomponentupdate
    104.  
      nbcplogs
    105.  
      nbdb_admin
    106.  
      nbdb_backup
    107.  
      nbdb_move
    108.  
      nbdb_ping
    109.  
      nbdb_restore
    110.  
      nbdb_unload
    111.  
      nbdbms_start_server
    112.  
      nbdbms_start_stop
    113.  
      nbdc
    114.  
      nbdecommission
    115.  
      nbdelete
    116.  
      nbdeployutil
    117.  
      nbdevconfig
    118.  
      nbdevquery
    119.  
      nbdiscover
    120.  
      nbdna
    121.  
      nbemm
    122.  
      nbemmcmd
    123.  
      nbexecute
    124.  
      nbfindfile
    125.  
      nbfirescan
    126.  
      nbftadm
    127.  
      nbftconfig
    128.  
      nbgetconfig
    129.  
      nbhba
    130.  
      nbholdutil
    131.  
      nbhostidentity
    132.  
      nbhostmgmt
    133.  
      nbhypervtool
    134.  
      nbjm
    135.  
      nbkmsutil
    136.  
      nboraadm
    137.  
      nborair
    138.  
      nbpem
    139.  
      nbpemreq
    140.  
      nbperfchk
    141.  
      nbplupgrade
    142.  
      nbrb
    143.  
      nbrbutil
    144.  
      nbregopsc
    145.  
      nbreplicate
    146.  
      nbrestorevm
    147.  
      nbseccmd
    148.  
      nbsetconfig
    149.  
      nbsnapimport
    150.  
      nbsnapreplicate
    151.  
      nbsqladm
    152.  
      nbstl
    153.  
      nbstlutil
    154.  
      nbstop
    155.  
      nbsu
    156.  
      nbsvrgrp
    157.  
      resilient_clients
    158.  
      restoretrace
    159.  
      stopltid
    160.  
      tl4d
    161.  
      tl8d
    162.  
      tl8cd
    163.  
      tldd
    164.  
      tldcd
    165.  
      tlhd
    166.  
      tlhcd
    167.  
      tlmd
    168.  
      tpautoconf
    169.  
      tpclean
    170.  
      tpconfig
    171.  
      tpext
    172.  
      tpreq
    173.  
      tpunmount
    174.  
      verifytrace
    175.  
      vltadm
    176.  
      vltcontainers
    177.  
      vlteject
    178.  
      vltinject
    179.  
      vltoffsitemedia
    180.  
      vltopmenu
    181.  
      vltrun
    182.  
      vmadd
    183.  
      vmchange
    184.  
      vmcheckxxx
    185.  
      vmd
    186.  
      vmdelete
    187.  
      vmoprcmd
    188.  
      vmphyinv
    189.  
      vmpool
    190.  
      vmquery
    191.  
      vmrule
    192.  
      vmupdate
    193.  
      vnetd
    194.  
      vwcp_manage
    195.  
      vxlogcfg
    196.  
      vxlogmgr
    197.  
      vxlogview
    198.  
      W2KOption

Name

bpconfig — modify or display global configuration attributes for NetBackup

SYNOPSIS

bpconfig [-cd seconds] [-ha hours] [-kl days] [-kt days] [-ma [address]] [-sto seconds] [-mj number] [-period hours] [-prep hours] [-to seconds] [cleanup_int hours] [cleanup_wait minutes] [-tries times] [-wi minutes] [-pui minutes] [-v] [-M master_server,...]

bpconfig [-L | -l | -U [-v] [-M master_server,...]]

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

The bpconfig command modifies or displays the NetBackup global configuration attributes. These attributes affect operations for all policies and clients. With the exception of the NetBackup administrator's email address, the default values for these attributes are adequate for most installations.

See "About specifying the locale of the NetBackup installation" in the NetBackup Administrator's Guide, Volume II.

For implications of setting the attribute values, see NetBackup Global Attributes in the NetBackup Administrator's Guide, Volume I.

The following describes the two forms of bpconfig:

  • The first form of bpconfig modifies one or more of the NetBackup global configuration attributes. At least one option that changes a NetBackup global configuration attribute must be on the command line.

  • The second form of bpconfig displays the current settings of the NetBackup global configuration attributes. See DISPLAY FORMATS for more detail.

Errors are sent to stderr. A log of the command activity is sent to the NetBackup admin log file for the current day.

OPTIONS

-cd seconds

Specifies the number of seconds that is the Compress Catalog Interval. When seconds is an integer, an image compresses after this number of seconds has elapsed since the creation of the image. The range of values is 86400 to 2147472000. The default is zero (0), which means no compression is done.

Use the bpimage command to decompress the images.

-cleanup_int hours

Specifies the minimum period of time (in hours) that can elapse without a catalog cleanup. The default value is 12 (hours). Since cleanup cannot run during a catalog backup, large 24x7 environments that run long catalog backups may need a shorter cleanup interval (e.g., three hours). Regardless of the value of this option, the image database is automatically cleaned up at the end of a session of scheduled backups.

This option appears in the output display as Image DB Cleanup Interval (see examples).

-cleanup_wait minutes

Specifies the interval (in minutes) between image database catalog cleanup operations. The default value is 60 (minutes). If multiple backups occur during this cleanup wait interval, NetBackup only initiates one cleanup operation in this time period. The range of values is zero (0) to 720.

-ha hours

Specifies the number of hours ago that is the beginning of the time range for selecting NetBackup report entries. The end of the time range is the current time. For example, if hours ago is 24 and if you request a Backup Status report at 10:00 a.m., the report includes the following: All backups that ran from 10:00 a.m. yesterday until 10:00 a.m. today.

This value is used to calculate the time range for general reports and media reports. General reports include Backup Status, Client Backups, Problems, and All Log Entries. Media reports include Media List, Media Summary, Media Contents, Images on Media, and Media Log Entries.

Hours Ago is a positive integer in the range of 1 to 32767. The default value is 24 (hours).

-kl days

The number of days to keep logs. This number determines how long the NetBackup master server keeps its Error database and debug logs.

NetBackup derives its Backup Status, Problems, All Log Entries, and Media Log Entries reports from the Error database.

This value limits the period that these reports can cover. The range of values is 1 to 24855. The default is 28 days. A value of zero (0) turns logs off.

Note:

This attribute has no effect on remote media servers or clients (remote media servers apply only to NetBackup Enterprise Server).

-kt days

The number of days to Keep True-image-recovery (TIR) data. This value determines how long to keep TIR information for those policies that specify the collection of TIR information. The range of values is 1 to 24855. The default is one (1) day. A value of zero (0) turns off the TIR information.

-L

The list type is long. See the section DISPLAY FORMATS for more detail.

-l

The list type is short. This option is the default if the command line has no list-type option (for instance, if you enter bpconfig and a carriage return). See the section DISPLAY FORMATS for more detail.

-M master_server,...

The master server where the global configuration attributes reside.

-ma [address]

The mail address for the NetBackup administrator. NetBackup sends notification of failed automatic backups, the manual backup operations that the administrator directs, and automatic database backups to this email address. The default is NULL (no email address).

If no address is provided, the current setting of the Admin Mail Address is cleared. Notification is not sent by email to the NetBackup administrator.

-mj number

Specifies the maximum jobs per client. This number is the maximum number of jobs that a client can perform concurrently. It must be a positive integer. The range values are 1 to 32767. The default value is 1.

-period hours

The time interval that is associated with the configured number of tries for a backup (see -tries). This interval is the period in hours during which NetBackup tries a backup job for a client/policy/schedule combination for as many tries as configured. The hours must be a positive integer. The range values are 1 to 24. The default value is 12 hours.

Note:

This attribute does not apply to user-directed backups and archives.

-prep hours

Specifies the preprocessing interval. This interval is the minimum time in hours between client queries to discover new paths when NetBackup uses auto-discover-streaming mode.

The default Preprocess Interval value is four (4) hours. If the preprocessing interval changes, change it back to the default by specifying -prep -1. The preprocessing interval can be set to preprocess immediately by specifying 0 as the preprocess interval for auto discovery on the bpconfig command line. The maximum Preprocessing Interval is 48 hours.

For more information, see the NetBackup Administrator's Guide, Volume I.

-pui minutes

Specifies the policy update interval, which is how often NetBackup policy updates are processed. The default value is 10 minutes. The range of values is 1 to 1440 (minutes).

-sto seconds

The multihosted-media-mount timeout. This timeout is the time in seconds that NetBackup waits for a shared medium to be mounted, positioned, and ready on backups and restores. Use this timeout to eliminate excessive waits if another server uses a shared medium. The default is 0, which means no timeout (unlimited wait time).

For more details about multihosted drives, see the NetBackup Administrator's Guide, Volume I.

-to seconds

Specifies the media-mount timeout. This timeout is the time in seconds that NetBackup waits for the requested media to be mounted, positioned, and ready on backups and restores. Use -to to eliminate excessive waits when you need to mount media manually (for example, when robotic media is out of the robot or off site).

The default is 0, which means no timeout (unlimited wait time). If seconds is not 0, its value range is 1 to 32,767 seconds.

-tries times

The number of retries for a backup during the configured time period (see -period). For a given combination of client, policy, and schedule, NetBackup tries to run a backup job the specified number of times. This option limits the number of backup tries if repeated failures occur.

Note:

This attribute does not apply to user-directed backups and archives.

Values for -tries range from 1 to 32767. The default is two tries. If defaults are used for both -tries and -period, NetBackup tries the backup two times in 12 hours.

-U

The list type is user. See DISPLAY FORMATS for more detail.

-v

Selects verbose mode for logging. This option is meaningful only if it runs with the debug log function on. Therefore, the following directory must be defined:

On UNIX systems: /usr/openv/netbackup/logs/admin

On Windows systems: install_path\NetBackup\logs\admin

-wi minutes

Job Retry Delay. Specifies how often NetBackup retries a job. The default value is 10 minutes. The range of values is 1 to 1440 (minutes).

DISPLAY FORMATS

bpconfig uses the following three different formats to display the current values of the NetBackup global configuration attributes:

  • User Display Format (-U)

    The NetBackup graphical user interface uses this display format. This option produces a list with one global attribute per line. Each line has the form global attribute descriptor: value. This list is similar to the -L format, except that the global attribute descriptors are more explicit.

    The following is an example of the user display format:

    # bpconfig -U
        Admin Mail Address:
        Job Retry Delay:              1 minutes
        Max Simultaneous Jobs/Client: 1
        Backup Tries:                 2 time(s) in 12 hour(s)
        Keep Error/Debug Logs:        28 days
        Max drives this master:       0
        Keep TrueImageRecovery Info:  1 days
        Compress DB Files:            (not enabled)
        Media Mount Timeout:          0 minutes (unlimited)
        Display Reports:              24 hours ago
        Preprocess Interval:          0 hours
        Image DB Cleanup Interval:    12 hours
        Image DB Cleanup Wait Time:   60 minutes
        Policy Update Interval:       10 minutes
  • Long Format (-L)

    If the command line contains -L, the display format is long. This option produces a list with one global attribute per line, in the format global attribute descriptor: value. The fields are as follows:

    The following example shows the long format:

    # bpconfig -L
        Mail Admin:            *NULL*
        Job Retry Delay:       1 minutes
        Max Jobs/Client:       1
        Backup Tries:          2 in 12 hours
        Keep Logs:             28 days
        Max drives/master:     0
        Compress DB Files:     (not enabled)
        Media Mnt Timeout:     0 minutes (unlimited)
        Shared Timeout:        0 minutes(unlimited)
        Media Int Timeout:     0 minutes (unlimited)
        Display Reports:       24 hours ago
        Keep TIR Info:         1 days
        Prep Interval:         0 hours
        DB Clean Interval:     12 hours
        DB Clean Wait Time:    60 minutes
        Policy Update Interval:10 minutes
  • Short Format (-l)

    If the bpconfig command line contains -l or contains no list-format option, the display format is short, which produces a terse listing. This option is useful for the scripts or the programs that rework the list into a customized report format. The list layout is a single line that contains the values for all global attributes. The time units follow the attributes in parentheses for the attributes that are expressed in units of time. The attributes appear in the following order with blanks between them:

    The following is an example of the short format:

    # bpconfig -l
        *NULL* 1 12 1 2 28 0 0 0 0 1 24 1 0 2 10 60

    The display fields for the -l display are interpreted as follows:

    • NetBackup administrator email address has not been set.

    • Job Retry Delay is 1 minute.

    • Time period is 12 hours.

    • Maximum simultaneous jobs per client is 1.

    • Tries per period is 2.

    • Keep logs for 28 days.

    • Maximum drives this master is 0.

    • Compress Catalog Interval is 0 seconds; 0 denotes no compression.

    • Media mount timeout is 0 seconds; 0 denotes unlimited.

    • Multihosted-media-mount timeout is 0 seconds; 0 denotes unlimited.

    • Postprocess images flag is 1 (immediate).

    • Display reports from 24 hours ago.

    • Keep TIR information for one (1) day.

    • Preprocessing interval is zero (0) hours.

    • Catalog database cleanup interval is two (2) hours.

    • Catalog database cleanup wait time is 10 minutes.

    • Policy update interval is 60 minutes.

RETURN VALUES

An exit status of zero (0) means that the command ran successfully. Any exit status other than zero (0) means that an error occurred.

If the administrative log function is enabled, the exit status is logged in the administrative daily log under the log directory:

Windows: install_path\NetBackup\logs\admin
UNIX: /usr/openv/netbackup/logs/admin

It has the following form:

bpconfig: EXIT status = exit status

If an error occurred, a diagnostic precedes this message.

EXAMPLES

Example 1 - While the master server kiwi runs, display the global attribute settings on the master server plim:

# bpconfig -U -M plim
Admin Mail Address:           ichabod@null.null.com
Job Retry Delay:              10 minutes
Max Simultaneous Jobs/Client: 1
Backup Tries:                 1 time(s) in 8 hour(s)
Keep Error/Debug Logs:        6 days
Max drives this master:       0
Keep TrueImageRecovery Info:  1 days
Compress DB Files:            (not enabled)
Media Mount Timeout:          30 minutes
Display Reports:              24 hours ago
Preprocess Interval:          0 hours
Image DB Cleanup Interval:    12 hours
Image DB Cleanup Wait Time:   60 minutes
Policy Update Interval:       10 minutes

Example 2 - Set the Compress Catalog Interval to 604800 seconds, so that NetBackup compresses images more than seven days old:

# bpconfig -cd 604800
#bpconfig -U
Admin Mail Address:           *NULL*
Job Retry Delay:              10 minutes
Max Simultaneous Jobs/Client: 1
Backup Tries:                 2 time(s) in 12 hour(s)
Keep Error/Debug Logs:        28 days
Max drives this master:       0
Keep TrueImageRecovery Info:  2 days
Compress DB Files:            older than 7 day(s)
Media Mount Timeout:          0 minutes (unlimited)
Display Reports:              24 hours ago
Preprocess Interval:          0 hours
Image DB Cleanup Interval:    12 hours
Image DB Cleanup Wait Time:   60 minutes
Policy Update Interval:       10 minutes

Example 3 - Set the Media Mount Timeout to 1800 seconds.

# bpconfig -to 1800
# bpconfig -U
Admin Mail Address:           sasquatch@wapati.edu
Job Retry Delay:               10 minutes
Max Simultaneous Jobs/Client:   1
Backup Tries:                   1 time(s) in 12 hour(s)
Keep Error/Debug Logs:          3 days
Max drives this master:         0
Keep TrueImageRecovery Info:   24 days
Compress Image DB Files:          (not enabled)
Media Mount Timeout:           30 minutes
Display Reports:               24 hours ago
Preprocess Interval:           0 hours
Image DB Cleanup Interval:    12 hours
Policy Update Interval:       10 minutes

FILES

UNIX systems:

/usr/openv/netbackup/logs/admin/*
/usr/openv/netbackup/db/config/behavior

Windows systems:

install_path\NetBackup\db\config\behavior
install_path\NetBackup\logs\admin\*

SEE ALSO

See bpimage.

For more details about multihosted drives, see the NetBackup Administrator's Guide, Volume I.