bkstatus(1M) bkstatus(1M)
NAME
bkstatus - display the status of backup operations
SYNOPSIS
bkstatus [-h] [-f field_separator] [-j jobids] [-s states | -a] [-u users]
bkstatus -p period
DESCRIPTION
Without options, the bkstatus command displays the status of
backup operations that are in progress: either active,
pending, waiting or suspended. When used with the -a option,
the backup command includes failed and completed backup
operations in the display.
bkstatus -p defines the amount of status information that is
saved for display.
bkstatus may only be executed by a privileged user.
Each backup operation goes through a number of states as
described below. The keyletters listed in parentheses after
each state are used with the -s option and also appear on the
display.
pending(p)
backup has been invoked and the operations in the
backup register for the specified day are scheduled
to occur.
active(a) The backup operation has been assigned a destination
device and archiving is currently underway; or a
suspended backup has been resumed.
waiting(w)
The backup operation is waiting for operator
interaction, such as inserting the correct volume.
suspended(s)
The backup operation has been suspended by an
invocation of backup -S.
failed(f) The backup operation failed or has been canceled.
completed(c)
The backup operation has completed successfully.
Copyright 1994 Novell, Inc. Page 1
bkstatus(1M) bkstatus(1M)
The -a and -s options are mutually exclusive.
Options
-a Include failed and completed backup operations in
the display. All backup operations that have
occurred within the rotation period are displayed.
-f field_separator
Suppresses field wrap on the display and specifies
an output field separator to be used. The value of
c is the character that will appear as the field
separator on the display output. For clarity of
output, do not use a separator character that is
likely to occur in a field. For example, do not use
the colon as a field separator character if the
display will contain dates that use a colon to
separate hours from minutes. To use the default
field separator (tab), specify the null character
("") for c.
-h Suppress header on the display.
-j jobids Restrict the display to the specified list of backup
job ids (either comma-separated or blank-separated
and enclosed in quotes). [See backup(1M)].
-p period Define the amount of backup status information that
is saved and made available for display as period.
period is the number of weeks that information is
saved in /bkup/bkstatus.tab. Status information
that is older than the number of weeks specified in
period is deleted from the status table. The
minimum valid entry is 1. The maximum valid entry
is 52. The default is 1 week.
-s states Restrict the report to backup operations with the
specified states. states is a list of state key-
letters (concatenated, comma-separated or blank-
separated and surrounded by quotes). For example,
apf
a,p,f
"a p f"
all specify that the report should only include
backup operations that are active, pending or
failed.
Copyright 1994 Novell, Inc. Page 2
bkstatus(1M) bkstatus(1M)
-u users Restrict the display to backup operations started by
the specified list of users (either comma-separated
or blank-separated and enclosed in quotes). users
must be in the passwd file.
DIAGNOSTICS
The exit codes for the bkstatus command are the following:
0 The task completed successfully.
1 One or more parameters to bkstatus are invalid.
2 An error has occurred which caused bkstatus to fail to
complete all portions of its task.
EXAMPLES
Example 1:
bkstatus -p 4
specifies that backup status information is to be saved for
four weeks. Any status information older than four weeks is
deleted from the system.
Example 2:
bkstatus -a -j back-459,back-395
produces a display that shows status for the two backup jobs
specified, even if they have completed or failed.
Example 3:
bkstatus -s a,c -u "oper3 oper4"
produces a display that shows only those backup jobs issued by
users oper3 and oper4 that have a status of either active or
completed.
FILES
/etc/bkup/bkstatus.tab
lists the current status of backups that have
occurred or are still in progress
/etc/bkup/bkreg.tab
describes the backup policy decided on by the
System Administrator
Copyright 1994 Novell, Inc. Page 3
bkstatus(1M) bkstatus(1M)
REFERENCES
backup(1M), bkreg(1M)
Copyright 1994 Novell, Inc. Page 4