Previous Chapter : Next Chapter : Top
This chapter describes the files and subdirectories in the BACKUP.UNET home directory. This documentation uses the prefix '$NBK/' to identify the names of files and directories located in the BACKUP.UNET home directory. For information on setting an environment variable for the BACKUP.UNET directory, refer to BACKUP.UNET Getting Started Guide.
Table 15-1 BACKUP.UNET Subdirectories
----------------------------------------------------------------------
Subdirectory Description
----------------------------------------------------------------------
nbk ESCAPES Mandatory directory; contains processing escape
shell scripts.
nbk TABLES Mandatory directory; contains the CISAM table files
used by BACKUP.UNET. Refer to page 15 3 for
more information.
nbk TYPES Optional directory; contains device type files, each of
which contains arguments for the specific device
type, for example, tk50, 9 track tape, or cartridge.
Refer to page 15 3 for more information.
----------------------------------------------------------------------
The nbk-ESCAPES directory contains the following processing escapes:
For instructions on using the processing escapes see Chapter 8, Using Processing Escapes.
This directory holds the CISAM tables used by BACKUP.UNET. These tables make up the BACKUP.UNET catalog. The catalog contains online data information that describes backed up data, and information on volume, device, and system management.
For detailed information about the catalog and its tables see Chapter 12, Managing BACKUP.UNET Catalogs.
This directory contains the device files used by BACKUP.UNET. Device type files contain the size (in blocks) and location arguments for each device type used by BACKUP.UNET. HEADING3Default Media Type Files
BACKUP.UNET provides the following media type files:
You can modify the media type files and define new media type files for additional types. HEADING3Sample Media Type File
The entries contained in each of the media type files provide the size and location arguments for the specific media type. For example, the entries in the 'tk50' type file are:
-s 170000
-l "Computer Room"
where -s indicates the size in blocks of the computed volume capacity (170,000 blocks) and -l is the location ("Computer Room").
-----------------------------------------------------------------------------
Files Description
-----------------------------------------------------------------------------
dbcheck Mandatory non text file. Contains an executable program
used to check and rebuild BACKUP.UNET indexes.
db.Sys_2_to_3 Mandatory file. Used only when updating from release 2.0
of BACKUP.UNET to release 3.00.27. This file is not used
again after the update. Contains data to convert
BACKUP.UNET tables created under version 2.0 to the for
mat used in version 3.00.27 and subsequent versions.
nbkbackupARGS Optional file. Can be used to hold arguments (one per line)
to the nbkup command (for example, for backup operations
only). The nbkup command checks this file. If it exists, its
arguments are passed to the nbkup command. (They can be
overridden by arguments on the command line itself.)
Optional file. Can be used to hold device related arguments
(one per line) for all parameters. BACKUP.UNET com
mands using device related arguments check for this file. If
it exists, its arguments are passed to the command. (These
arguments can be overridden by arguments on the command
line itself.)
Refer to page 15 10 for a list of default arguments supplied
in this file upon installation.
nbkLOG Mandatory text file. Holds a journal of selected
BACKUP.UNET events and errors, and serves as an audit
trail. You can examine this file whenever you need to check
the outcome of completed operations, such as a backup job,
a restore job, or recycling.
nbkLOG-1 Optional file. It is the "spun" (renamed) copy of the 'nbk
LOG' file and is created dynamically. Whenever a
BACKUP.UNET program writes to the 'nbkLOG' file, it
checks the current size of 'nbkLOG'.
If the size exceeds the number of characters specified in
message number 16 in the 'nbkMSGS' file, then the follow
ing actions are performed:
- 'nbkLOG' is renamed 'nbkLOG-1'.
- A new (empty) 'nbkLOG' is created, and future events are
recorded here.
- The nbk.logspun processing escape is invoked.
Note: Use the nbk.logspun processing escape to print the
old log file automatically.
nbk.LSR Mandatory non text file holding a utility program invoked
by the BRP daemon. Used to locate files described in the
worklist.
nbkMSGS Mandatory text file containing over 600 BACKUP.UNET
messages. Most are text messages; some represent configu
ration parameters. They may be edited to fit various user
reports, languages, and UNIX shell processing. For more
information on the 'nbkMSGS' file, refer to Chapter 7, Cus
tomizing the nbkMSGS File.
nbk.opmessage Mandatory file. Contains the command shell script used to
deliver messages to BACKUP.UNET operators. Refer to
page 8 19 for details on how it works, and page 8 21 for the
default 'nbk.opmessage' file shell script.
nbk.WLI Mandatory non text file holding a utility program invoked
by the BRP daemon. Used to interpret the worklist.
nbkWORKLIST Optional file. Default worklist for the nbkup command.
Defines areas of the system to be backed up. Refer to page
15 17 for more information.
rc.nbk Optional file. Contains a script that sets up the
BACKUP.UNET environment, and then starts the BRP and
IOP daemons if they are not currently running. This script
can be modified to match your installation environment and
then appended to the system '/etc/rc' file to be invoked on
system startup.
status.brp Automatically created when the BRP is started. During nor
mal shutdown of the BRP, this file is automatically
removed. Contains the date and time at which the BRP was
started.
status.iop Automatically created when the IOP is started. During nor
mal shutdown of the IOP, this file is automatically removed.
Contains the date and time at which the IOP was started.
tapedata Mandatory file. Used during installation or update to create
media types files in '$NBK/nbk-TYPES'.
-----------------------------------------------------------------------------
This is an optional file that contains backup related arguments used by the nbkup command, that checks for this file. The arguments contained in this file are used as defaults when performing a backup. The arguments contained in this file are overridden when a value different from the default specified in this file is entered on the command line.
Additionally, arguments in the 'nbkdeviceARGS' file override the arguments in the 'nbkbackupARGS' file. See page 15 10 for information on the 'nbkdeviceARGS' file. HEADING3Example
Following is a sample 'nbkbackupARGS' file:
-pool 9track
-compare=abort
This is an optional file that contains default values for device related arguments used by the nbkup, nrest, and nvol commands. Each device related argument appears on a line by itself.
The arguments contained in this file are overridden when a value different from the default specified in this file is entered on the command line. Additionally, arguments in this file override the arguments in the 'nbkbackupARGS' file. See page 15 9 for information on the 'nbkbackupARGS' file. HEADING3Example
Following is a sample 'nbkdeviceARGS' file:
-blksize 1024
-bs 10
-bsmax 10
-iswab
-cpio
nbkup -full -provider thor -pool 8mm
nbkup -full -blksize 512 -provider thor -pool 8mm
Listed below are the BACKUP.UNET device related arguments that can be maintained in the '$NBK/nbkdeviceARGS' file.
Note: The device name you specify must be the name of a device that performs an automatic rewind when the device is closed, so that subsequent opening and reading occurs at the first block of the volume.
Note: -swab is an output only option. BACKUP.UNET automatically detects and reads volumes, regardless of whether the data contained is byte swapped.
This file holds a journal of selected BACKUP.UNET events and errors that serves as an audit trail.
The '$NBK/nbkLOG' file contains a timestamped report of all BACKUP.UNET processing and actions and is used to record details of backup and restore operations.
You can view 'nbkLOG' whenever you need to check on the processing status of an operation, for example, backup, restore, or recycle. Use cat, more, page, or your desired editor to view the 'nbkLOG' file.
This optional file is the "spun" or dynamically created and renamed copy of the `nbkLOG' file. Whenever a BACKUP.UNET program that writes to the 'nbkLOG' file starts up, it checks the current size of 'nbkLOG'. If the size exceeds the number of characters specified in message 16 in the 'nbkMSGS' file, the following actions are performed:
Note: You can use the nbk.logspun processing escape to print the `nbkLOG' file automatically at a specified time.
This is a mandatory, executable (cannot be edited) utility program invoked by the BRP daemon. It is used to locate files described in the worklist.
This file contains messages that represent configuration parameters. These messages may be edited to fit various user reports, languages, and UNIX shell processing.
This is a mandatory file that must reside in the 'NBK' directory. The file contains the shell command script used to deliver mount messages to BACKUP.UNET operators.
nbk.opmessage is actually a processing escape and is invoked by the IOP daemon whenever operator intervention is required to mount or change a backup volume. For more information on the nbk.opmessage processing escape, see page 8 19.
This is an optional file used to contain a list of special device file names (for example, a raw partition) and the number of data blocks to back up. It resides in the BACKUP.UNET home directory. When running a backup, the 'nbkPARTITIONS' file is accessed automatically when the backup format is any type except tar.
Special files are usually those files located in the '/dev' directory but they may exist anywhere. Files you probably want to back up include those with names such as the following:
'rhd0a' raw partition file (disk special file)
Make sure you back up data in these files when you are using a database that maintains its data in raw format.
'tty16' special device file
Back up the name but not the data in this type of file.
Note: Do not specify a block count with tty type devices.
The 'nbkPARTITIONS' file contains the full pathname of device special files (one per line) along with the number of data blocks (block I/O) to be backed up. The block I/O number can be 0 or any positive valid number in an ASCII digit string. Each file name and block I/O number must be separated by one or more spaces, or by tab characters.
To back up the data in special character or block device files, their names must be specified in the worklist and in the 'nbkPARTITIONS' file.
An invalid block I/O number is treated as a block number of 0. The following two sample lines are invalid; only the file header is backed up:
/dev/syscon -10
/dev/hd1b ten
Note: The default data block size is 512 bytes. A backed up special file can be restored only with the same number of data blocks with which it was backed up.
This is a sample 'nbkPARTITIONS' file:
/dev/hd0a 5000 # back up 5000 blocks from /dev/hd0a /dev/hdlb 10000 # back up 10000 blocks from /dev/hdlb /dev/genicom 0 # back up only file header /dev/tty12 0 # back up only file header dev/ra0g 10 # text with 10 blocks of usr file system /dev/ra0e 12 These are sample worklist statements that support the 'nbkPARTITIONS' file: FROMDIR /dev INCLUDE hd0a hd1b genicom INCLUDE ra0g ra0e tty12
This is an optional text file that contains the recycle script used by the nvol -recycle command. This file defines when each backup and associated backup volumes are recycled. 'nbkRECYCLE' resides in the BACKUP.UNET home directory. Statements in the recycle script are not case sensitive.
For more information on recycling backup volumes and the recycle script, refer to Chapter 11, Recycling Backup Volumes.
This is a mandatory executable (cannot be edited) file holding a utility program invoked explicitly by the BRP daemon. It is used to interpret the worklist.
The file 'nbkWORKLIST' is the default worklist file used with the nbkup command. The worklist specifies the areas of your UNIX file system that are to be backed up.
For more information on the worklist, refer to Chapter 5, Using a Worklist.