SYNOPSIS

       /usr/openv/netbackup/bin/admincmd/bpconfig [-cd seconds 86400...2147472000 or  0
              (Compress OFF)] [-ha hours 1...32767] [-kl days 1...32767 or 0 (Keep Logs
              OFF)] [-kt days 1...32767 or 0 (TIR Info  OFF)]  [-ma  [address]]  [-mdtm
              drives]  [-mj number 1...32767] [-period hours 1...24] [-prep hours] [-to
              seconds]  [-max_copies  2...10]   [cleanup_int   hours]   [-tries   times
              1...32767] [-wi minutes 1...1440] [-v] [-M master_server,...]

       /usr/openv/netbackup/bin/admincmd/bpconfig   [-L   |  -l  |  -U  [-v]  [-M  mas-
              ter_server,...]]


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 should be adequate for most installations. The sec-
       tion on NetBackup Global Attributes, in  the  NetBackup  System  Administrator's
       Guide describes the implications of setting the attribute values.

             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 Net-
              Backup global configuration attributes. See the section  DISPLAY  FORMATS
              for more detail on the displays.

       Errors  are  sent to stderr. A log of the command's activity is sent to the Net-
       Backup admin log file for the current day.

       This command can be executed by authorized users.  For  more  information  about
       NetBackup authorization, refer to "Enhanced Authorization and Authentication" in
       the NetBackup System Administrator's Guide.


OPTIONS

        -cd seconds 86400...2147472000 or 0 (Compress OFF)
                 The number of seconds that is the Compress-image-Database time  inter-
                 val.  When  seconds is a positive integer, an image will be compressed
                 after this number of seconds has elapsed since  the  creation  of  the
                 image.  On  Windows,  NetBackup uses NTFS file compression only if the
                 database is in an NTFS partition. Otherwise, it is not compressed.

                 The effect of compression is that less disk space is  needed  for  the
                 image  database. However, when browsing the image database for restor-
                 ing, the images need to be decompressed before they can  be  searched.
                 While browsing for a restore, the compressed images will not be found.
                 To decompress the images, you must use bpimage(1M).

                 The default is 0, which means no compression is done.

       -cleanup_int hours
                 This option enables you to run cleanup on a database image and in  the

       -ha hours 1...32767
                 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 instance, if hours ago is 24 and if  you  request  a
                 Backup  Status  report  at 10:00 a.m., the report includes all backups
                 run 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,  Prob-
                 lems,  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.  The default value is 24 hours.

       -kl days 1...32767 or 0 (Keep Logs OFF)
                 The  number  of  days  to keep logs. This determines how long the Net-
                 Backup master server keeps its Error database  and  debug  logs.  Net-
                 Backup derives its Backup Status, Problems, All Log Entries, and Media
                 Log Entries reports from the Error database, so this value limits  the
                 period that these reports can cover. The default is 28 days. A 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 or 0 (TIR Info OFF)
                 The number of days to Keep True-image-recovery (TIR) data. This deter-
                 mines how long to keep TIR information for those  policies  that  have
                 specified  that  TIR information is to be collected.  The default is 1
                 day.

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

       -l        The list type is short. This 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,...
                 A list of master servers. This is a comma-separated list of hostnames.
                 If this option is present, the command is run on each  of  the  master
                 servers  in  this  list.   The master servers must allow access by the
                 system issuing the command.  If an error occurs for any master server,
                 processing  stops at that point in the list. The default is the master
                 server for the system where the command is entered.

       -ma [address]
                 The mail address for the NetBackup administrator. This  is  the  email
                 address  to  which  NetBackup  sends  notification of failed automatic
                 backups, administrator-directed manual backup  operations,  and  auto-
                 matic database backups. The default is NULL (no email address).  If no
                 address is provided, the current setting of the Admin Mail Address  is
                 cleared.  This means that notification no longer will be sent by email
                 to the NetBackup administrator.
                 Specifies the maximum jobs per client. This is the maximum  number  of
                 jobs that a client may perform concurrently. number must be a positive
                 integer.  The default is 1.

       -period hours 1...24
                 The time interval associated with the configured number of tries for a
                 backup  (see  -tries). This is the period, in hours, during which Net-
                 Backup will attempt a backup job for a client/policy/schedule combina-
                 tion  for  as many tries as configured. hours must be a positive inte-
                 ger. The default is 12 hours.

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

       -prep hours
                 The preprocessing interval. This is the minimum time in hours  between
                 client  queries  to discover new paths if NetBackup is using auto-dis-
                 cover-streaming mode. For additional information, see the "Setting the
                 Preprocess  Interval for Auto Discovery" section in the topic on File-
                 List Directives for Multiple Data  Streams  in  the  NetBackup  System
                 Administrator's  Guide.  The default Preprocessing Interval value is 4
                 hours.  If the preprocessing interval is changed, it  can  be  changed
                 back to the default by specifying -prep -1.

                 The  preprocessing  interval can be set for immediate preprocessing by
                 specifying 0 as the preprocess interval  for  auto  discovery  on  the
                 bpconfig command line.

                 The maximum Preprocessing Interval is 48 hours.

       -to seconds
                 This  is the media-mount timeout, the length of time, in seconds, that
                 NetBackup waits for the requested media to be mounted, positioned, and
                 become  ready  on  backups and restores. Use this timeout to eliminate
                 excessive waits when it is necessary  to  manually  mount  media  (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 must be 300 (5 minutes) or greater.

       -tries times
                 The  number of retries for a backup, during the configured time period
                 (see -period). NetBackup tries  to  run  a  backup  job  for  a  given
                 client/policy/schedule  combination  this many times in the configured
                 period. This allows you to limit the number of backup attempts  should
                 repeated failures occur.

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

                 Usually the number of tries should be greater than 0. Specifying 0 for
                 the number of tries is legal but  stops  all  scheduled  backups.  The
                 default  is 2 tries. If defaults are used for both -tries and -period,
                 NetBackup will attempt the backup 2 times in 12 hours.


DISPLAY FORMATS

       bpconfig  uses three different formats to display the current values of the Net-
       Backup global configuration attributes.

             User Display Format (-U)

       If the command line contains -U, the display format is user.  The  user  display
       format  is the format used by bpadm and the NetBackup graphical-user interfaces.
       This option produces a listing with one global attribute per line. Each line has
       the  form  global attribute descriptor: value. This listing is similar to the -L
       format, except that the global attribute descriptors are more explicit:

              Admin Mail Address

              Job Retry Delay

              Max Simultaneous Jobs/Client

              Backup Tries (x tries in y hours)

              Keep Error/Debug Logs

              Max drives this master

              Keep TrueImageRecovery Info

              Compress Image DB Files

              Maximum Backup Copies

              Media Mount Timeout

              Display Reports

              Preprocess Interval

             Long Format (-L)

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

              Mail Admin

              Job Retry Delay

              Max Jobs/Client

              Backup Tries (x in y hours)

              Keep Logs

              Prep Interval

             Short Format (-l)

       If the bpconfig command line contains -l or contains no list-format option,  the
       display  format is short. This produces a terse listing. This option can be use-
       ful for scripts or programs that rework the listing  into  a  customized  report
       format. The listing layout is a single line containing the values for all global
       attributes. The attributes appear in the following order, separated  by  blanks.
       For  those attributes that are expressed in units of time, the time units follow
       the attributes in parentheses:

              NetBackup administrator email address

              Job Retry Delay (minutes)

              Time period (hours)

              Maximum simultaneous jobs per client

              Tries per period

              Keep logs (days)

              Maximum drives this master

              Compress image database interval (seconds; 0 denotes no compression)

              Media mount timeout (seconds; 0 denotes unlimited)

              Multihosted-media-mount timeout (seconds; 0 denotes unlimited)

              Postprocess images flag (0 denotes deferred, otherwise immediate)

              Display reports from <x> hours ago (hours)

              Keep TIR information (days)

              Preprocessing interval (hours)

             Example of How the Formats Differ

       Here is an example of how the display formats differ. bpconfig runs with each of
       the  three  display  formats  on  a NetBackup installation. The NetBackup global
       attributes are the same for the three displays.

       The first display format, -U, looks like this:

              bpconfig -U
              Admin Mail Address:
              Job Retry Delay:              1 minutes
              Max Simultaneous Jobs/Client: 1
                     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)
                     Postprocess Image:   immediately
                     Display Reports:     24 hours ago
                     Keep TIR Info:       1 days
                     Prep Interval:       0 hours
                     Maximum Backup Copies: 10

                     The third display format, -l, looks like this:
                     bpconfig -l
                     *NULL* 1 12 1 2 28 0 0 0 0 1 24 1 0

                     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 image database interval is 0 seconds; 0 denotes no compression

                     Media mount timeout is 0seconds; 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 1 day

                     Preprocessing interval is 0 hours


RETURN VALUES

       An exit status of 0 means that the command ran successfully.

       Any exit status other than 0 means that an error occurred.

       If administrative logging is enabled, the exit status is logged in the  adminis-

              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 Image DB Files:      (not enabled)
              Media Mount Timeout:          30 minutes
              Display Reports:              24 hours ago
              Preprocess Interval:          0 hours
              Maximum Backup Copies:      10

       Example 2

       Set  the  Compress-image-database  interval to 604800 seconds, so that NetBackup
       compresses images more than 7 days old:

              bpconfig -cd 604800
              bpconfig -U

              Admin Mail Address:
              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 Image DB Files:      older than 7 day(s)
              Media Mount Timeout:          0 minutes (unlimited)
              Display Reports:              24 hours ago
              Preprocess Interval:          0 hours
              Maximum Backup Copies:         10

       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


COPYRIGHT

       Copyright (c) 2002-2005 VERITAS Software Corporation. All rights reserved.






                           18 May 2005               bpconfig(1M)