![]() |
![]() |
![]() |
![]() |
Appendix B Settings
Common initialization variables are stored in an external file to be used by various Backup Professional programs. The file is located in $BPDIR/bpinit/master.ini. The master.ini file is a text file that follows the standard Microsoft INI file format, where variables are grouped by section.
The material in this appendix describes the variables by section and also specifies Backup Professional programs that access the variables. Each section contains a table of valid variables. For each table entry, Access lists the programs using the variable: Tasker (T), Promon/Admin (P), Backup (B), Restore (R), Server (S), and all routines (All).
The format indicates the type for the value of a particular name. The types are:
· Boolean Yes, No, True, False, 1 or 0
· Cmd Operating system command (i.e. /usr/bin/vi or cat)
· Number Any digit
· Path Full pathname of a file or directory
· String Arbitrary text
Configuration Options
This section provides information regarding task management.
AfterCmdWaitTime
Indicates the amount of time in seconds that is used to delay once the after command has been executed.
AllowRemoteRegistration
This option when set to true allows clients to do a remote registration to the server.
BeforeCmdWaitTime
Indicates the amount of time in seconds that is used to delay once the before command has been executed.
control
TCP port for which the Backup Professional server and client exchange command requests.
DefaultEditor
Path to the editor of your choice. Some non-GUI Backup Professional programs will use this when allowing you to modify specific files and so on.
DefaultTapeDevice
The number of the default tape device. The default tape device is displayed in selection boxes and combo boxes when you are required to specify a tape device.
DefProfile
The profile used by default in some Backup Professional utilities, such as Backup and Restore.
DispatcherGranularity
The number of seconds at which tasker checks for new tasks to be run; also, the time between task samplings in the Administration utility task monitor.
ForceNAT
When NAT is being used and this option is set to true a network address translation takes place regardless of the IP address in use.
ForceIP
The IP address that is forced on the client to use to a make a connection to the server.
MinutesInJobQueue
Specifies the amount of time in minutes that a task remains in the task queue after completion.
MinToClearDevice
Specifies the amount of time in minutes that is used to check devices for a possible reset.
MaxCompressionLoad
Indicates the maximum load value for a background D2D compression to compress older backups. If the load value is greater than this maximum the backups are not compressed.
MaxCompressionProcesses
Indicates the maximum number of compression processes that can kick off at a time to compress the disk archives on the device.
NetPacket
The low-level network transmission size. Specifies the size in bytes for which data should be transmitted between client and server. If you experience slow backups, modify this value to find an optimal transfer rate.You can first try doubling the number, and if that does not help, try halving the number successively until you find an optimal transfer rate. Change this value on the BP client to affect backup speeds and change it on the server to affect restore or verify speeds.
Pager
Path to the text viewer of your choice. Used in some of the non-GUI Backup Professional programs to display pages of text.
PrinterCmdCompressed
The command that is used for printing in the compressed mode.
Scheduled-attempts
Number of times a schedule is attempted before failing.
StatusMessage
Display task status in Short or Long format. The long format includes real-time speed of the task.
SysAdm
The account on the server that will be run as the root Backup Professional user.
SysWord
A password assigned by the administrator to validate a user requesting Backup Professional root privileges.
TaskDispatcherGranularity
The number of seconds at which tasker checks for new tasks to be run; also, the time between task samplings in the Administration utility task monitor.
Configuration Options (Windows and Novell)
This section provides information regarding the Windows and Novell options.
BackupProperties
This option when set to true allows to backup permissions and properties of files and directories under Windows.
BackupRegSec
This option is available for Windows clients. When this is set to true the registry entries are backed up.When set to false the entries are not backed up.
Color
This option sets the default color.
DetectHungFiles
When this option is set to true it enables to determine the exact location where the backup runs into a problem.
EnableAutomaticRestart
When the system files are restored the client is rebooted if this option is set to true. There is a message on the client indicating that it is going down for reboot.
Inettime
The amount of time in milliseconds between each listen to incoming connections.
IsClient
Indicates whether the system that is backed up is actually a client.
MacBackupproperties
This option is available for Novell clients.When this option is set to true it indicates that the Macintosh properties will be backed up.
ResetArchiveBit
When this is set to true the archive bit is reset after a Master or Incremental backup. This is set for applications that do not want their attributes changed.
DataBase
This section describes the database options used by the Backup Professional server.
Record_Inst_on_Size_change
Record_Inst_on_ModDate_change
Record_Inst_on_Links_change
Record_Inst_on_Perms_change
Reserved
CompactionRatio
Determines when a database update should occur. This specifies a space saved value in megabytes or as a percentage. The value Always indicates the update should be done regardless. If you specify the value 100Mb, the update will not occur until at least 100 megabytes of unused space can be retrieved. To be clear, you should follow the number with either Mb or a percent(%) sign. See also UpdateDays, UpdateCmd.
FatalFsCeiling
WarnFsCeiling
These variables specify how large the database filesystem may grow before Backup Professional will begin to warn about space running out. The values may be specified in megabytes (just a number) or as a percentage (90%). The warnings begin when the space available on the filesystem is less than WarnFsCeiling megabytes, or in the case of the percentage option, less than WarnFsCeiling percent is available. If the space available is less than FatalFsCeiling, the task will be canceled. These warnings appear in the backup message and schedule history.
See "Location Information" on page 345 for information about setting the ceiling for logs and reports.
NetpathsPurge
Specifies whether the server logically (False) or physically (True) deletes database netpath entries when a tape is recycled. Logically deleted records increases the speed of recycling tapes which allows the server start backups sooner. This requires that the physical delete be done at some other time. A physical delete will immediately make available the space consumed by deleted records.
LastUpdate
Indicates the last time a that the UpdateCmd command was run. Used in conjunction with UpdateDays to cleanup the database. Set this value to change the next time a database cleanup will occur. The format of the string is a date and time specified as mm/dd/yyyy-hh:mm.
PurgeDays
Specifies how many days a failed backup and its associated records are to be kept in the database. This is so you can see a failed Friday's backup when you get to work on Monday. This also applies to sundry list files and catalogs that may be generated during a backup.
UpdateCmd
The path to the script to run to update the database. As shipped, this is a script that is used by tasker to do any necessary purging or database work. See the comments in the script for more details.
UpdateDays
Number of days between each database update attempt. The CompactionRatio of the database is used to determine if the update will actually take place.
Debugging
This section specifies the debug level for each Backup Professional application. The debug levels are from 0 to 5, with 5 giving the most detailed information. Each entry in this section specifies the name of the application and its debug level. When an application is executed, the debug output is written to the file $BPDIR/logs.dir/appname.log where appname is the name of the application. The available application names are bpserver, bpclient, bpr, tasker, inittape, bpbuild, printdb, prorpt, xpromon, xbackup, and xrestore.
Disk-to-Disk
This section describes the disk-to-disk options used by the Backup Professional server.
AdvancedTapePositioning
This is a carry over and should not be touched. It allows fast seek positioning within large D2D archives.
CompressAfterDays
Archives are compressed after this many days. These archives are not as likely to be restored from and thus are compressed. Keep in mind, it takes a little bit longer to restore from a compressed archive as it must be decompressed. Also, for quick seek, it takes a little longer since the seek must happen through the compressed data.
CompressArchives
If YES, product automatically compresses the archives after a specified number of days.
CompressCmd
Useful if you want to specify your own compressing program. Alternatives are pack, compress, arc.
DefaultPurgeMegs
This is the number of megabytes to purge if the system cannot accurately estimate the amount of space for the backup that is about to run. This may happen if there is no prior history for that backup.
MaxConcurrentBackups
This is the number of concurrent backups that can run. You need a special license feature for this to be activated.
PurgeCommand
This is the command to remove archives when they are aged and more space is needed. You can replace with the a script to move the file to a remote site or longer term storage. Also it is possible to under Linux or other OS's that support the shred utility to use that. The shred program overwrites the archives with multiple bit patterns to be certain the data can not be ever read. It is used when security is a concern.
QuickSeek
Do we perform quick seek file access on restore. If there is some problem with restore, you might consider turning this off and repeating the restore. Sometimes due to various reasons the quick seek may overshoot.
TrimBlocks
This is the number of 512 blocks to adjust for quick seek. If a given file is 2020 blocks into an archive the system will trim this to 2010 block just to be save and not overshoot the mark. This may need to be adjusted if there is some minor corruption in an archive or the database.
UnCompressCmd
Command used to uncompress data. This must be configured to send data to what is referred to in Unix as standard output.
RX9Technology
This indicates whether we are using the RX9 technology in the system. Once the RX9 card is installed in the system, this should be set to True to start the RX9 technology.
Juke<interface>
These sections describe the commands that are to be used to manage a specific type of tape library or jukebox. Each known interface contains a section with the following values set specifically for the interface type. For the commands in these sections, the following environment variables (positional parameters) may be used:
· $BP_DEV_CHANGER - specifies the changer device pathname.
· $SLOT - specifies the jukebox slot number.
· $BP_JUKE_DRVNO - specifies the jukebox drive as a number.
Refer to Table 28 on page 332 for a full description of commonly exported BP variables.
ChangerDevice
Used as a starting point during configuration only.
DrvBase
Indicates whether the jukebox drives are numbered starting with 0 or 1.
JukeMoveFromDrive
Command to move a tape from a drive to a slot.
JukeMoveToDrive
Command to use to move a tape from a slot to a drive.
JukePosTo
Command to use to position the robotic armature to a slot. Not all jukeboxes have this ability (some don't have arms).
JukeQuery
Command to get capabilities of the jukebox.
SlotBase
Indicates whether the jukebox slots are numbered starting with 0 or 1.
Location Information
This section describes locations of the various Backup Professional facilities on the machine.
TMPDIR
Specifies a directory to be used for temporary files. This should contain a bit of space because compression uses it.
Start-Dir
Backup Professional directory from which all programs start.
DataBase
The path to Backup Professional database files. This should be on its own filesystem partition.
DataBase_utilities
The binary programs for the database. This is available for sites that already use the Envyr database and want to use those binaries.
CrashRecovery
The directory for the location of crash-recovery files and programs.
Reports
The directory where generated reports are kept.
Logs-Dir
The directory where logging is placed from various Backup Professional facilities.
WarnFsCeiling
This variable specifies how large a specific filesystem may grow before Backup Professional will begin to warn about space running out. This is used by the logging, reporting, and list facilities of the Backup Professional.
The value may be specified in megabytes (just a number) or as a percentage (90%). The warnings begin when the available space on the filesystem is less than WarnFsCeiling megabytes, or in the case of the percentage option, less than the WarnFsCeiling percentage available. You will see these warnings in the backup message and schedule history.
See "DataBase" on page 340 for information on setting the ceiling for the database filesystem.
Media Information
This section specifies backup media usage.
Name Format Default Access LatestMastRule Boolean True T LatestIncrRule Boolean True T VerifyIncompleteFileCnt Number 7 T
LatestMastRule
This setting controls how the media is handled when it needs labeling. When set to True, the rule prevents the use of the tape if there is any backup on the media that represents the last Master backup of a client's machine. This prevents the system from reusing this media until a second master backup is done for all clients that occur on the media. When set to False, only the tape label expiration date prevents the media from being reused when it becomes full.
LatestIncrRule
This setting controls how the media is handled when it needs labeling. When set to True, the rule will prevents the use of the tape if there is any backup on the media that represents the last Incremental backup of a client's machine. This prevents the system from reusing this media until a newer Incremental backup is done for all clients that this media contains. When set to False, only the tape-label expiration date prevents the media from being reused when it becomes full.
VerifyIncompleteFileCnt
This setting is used to set how many not backed up files to allow before the system considers it to be a failed backup and not perform a verify. When set to 0, any file not backed up will cause the backup to be considered bad, and no verification will take place. When set greater than 0, the system will perform the verification if less than or equal to the set number of files is not backed up.
Nice
This section specifies the nice level for each Backup Professional utility. The nice levels range from 1 to 3. A value of 3 allows you to do more work, whereas a value of 1 makes the backup go faster. Each entry in this section specifies the name of the application and its nice level. When an application is executed, the nice level is set for the duration of that process. The available application names are bpserver, bpclient, bpr, tasker, inittape, bpbuild, printdb, prortp, xpromon, xbackup and xrestore.
Reports
Server Information
This section lists the known database servers by name. Each entry in this section is specified as shown below.
Name Format Default Access Server# String NULL T,P,Cl
Server{n}
The name of a Backup Professional server machine. The variable name depends on the server, as the first server would be server1, the second server2, and so forth.
Tape Commands (Tape Definitions)
The Default commands to manipulate the tape drive are located in this section. Each defined device has a section using these names where the section name is the same as the device nickname.
AdvancedTapePositioning
Indicates whether sctape or the system's tape utility can skip multiple filemarks with one command.
DefExpirationDays
Indicates the number of days before an automatically labeled tape can be relabeled.
DefLabel
The label format for an automatically labeled tape. A %lu in the string will be converted to the tape number. While %x is converted to the date and %X converted to the time. More specifically, after any %lu is replaced with the tape number, strftime(3) is used to perform further replacements. See the system man page for strftime if you would like to use other replacements for the time.
Erase
The command which is used to erase a tape. A %s in the command is replaced with the tape device name. For example, mt -f %s rewind.
Fix1024
The command which is used to set the tape device's low-level mode to Fixed 1024K.
Fix512
The command which is used to set the tape device's low-level mode to Fixed 512K.
InitTapeMode
The command used to initialize the tape device. This generally sets the mode as well.
JukeCmds
Specifies the jukebox commands section-name used on interactive backups.
JukeInterface
Specifies the section-name that contains jukebox commands for a specific jukebox interface. This specifies how BP communicates with the jukebox.
LabelBlankTapes
Specifies whether a non Backup Professional tape can be automatically labeled.
Load
The command to load a tape.
OpenErrorDelay
The number of seconds to wait when an error has occurred on an open file before a retry will be attempted. If you have problems with labeling tapes, increase this value up to about 7 seconds and try again.
QuickSeek
Specifies if Backup Professional supports a tape device that can seek to a specific block offset.
QuickSeekCmd
The command to use to seek to a specified block offset on a tape when QuickSeek is set to True.
ReliableExitCodes
Some devices/machines do not have reliable exit codes from their operating system tape commands to indicate if the command exited properly. If set to False, exit codes from the tape commands are assumed to be successful.
Reset
The command to reset the tape drive.
Retention
The command to retention the tape.
Rewind
The command to rewind the tape.
Rewind_delay
The number of seconds to wait until the rewind command is issued.
Rfm
The command to read to the next filemark on the tape. This is used when AdvancedTapePositioning is set to False.
Rmfm
The command to position multiple filemarks at a time on the tape. This is used when AvancedTapePositioning is set to True.
SchedJukeCmds
Specifies the jukebox commands section-name to be used on scheduled backups.
Status
The command to get the status of the tape drive.
TapeLoadTime
Number of seconds to wait after loading a tape from a slot in a jukebox. This is to ensure the device is ready when BP attempts to read the tape label.
TrimBlocks
If QuickSeek is True, specifies the number of blocks to seek before actually reading the tape. This can be used to overcome unreliable compression rates which may cause an overestimated file offset on the tape.
Unload
The command to unload the tape from the tape drive.
Variable_bs
Command used to place the tape drive into variable mode.
Wfm
The command to write a filemark at the current tape position.
Unattended Backup Information
SummaryCmd
The command performed at the completion of each scheduled backup group. The %s is replaced by the filename that contains the summary report.
SummaryUseHtml
This setting indicates if the scheduled backup summary should contain HTML codes or not. You should set this to YES so that your browser can more easily format the report and present it well.
MailCmd
The path to the program to be used to e-mail failures and task summary to a user.
MailSubject
The subject of the e-mail message.
MailTo
Who gets the e-mail.
PrinterCmd
How to print the failure/summary reports? Example: lpr -dlp1 %s. The %s is used as a position indicator for the report filename.
XBackup
This section applies to the graphical backup utility on Unix machines.
Name Format Default Access showProgress Boolean True B showViewer Boolean False B
showProgress
Indicates if you wish to automatically display the progress viewer when you queue a backup task.
showViewer
Indicates if you wish to see the real-time progress of the backup as it runs. If True, will automatically run the backup viewer from which you can select the task of interest. Once selected, the files that are being backed up will display in a scrolled window. You may want to play with this if you are used to seeing the output from tar commands, etc.
XRestore
This section applies to the graphical backup utility on Unix machines.
Name Format Default Access fileVersionsFormat String Fileversions-Long R netpathsFormat String Netpaths-Long R showProgress Boolean True R showViewer Boolean False R
fileVersionsFormat
Specifies the format to use to display files in the File Versions window. This value specifies a section title in the database format file $BPDIR/bpinit/dbformat.ini that contains the actual format/layout definitions.
netpathsFormat
Specifies the format to use to display files in the File Selection window when specifying files to include or exclude from the restore. This value specifies a section title in the database format file $BPDIR/bpinit/dbformat.ini that contains the actual format/layout definitions.
showProgress
Indicates if you wish to automatically display the progress viewer when you queue a restore task.
showViewer
Indicates if you wish to see the real-time progress of the restore as it runs. If True, will automatically run the backup viewer from which you can select the task of interest. Once selected, the files that are being restored will display in a scrolled window. You may want to play with this if you are used to seeing the output from tar commands, etc.
![]() |
![]() |
![]() |
![]() |