mirror of
https://git.openafs.org/openafs.git
synced 2025-01-22 17:00:15 +00:00
268 lines
15 KiB
HTML
268 lines
15 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
|
|
<HTML><HEAD>
|
|
<TITLE>Administration Reference</TITLE>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
|
|
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
|
|
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
|
|
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
|
|
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
|
|
</HEAD><BODY>
|
|
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
|
|
<BODY bgcolor="ffffff">
|
|
<!-- End Header Records ============================================ -->
|
|
<A NAME="Top_Of_Page"></A>
|
|
<H1>Administration Reference</H1>
|
|
<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf059.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf061.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
|
|
<P>
|
|
<H2><A NAME="HDRBK_INTRO" HREF="auarf002.htm#ToC_74">backup</A></H2>
|
|
<A NAME="IDX4203"></A>
|
|
<A NAME="IDX4204"></A>
|
|
<A NAME="IDX4205"></A>
|
|
<A NAME="IDX4206"></A>
|
|
<A NAME="IDX4207"></A>
|
|
<P><STRONG>Purpose</STRONG>
|
|
<P>Introduction to the <B>backup</B> command suite
|
|
<P><STRONG>Description</STRONG>
|
|
<P>The commands in the <B>backup</B> command suite are the administrative
|
|
interface to the AFS Backup System. There are several categories of
|
|
commands in the suite:
|
|
<UL>
|
|
<P><LI>Commands to copy data from AFS volumes to tape or a backup data file, and
|
|
to restore it to the file system: <B>backup diskrestore</B>,
|
|
<B>backup dump</B>, <B>backup volrestore</B>, and <B>backup
|
|
volsetrestore</B>
|
|
<P><LI>Commands to administer the records in the Backup Database:
|
|
<B>backup adddump</B>, <B>backup addhost</B>, <B>backup
|
|
addvolentry</B>, <B>backup addvolset</B>, <B>backup deldump</B>,
|
|
<B>backup deletedump</B>, <B>backup delhost</B>, <B>backup
|
|
delvolentry</B>, <B>backup delvolset</B>, <B>backup dumpinfo</B>,
|
|
<B>backup listdumps</B>, <B>backup listhosts</B>, <B>backup
|
|
listvolsets</B>, <B>backup scantape</B>, <B>backup setexp</B>, and
|
|
<B>backup volinfo</B>
|
|
<P><LI>Commands to write and read tape labels: <B>backup labeltape</B>
|
|
and <B>backup readlabel</B>
|
|
<P><LI>Commands to list and change the status of backup operations and the
|
|
machines performing them: <B>(backup) jobs</B>, <B>(backup)
|
|
kill</B>, and <B>backup status</B>
|
|
<P><LI>Commands to enter and leave interactive mode: <B>backup
|
|
(interactive)</B> and <B>(backup) quit</B>
|
|
<P><LI>Commands to check for and repair corruption in the Backup Database:
|
|
<B>backup dbverify</B>, <B>backup restoredb</B>, and <B>backup
|
|
savedb</B>
|
|
<P><LI>Commands to obtain help: <B>backup apropos</B> and <B>backup
|
|
help</B>
|
|
</UL>
|
|
<P>The <B>backup</B> command interpreter interacts with two other
|
|
processes:
|
|
<A NAME="IDX4208"></A>
|
|
<A NAME="IDX4209"></A>
|
|
<UL>
|
|
<P><LI>The Backup Server (<B>buserver</B>) process. It maintains the
|
|
Backup Database, which stores most of the administrative information used by
|
|
the Backup System. In the standard configuration, the Backup Server
|
|
runs on each database server machine in the cell, and uses AFS's
|
|
distributed database technology, Ubik, to synchronize its copy of the database
|
|
with the copies on the other database server machines.
|
|
<P><LI>The Backup Tape Coordinator (<B>butc</B>) process. A separate
|
|
instance of the process controls each tape device or backup data file used to
|
|
dump or restore data. The Tape Coordinator runs on a Tape Coordinator
|
|
machine, which is an AFS server or client machine that has one or more tape
|
|
devices attached, or has sufficient disk space to accommodate one or more
|
|
backup data files on its local disk.
|
|
<P>Each Tape Coordinator must be registered in the Backup Database and in the
|
|
<B>/usr/afs/backup/tapeconfig</B> configuration file on the Tape
|
|
Coordinator machine's local disk, and information in the two places must
|
|
be consistent for proper Backup System performance. The optional
|
|
<B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> for each Tape Coordinator
|
|
records information used to automate its operation.
|
|
</UL>
|
|
<P>In addition to the standard command line interface, the <B>backup</B>
|
|
command suite provides an <I>interactive</I> interface, which has several
|
|
useful features described on the <B>backup (interactive)</B> reference
|
|
page. Three of the commands in the suite are available only in
|
|
interactive mode: <B>(backup) jobs</B>, <B>(backup) kill</B>,
|
|
and <B>(backup) quit</B>.
|
|
<P><STRONG>Options</STRONG>
|
|
<P>The following options are available on many commands in the
|
|
<B>backup</B> suite. The reference page for each command also lists
|
|
them, but they are described here in greater detail.
|
|
<A NAME="IDX4210"></A>
|
|
<A NAME="IDX4211"></A>
|
|
<A NAME="IDX4212"></A>
|
|
<DL>
|
|
<P><DT><B>-cell <<VAR>cell name</VAR>>
|
|
</B><DD>Names the cell in which to run the command. It is acceptable to
|
|
abbreviate the cell name to the shortest form that distinguishes it from the
|
|
other entries in the <B>/usr/vice/etc/CellServDB</B> file on the local
|
|
machine. If the <B>-cell</B> argument is omitted, the command
|
|
interpreter determines the name of the local cell by reading the following in
|
|
order:
|
|
<OL TYPE=1>
|
|
<P><LI>The value of the AFSCELL environment variable
|
|
<P><LI>The local <B>/usr/vice/etc/ThisCell</B> file
|
|
</OL>
|
|
<P>
|
|
<P>Do not combine the <B>-cell</B> and <B>-localauth</B>
|
|
options. A command on which the <B>-localauth</B> flag is included
|
|
always runs in the local cell (as defined in the server machine's local
|
|
<B>/usr/afs/etc/ThisCell</B> file), whereas a command on which the
|
|
<B>-cell</B> argument is included runs in the specified foreign
|
|
cell.
|
|
<P>The <B>-cell</B> argument is not available on commands issued in
|
|
interactive mode. The cell defined when the <B>backup</B> command
|
|
interpreter enters interactive mode applies to all commands issued during the
|
|
interactive session.
|
|
<A NAME="IDX4213"></A>
|
|
<P><DT><B>-help
|
|
</B><DD>Prints a command's online help message on the standard output
|
|
stream. Do not combine this flag with any of the command's other
|
|
options; when it is provided, the command interpreter ignores all other
|
|
options, and only prints the help message.
|
|
<P><DT><B>
|
|
<A NAME="IDX4214"></A>
|
|
-localauth
|
|
</B><DD>Constructs a server ticket using the server encryption key with the
|
|
highest key version number in the local <B>/usr/afs/etc/KeyFile</B>
|
|
file. The <B>backup</B> command interpreter presents the ticket,
|
|
which never expires, to the Backup Server, Volume Server and Volume Location
|
|
(VL) Server during mutual authentication.
|
|
<P>Use this flag only when issuing a command on a server machine; client
|
|
machines do not usually have a <B>/usr/afs/etc/KeyFile</B> file.
|
|
The issuer of a command that includes this flag must be logged on to the
|
|
server machine as the local superuser <B>root</B>. The flag is
|
|
useful for commands invoked by an unattended application program, such as a
|
|
process controlled by the UNIX <B>cron</B> utility or by a cron entry in
|
|
the machine's <B>/usr/afs/local/BosConfig</B> file. It is also
|
|
useful if an administrator is unable to authenticate to AFS but is logged in
|
|
as the local superuser <B>root</B>.
|
|
<P>Do not combine the <B>-cell</B> and <B>-localauth</B>
|
|
options. A command on which the <B>-localauth</B> flag is included
|
|
always runs in the local cell (as defined in the server machine's local
|
|
<B>/usr/afs/etc/ThisCell</B> file), whereas a command on which the
|
|
<B>-cell</B> argument is included runs in the specified foreign
|
|
cell.
|
|
<P>The <B>-localauth</B> argument is not available on commands issued in
|
|
interactive mode. The local identity and AFS tokens with which the
|
|
<B>backup</B> command interpreter enters interactive mode apply to all
|
|
commands issued during the interactive session.
|
|
<P><DT><B>
|
|
<A NAME="IDX4215"></A>
|
|
-portoffset <<VAR>TC port offset</VAR>>
|
|
</B><DD>Specifies the port offset number of the Tape Coordinator that is to
|
|
execute the <B>backup</B> command. The port offset number uniquely
|
|
identifies a pairing of a Tape Coordinator (<B>butc</B>) process and tape
|
|
device or backup data file.
|
|
<P>The <B>backup</B> command interpreter and Tape Coordinator process
|
|
communicate via a UDP socket, or port. Before issuing a
|
|
<B>backup</B> command that involves reading or writing a tape, the backup
|
|
operator must start a <B>butc</B> process that controls the appropriate
|
|
tape device and listens for requests sent to its port number. If a
|
|
Backup System machine has multiple tape devices attached, they can perform
|
|
backup operations simultaneously because each device has its own associated
|
|
<B>butc</B> process and port offset number.
|
|
<P>The Backup System associates a tape capacity and file mark size with each
|
|
port offset (as defined in the <B>tapeconfig</B> file). For a
|
|
compressing tape device, the capacity and file mark values differ for
|
|
compression and non-compression modes, so the two modes have distinct port
|
|
offset numbers.
|
|
<P>The Backup Database can store up to 58,511 port offsets, so the legal
|
|
values for this argument are the integers <B>0</B> through
|
|
<B>58510</B>. If the issuer omits the argument, it defaults to
|
|
<B>0</B>. (The limit of 58,511 port offsets results from the fact
|
|
that UDP socket numbers are identified by a 16-bit integer, and the lowest
|
|
socket number used by the Backup System is 7025. The largest number
|
|
that a 16-bit integer can represent is 65,535. Subtracting 7,025 yields
|
|
58,510. The addition of port offset 0 (zero) increases the maximum to
|
|
58,511.)
|
|
<P>Although it is possible to define up to 58,511 port offset numbers for a
|
|
cell, it is not possible to run 58,511 tape devices simultaneously, due to the
|
|
following limits:
|
|
<UL>
|
|
<P><LI>The maximum number of dump or restore operations that can run
|
|
simultaneously is 64.
|
|
<P><LI>The maximum number of tape devices that can work together on a restore
|
|
operation is 128 (that is the maximum number of values that can be provided
|
|
for the <B>-portoffset</B> argument to the <B>backup diskrestore</B>,
|
|
<B>backup volrestore</B>, or <B>backup volsetrestore</B>
|
|
command).
|
|
</UL>
|
|
<P>
|
|
<P>The Backup System does not reserve UDP sockets. If another
|
|
application is already using the Tape Coordinator's socket when it tries
|
|
to start, the <B>butc</B> process fails and the following error message
|
|
appears at the shell prompt:
|
|
<PRE> bind: Address already in use
|
|
rxi_GetUDPSocket: bind failed
|
|
|
|
</PRE>
|
|
</DL>
|
|
<P><STRONG>Privilege Required</STRONG>
|
|
<A NAME="IDX4216"></A>
|
|
<A NAME="IDX4217"></A>
|
|
<P>To issue any <B>backup</B> command that accesses the Backup Database
|
|
only, the issuer must be listed in the <B>/usr/afs/etc/UserList</B> file
|
|
on every machine where the Backup Server is running. To issue any
|
|
<B>backup</B> command that accesses volume data, the issuer must appear in
|
|
the <B>UserList</B> file on every Backup Server machine, every Volume
|
|
Location (VL) Server machine, and every file server machine that houses
|
|
affected volumes. By convention, a common <B>UserList</B> file is
|
|
distributed to all database server and file server machines in the
|
|
cell. See the chapter on privileged users in the <I>IBM AFS
|
|
Administration Guide</I> for more information on this type of
|
|
privilege.
|
|
<P>If the <B>-localauth</B> flag is included, the user must instead be
|
|
logged on as the local superuser <B>root</B> on the server machine where
|
|
the <B>backup</B> command is issued.
|
|
<P><STRONG>Related Information</STRONG>
|
|
<P><A HREF="auarf016.htm#HDRBOSCONFIG">BosConfig</A>
|
|
<P><A HREF="auarf018.htm#HDRCFG">CFG_<I>device_name</I></A>
|
|
<P><A HREF="auarf019.htm#HDRCLI_CSDB">CellServDB (client version)</A>
|
|
<P><A HREF="auarf023.htm#HDRKEYFILE">KeyFile</A>
|
|
<P><A HREF="auarf032.htm#HDRCLI_THISCELL">ThisCell (client version)</A>
|
|
<P><A HREF="auarf033.htm#HDRSV_THISCELL">ThisCell (server version)</A>
|
|
<P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
|
|
<P><A HREF="auarf050.htm#HDRTAPECONFIG">tapeconfig</A>
|
|
<P><A HREF="auarf061.htm#HDRBK_ADDDUMP">backup adddump</A>
|
|
<P><A HREF="auarf062.htm#HDRBK_ADDHOST">backup addhost</A>
|
|
<P><A HREF="auarf063.htm#HDRBK_ADDVOLENTRY">backup addvolentry</A>
|
|
<P><A HREF="auarf064.htm#HDRBK_ADDVOLSET">backup addvolset</A>
|
|
<P><A HREF="auarf066.htm#HDRBK_DBVERIFY">backup dbverify</A>
|
|
<P><A HREF="auarf067.htm#HDRBK_DELDUMP">backup deldump</A>
|
|
<P><A HREF="auarf068.htm#HDRBK_DELETEDUMP">backup deletedump</A>
|
|
<P><A HREF="auarf069.htm#HDRBK_DELHOST">backup delhost</A>
|
|
<P><A HREF="auarf070.htm#HDRBK_DELVOLENTRY">backup delvolentry</A>
|
|
<P><A HREF="auarf071.htm#HDRBK_DELVOLSET">backup delvolset</A>
|
|
<P><A HREF="auarf072.htm#HDRBK_DISKRESTORE">backup diskrestore</A>
|
|
<P><A HREF="auarf073.htm#HDRBK_DUMP">backup dump</A>
|
|
<P><A HREF="auarf074.htm#HDRBK_DUMPINFO">backup dumpinfo</A>
|
|
<P><A HREF="auarf075.htm#HDRBK_HELP">backup help</A>
|
|
<P><A HREF="auarf076.htm#HDRBK_INTERACTIVE">backup interactive</A>
|
|
<P><A HREF="auarf077.htm#HDRBK_JOBS">backup jobs</A>
|
|
<P><A HREF="auarf078.htm#HDRBK_KILL">backup kill</A>
|
|
<P><A HREF="auarf079.htm#HDRBK_LABELTAPE">backup labeltape</A>
|
|
<P><A HREF="auarf080.htm#HDRBK_LISTDUMPS">backup listdumps</A>
|
|
<P><A HREF="auarf081.htm#HDRBK_LISTHOSTS">backup listhosts</A>
|
|
<P><A HREF="auarf082.htm#HDRBK_LISTVOLSETS">backup listvolsets</A>
|
|
<P><A HREF="auarf083.htm#HDRBK_QUIT">backup quit</A>
|
|
<P><A HREF="auarf084.htm#HDRBK_READLABEL">backup readlabel</A>
|
|
<P><A HREF="auarf085.htm#HDRBK_RESTOREDB">backup restoredb</A>
|
|
<P><A HREF="auarf086.htm#HDRBK_SAVEDB">backup savedb</A>
|
|
<P><A HREF="auarf087.htm#HDRBK_SCANTAPE">backup scantape</A>
|
|
<P><A HREF="auarf088.htm#HDRBK_SETEXP">backup setexp</A>
|
|
<P><A HREF="auarf089.htm#HDRBK_STATUS">backup status</A>
|
|
<P><A HREF="auarf090.htm#HDRBK_VOLINFO">backup volinfo</A>
|
|
<P><A HREF="auarf091.htm#HDRBK_VOLRESTORE">backup volrestore</A>
|
|
<P><A HREF="auarf092.htm#HDRBK_VOLSETRESTORE">backup volsetrestore</A>
|
|
<P><A HREF="auarf125.htm#HDRBUSERVER">buserver</A>
|
|
<P><A HREF="auarf126.htm#HDRBUTC">butc</A>
|
|
<P>
|
|
<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf059.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf061.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
|
|
<!-- Begin Footer Records ========================================== -->
|
|
<P><HR><B>
|
|
<br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
|
|
</B>
|
|
<!-- End Footer Records ============================================ -->
|
|
<A NAME="Bot_Of_Page"></A>
|
|
</BODY></HTML>
|