HPUX nbsworklist[4]
NBSWORKLIST(4) NBSWORKLIST(4)
NAME
nbsworklist - scheduling file used by HP OmniBack backup utility
SYNOPSIS
The worklist contains two types of entries:
Volume Entry = volume volume_spec [[+]{data_option...}]
[other_option...]
Default Entry = default [{data_option...}] [other_option...]
Data Options:
-trees object_pathname... | < backup_list_pathname
-exclude pattern... | < exclude_list_pathname
Scheduling and Logging Options:
-full_sched schedule
-incr_sched schedule
-list_all | -list_directories | -list_none
DESCRIPTION
The HP OmniBack worklist is a text file that nbsbackup uses to
determine what data to back up during an HP OmniBack backup session.
The worklist specifies the name of each disk volume to be backed up,
the objects on the volume that should be backed up, and a backup
schedule. The user creates a worklist file before running nbsbackup
for the first time. Multiple worklists can be created, and different
worklists can be specified for different backup sessions. The default
pathname for the worklist is /etc/omniback/work.
The main components of the worklist are volume entries, options, and
default entries. A worklist must contain at least one volume entry.
Other components are optional.
Volume Entries
A volume entry specifies the backup parameters for a logical volume.
Each entry starts with the keyword volume, followed by a volume
specification. Options are not required, but may be included to
specify additional backup requirements. The format for a volume entry
is
volume volume_spec [options]
The volume_spec provides information to HP OmniBack on the name that
should be assigned to the backed-up volume, the location of the Disk
Agent for the backup, and the location of the volume being backed up.
The form of the volume_spec depends on the network protocol used. The
following syntax statements for a volume entry show the alternative
formats for Internet and DDS protocols enclosed in parentheses.
Hewlett-Packard Company - 1 -HP OmniBack A.02.03 September 1992
NBSWORKLIST(4) NBSWORKLIST(4)
Note: DDS protocol can be used to invoke Disk Agents only on
Domain/OS systems.
Short form:
volume ( hostname:pathname | //hostname[pathname] ) [options]
Where hostname is the name of the system and pathname the name of the
top-level directory of the volume being backed up. For example, the
following volume entries specify that the root volume on each named
system be backed up:
volume sys8:/ (Internet protocol)
volume //sys40 (DDS protocol)
Long form:
volume backup_name ( ip:hostname | dds://hostname ) pathname
[options]
Where backup_name is a unique, user-specified name that identifies the
volume, hostname is the name of the system, and pathname the name of
the top-level directory of the volume being backed-up. For example,
the following volume entries specify that the volume dbase2 of the
named system be backed up, and that HP OmniBack will use the name
payroll in recording backup information in the log files and media:
volume payroll ip:sys8 /dbase2 (Internet protocol)
volume payroll dds://sys40 /dbase2 (DDS protocol)
Options and Default Entries
Worklist options specify the backup policy for each volume in the
worklist, in terms of the file system objects to be backed up (data),
backup frequency and type (scheduling), and the amount of detail
recorded in the backup log files (logging). When options are omitted
from the worklist, HP OmniBack applies default values that result in
the following policy:
o Data - Back up all objects in the file system.
o Scheduling - Schedule a full backup once a week, and an incremental
backup every day.
o Logging - Suppress logging of file and directory names.
HP OmniBack users can override the standard backup policy by
specifying options in the worklist. Two methods of option
specification are available - options can be included in volume
entries, or they can be specified in separate default entries.
Hewlett-Packard Company - 2 -HP OmniBack A.02.03 September 1992
NBSWORKLIST(4) NBSWORKLIST(4)
The format for a volume entry with options is
volume volume_spec [+]{data_option...} other_option...
and the format for a default entry is
default [{data_option...} other_option...]
where data_option... is one or more of the options specifying the
objects to be included in the backup, and other_option... is one or
more of the scheduling and logging options. Note that keyword default
should only be specified once, followed by all options in the
worklist.
When HP OmniBack processes the worklist, data options and other
options are handled by different programs. To ensure proper
processing, data options must precede any other options in the entry,
and the entire list of data options must be enclosed in braces ({}).
Options in a volume entry apply to a single volume. The value assigned
to an option in a volume entry overrides its current default value.
Any options omitted from a volume entry retain their current default
values. In a volume entry only, a plus sign (+) prefix can be used to
instruct HP OmniBack to combine the data options in that entry with
those in the previous default entry.
Options in a default entry apply to groups of volumes. Each time the
keyword default is used, it affects the group of volume entries
between itself and the next use of the keyword (or the end of the
worklist). The value assigned to an option in a default entry becomes
its default value until it is reassigned in another default entry.
Any options omitted from a default entry retain or revert to their
built-in default values. A default entry consisting only of the
keyword default restores the original built-in default values for all
options.
BASIC OPTIONS
Data Options
All data options must precede any other options in a worklist entry,
and the entire list of data options must be enclosed in braces ({}).
-trees object_pathname... | < backup_list_pathname
Specifies file and directory objects for backup. You can
specify the objects in the worklist, or use the redirection
syntax ( < ) to specify a separate file that lists the
objects.
If you omit this option, nbsbackup backs up all files,
links, and directories in the volume.
Hewlett-Packard Company - 3 -HP OmniBack A.02.03 September 1992
NBSWORKLIST(4) NBSWORKLIST(4)
object_pathname specifies the pathname of a file, directory,
or link to be backed up. The pathname must start with the
name of the top-level or root directory of the specified
volume. This pathname cannot contain wildcards and it cannot
be a link.
If the pathname specifies a file, nbsbackup backs up the
file as specified. If the pathname specifies a directory,
nbsbackup backs up the directory and all subordinate files
and subdirectories. If a link occurs within the directory,
nbsbackup does not resolve the link. The text of the link
is written, not its contents.
You cannot use the -trees option to specify a directory and
a subdirectory of the original directory. For example, if
you specify -trees /a and /a/b, nbsbackup processes /a and
ignores the /a/b entry because it is a descendant of /a.
-exclude pattern... | < exclude_list_pathname
Excludes objects from backup. The -exclude option applies
only to objects named in the most recently specified -trees
option. You can use pattern.. to specify one or more
objects in the worklist, or use the redirection syntax to
specify a separate file that lists the objects. Each
pattern specifies the name of an object to be excluded from
backup. The pattern can include wildcards. Any object that
matches the pattern is excluded from the backup. If you
omit the -exclude option, all objects specified with the
-trees option will be backed up.
Scheduling Options
-full_sched schedule
-incr_sched schedule
-full_sched specifies how often a volume is due for a full
backup and -incr_sched specifies how often a volume is due
for an incremental backup. Both types of backup can be
scheduled for a time relative to the most recent backups or
for specific times of the week.
If you omit the -full_sched option, volumes are due for full
backup every week. If you omit the -incr_sched option,
volumes are due for incremental backups every day. If a
volume is due for both full and incremental backups, HP
OmniBack does a full backup.
The format for the schedule variable is
frequency | day[:hh:mm]
Hewlett-Packard Company - 4 -HP OmniBack A.02.03 September 1992
NBSWORKLIST(4) NBSWORKLIST(4)
frequency specifies the relative occurrence of the backup
operation. Values are defined as: every n hours, every n
days, every n weekdays, always, or never. The default is
every 7 days for -full_sched, and every 1 days for
-incr_sched.
When you use the value every n days, HP OmniBack counts
every day in calculating when backups are due. For example,
if n = 3 and you start on Monday, volumes would be due for
backup on Thursday, Sunday, Wednesday, Saturday, and so on.
When you use the value every n weekdays, HP OmniBack counts
only weekdays in calculating when backups are due. For
example, if n = 3 and you start on Monday, volumes would be
due for backup on Thursday, Tuesday, Friday, Wednesday, and
so on.
day specifies a day of the week on which to perform backups.
Values can be the name of any day of the week or an
abbreviation consisting of the first three letters of the
day. Each day can accept an optional [:hh:mm] to specify the
exact time in hours and minutes. The time values are
specified in 24-hour day format. For example,
-full_sched mon:18:00 means full backups are due every
Monday after 18:00 hours, that is, Mondays after 6:00 P.M.
Logging Options
The logging options control how much information nbsbackup writes to
the volume log files for the backup session. The log files reside in
the directory /etc/omniback/logs. The logging options are mutually
exclusive.
-list_all Instructs nbsbackup to record the pathnames of all backed-up
objects (files, directories, and links).
-list_directories
Instructs nbsbackup to record the pathname of every
directory that is backed up (but not names of files or
links). This option can be abbreviated to -list_dir.
-list_none (default)
Instructs nbsbackup to record only general information about
the backup session, omitting the listing of individual
object names.
A logging option can also be issued through the nbsbackup command line
or the backup operator interface. Such an option overrides all logging
options included in worklist entries.
SUPPLEMENTAL OPTIONS
Hewlett-Packard Company - 5 -HP OmniBack A.02.03 September 1992
NBSWORKLIST(4) NBSWORKLIST(4)
Data Options
The following data options are used infrequently, but are available
for special circumstances, such as troubleshooting. All data options
must precede any other options in a worklist entry, and the entire
list of data options must be enclosed in braces ({}).
-ignore_dtm pattern... | < ignore_dtm_list_pathname
Ensures that objects are included in incremental backup even
if the dtm (date-time-modified) attribute indicates the file
has not recently changed. The nbsbackup command consults the
dtm attribute when performing incremental backups to
determine if the object has been modified. This option has
no meaning for full backup operations. If you omit this
option, only objects that have been changed recently are
included in incremental backups.
pattern specifies the name of an object whose dtm is to be
ignored. The pattern can include wildcards. You can also
specify the pathname of a file listing objects to be backed
up in ignore_dtm_list_pathname.
-run_before command-line
Specifies a command line to be invoked before backup is
started. The specified command-line is executed on the
machine where the Disk Agent process is running. Note that
command-line must be enclosed in quotes if arguments are
specified. The command runs with the real identity of the
original invoker of the nbsbackup command. This option is
useful for notifying a user that a backup is about to be
performed, or to create a snapshot of a database for
consistent backup.
-run_after command-line
Specifies a command line to be invoked after backup is
completed. The specified command-line is executed on the
machine where the Disk Agent process is running. Note that
command-line must be enclosed in quotes if arguments are
specified. The command runs with the real identity of the
original invoker of the nbsbackup command. This option can
be used to send messages to users or to clean up the
operation performed by the -run_before option.
-no_pdtu -no_pdtu prevents HP OmniBack from resetting the st_atime
(access time) file attribute. Without -no_pdtu, the
st_atime is preserved, but the st_ctime is updated by the
operating system. -no_pdtu is used to backup read-only
mounted file systems, and must be specified in the worklist
for these file systems. When specified, -no_pdtu the backup
completes successfully with one error indicating that the
/backup_log file on the read-only mounted file system could
not be updated. HP OmniBack normally backs up files during
Hewlett-Packard Company - 6 -HP OmniBack A.02.03 September 1992
NBSWORKLIST(4) NBSWORKLIST(4)
incremental backups by looking at the modification time of
the file (mtime), but not by looking for other changes to
the file attributes. For example, moving a file, changing
owners, permissions, and ACLs are not checked, so the file
will not be backed up. If you need to backup files with
these kinds of changes, you must specify -no_pdtu. Note that
-no_pdtu also updates each file's original last-access time
to the time of the backup.
EXAMPLES
The following examples illustrate a variety of worklist entries.
1. A volume entry for backup of selected directories on the root
volume of system ash:
volume ash:/ { -trees /smith /jones /troy/data }
2. A volume entry redirecting nbsbackup to the file backup_list for
information on what objects to back up on ash. This syntax enables
an administrator to assign volume users the task of maintaining the
list of objects to be backed up.
volume ash:/ { -trees < /backup_list }
3. The following example is a simple worklist for backing up three
volumes, using system defaults for scheduling, data, and logging.
volume ash:/
volume maple:/
volume sys8:/
4. A default entry that redefines the default option values for data
and logging:
default {-trees /users -exclude *.temp} -list_dir
5. A scheduling option for a full backup on a specific day (every
Tuesday):
volume ash:/ -full_sched tue
6. A scheduling option for incremental backups at a regular frequency
(two days after the full backup and every two days thereafter):
volume ash:/ -incr_sched every 2 days
SEE ALSO
nbsbackup(1M), nbsrestore(1M), nbscontents(1M), nbslogscan(1M)
Hewlett-Packard Company - 7 -HP OmniBack A.02.03 September 1992