.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "BACKUP_JOBS 8"
.TH BACKUP_JOBS 8 "2023-12-24" "OpenAFS" "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
backup_jobs \- Lists pending and running operations in interactive mode
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBjobs\fR [\fB\-help\fR]
.PP
\&\fBj\fR [\fB\-h\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBbackup jobs\fR command lists the job \s-1ID\s0 number and status of each
\&\fBbackup\fR operation running or pending in the current interactive session.
.PP
This command can be issued in interactive mode only. If the issuer of the
\&\fBbackup interactive\fR command included the \fB\-localauth\fR flag, the
\&\fB\-cell\fR argument, or both, those settings apply to this command also.
.PP
To terminate operations that appear in the output, issue the \fBbackup
kill\fR command and identify the operation to cancel with the job \s-1ID\s0 number
from this command's output.
.PP
To check the status of a Tape Coordinator, rather than of a certain
operation, use the \fBbackup status\fR command.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-help\fR" 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH "OUTPUT"
.IX Header "OUTPUT"
The output always includes the expiration date and time of the tokens that
the \fBbackup\fR command interpreter is using during the current interactive
session, in the following format:
.PP
.Vb 1
\&   <date>   <time>: TOKEN EXPIRATION
.Ve
.PP
If the execution date and time specified for a scheduled dump operation is
later than <date time>, then its individual line (as described in the
following paragraphs) appears below this line to indicate that the current
tokens will not be available to it.
.PP
If the issuer of the backup command included the \fB\-localauth\fR flag when
entering interactive mode, the line instead reads as follows:
.PP
.Vb 1
\&   :  TOKEN NEVER EXPIRES
.Ve
.PP
The entry for a scheduled dump operation has the following format:
.PP
.Vb 1
\&   Job <job_ID>:  <timestamp>:  dump  <volume_set>  <dump_level>
.Ve
.PP
where
.IP "<job_ID>" 4
.IX Item "<job_ID>"
Is a job identification number assigned by the Backup System.
.IP "<timestamp>" 4
.IX Item "<timestamp>"
Indicates the date and time the dump operation is to begin, in the format
\&\fImonth\fR/\fIdate\fR/\fIyear\fR \fIhours\fR:\fIminutes\fR (in 24\-hour format)
.IP "<volume_set>" 4
.IX Item "<volume_set>"
Indicates the volume set to dump.
.IP "<dump_level>" 4
.IX Item "<dump_level>"
Indicates the dump level at which to perform the dump operation.
.PP
The line for a pending or running operation of any other type has the
following format:
.PP
.Vb 1
\&   Job <job_ID>:  <operation>  <status>
.Ve
.PP
where
.IP "<job_ID>" 4
.IX Item "<job_ID>"
Is a job identification number assigned by the Backup System.
.IP "<operation>" 4
.IX Item "<operation>"
Identifies the operation the Tape Coordinator is performing, which is
initiated by the indicated command:
.RS 4
.IP "Dump (\fIdump name\fR)" 4
.IX Item "Dump (dump name)"
Initiated by the backup dump command. The \fIdump name\fR has the following
format:
.Sp
.Vb 1
\&    <volume_set_name>.<dump_level_name>
.Ve
.IP "Restore" 4
.IX Item "Restore"
Initiated by the \fBbackup diskrestore\fR, \fBbackup volrestore\fR, or \fBbackup
volsetrestore\fR command.
.IP "Labeltape (\fItape_label\fR)" 4
.IX Item "Labeltape (tape_label)"
Initiated by the \fBbackup labeltape\fRn command. The \fItape_label\fR is the
name specified by the \fBbackup labeltape\fR command's \fB\-name\fR or \fB\-pname\fR
argument.
.IP "Scantape" 4
.IX Item "Scantape"
Initiated by the \fBbackup scantape\fR command.
.IP "SaveDb" 4
.IX Item "SaveDb"
Initiated by the \fBbackup savedb\fR command.
.IP "RestoreDb" 4
.IX Item "RestoreDb"
Initiated by the \fBbackup restoredb\fR command.
.RE
.RS 4
.RE
.IP "<status>" 4
.IX Item "<status>"
Indicates the job's current status in one of the following messages. If no
message appears, the job is either still pending or has finished.
.RS 4
.IP "\fInumber\fR Kbytes, volume \fIvolume_name\fR" 4
.IX Item "number Kbytes, volume volume_name"
For a running dump operation, indicates the number of kilobytes copied to
tape or a backup data file so far, and the volume currently being dumped.
.IP "\fInumber\fR Kbytes, restore.volume" 4
.IX Item "number Kbytes, restore.volume"
For a running restore operation, indicates the number of kilobytes copied
into \s-1AFS\s0 from a tape or a backup data file so far.
.IP "[abort requested]" 4
.IX Item "[abort requested]"
The \fBbackup kill\fR command was issued, but the termination signal has yet
to reach the Tape Coordinator.
.IP "[abort sent]" 4
.IX Item "[abort sent]"
The operation is canceled by the \fBbackup kill\fR command.  Once the Backup
System removes an operation from the queue or stops it from running, it no
longer appears at all in the output from the command.
.IP "[butc contact lost]" 4
.IX Item "[butc contact lost]"
The backup command interpreter cannot reach the Tape Coordinator. The
message can mean either that the Tape Coordinator handling the operation
was terminated or failed while the operation was running, or that the
connection to the Tape Coordinator timed out.
.IP "[done]" 4
.IX Item "[done]"
The Tape Coordinator has finished the operation.
.IP "[drive wait]" 4
.IX Item "[drive wait]"
The operation is waiting for the specified tape drive to become free.
.IP "[operator wait]" 4
.IX Item "[operator wait]"
The Tape Coordinator is waiting for the backup operator to insert a tape
in the drive.
.RE
.RS 4
.RE
.SH "EXAMPLES"
.IX Header "EXAMPLES"
The following example shows that two restore operations and one dump
operation are running (presumably on different Tape Coordinators) and that
the \fBbackup\fR command interpreter's tokens expire on 22 April 1999 at
10:45 am:
.PP
.Vb 5
\&   backup> jobs
\&   Job 1: Restore, 1306 Kbytes, restore.volume
\&   Job 2: Dump (user.sunday1), 34 Kbytes, volume user.pat.backup
\&   Job 3: Restore, 2498 Kbytes, restore.volume
\&          04/22/1999 10:45: TOKEN EXPIRATION
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
None. However, queuing any operation requires privilege, and it is
possible to issue this command only within the interactive session in
which the jobs are queued.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBbackup\fR\|(8),
\&\fBbackup_interactive\fR\|(8),
\&\fBbackup_kill\fR\|(8),
\&\fBbackup_quit\fR\|(8)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
\&\s-1IBM\s0 Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  It was
converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.