install-and-document-klog-krb5-20080627
[openafs.git] / doc / html / AdminReference / auarf086.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <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="auarf085.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="auarf087.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> 
17 <P>
18 <H2><A NAME="HDRBK_SAVEDB" HREF="auarf002.htm#ToC_100">backup savedb</A></H2>
19 <A NAME="IDX4397"></A>
20 <A NAME="IDX4398"></A>
21 <A NAME="IDX4399"></A>
22 <P><STRONG>Purpose</STRONG>
23 <P>Creates a saved copy of the Backup Database
24 <P><STRONG>Synopsis</STRONG>
25 <PRE><B>backup savedb</B> [<B>-portoffset</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]  [<B>-archive</B> &lt;<VAR>date&nbsp;time</VAR>><SUP>+</SUP>]
26               [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
27   
28 <B>backup sa</B>  [<B>-p</B> &lt;<VAR>TC&nbsp;port&nbsp;offset</VAR>>]  [<B>-a</B> &lt;<VAR>date&nbsp;time</VAR>><SUP>+</SUP>]
29            [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
30 </PRE>
31 <P><STRONG>Description</STRONG>
32 <P>The <B>backup savedb</B> command creates a backup copy of the entire
33 Backup Database and writes it to the tape in the device controlled by the Tape
34 Coordinator indicated with the <B>-portoffset</B> argument. If the
35 database is damaged (as reported by the <B>backup dbverify</B> command),
36 this command repairs as much of the corruption as possible as it creates the
37 saved copy. The Backup Server creates a dump record for the saved
38 database in the Backup Database (but in the disk version of the database only,
39 not in the version written to tape).
40 <P>If the <B>FILE YES</B> instruction appears in the
41 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file associated with the
42 specified port offset, then the <B>backup savedb</B> command dumps the
43 database copy to the backup data file listed for that port offset in the Tape
44 Coordinator's <B>/usr/afs/backup/tapeconfig</B> file, instead of to
45 tape. For the sake of clarity, the following text refers to tapes only,
46 but the Backup System handles backup data files in much the same way.
47 <P>If the <B>-archive</B> flag is provided, after writing the saved copy
48 of the database the Backup System truncates the copy of the database on disk
49 by deleting volume dump records with timestamps prior to the specified date
50 and time (it does not delete the dump records created by previous <B>backup
51 savedb</B> commands, however).
52 <P>If the tape to which the database copy is written has an AFS tape name, it
53 must be <B>Ubik_db_dump.1</B> or <TT>&lt;NULL></TT>. Any
54 permanent name is acceptable.
55 <P>The Tape Coordinator's default response to this command is to access
56 the first tape by invoking the <B>MOUNT</B> instruction in the local
57 <B>/usr/afs/backup/CFG_</B><VAR>device_name</VAR> file, or by prompting the
58 backup operator to insert the tape if there is no <B>MOUNT</B>
59 instruction. However, if the <B>AUTOQUERY NO</B> instruction
60 appears in the <B>CFG_</B><VAR>device_name</VAR> file, or if the issuer of
61 the <B>butc</B> command included the <B>-noautoquery</B> flag, the
62 Tape Coordinator instead expects the tape to be in the device already.
63 If it is not, the Tape Coordinator invokes the <B>MOUNT</B> instruction or
64 prompts the operator. It also invokes the <B>MOUNT</B> instruction
65 or prompts for any additional tapes needed to complete the operation; the
66 backup operator must arrange to provide them.
67 <P><STRONG>Options</STRONG>
68 <DL>
69 <P><DT><B>-portoffset
70 </B><DD>Specifies the port offset number of the Tape Coordinator handling the
71 tapes for this operation.
72 <P><DT><B>-archive
73 </B><DD>Specifies a date and time; volume dump records with earlier
74 timestamps are deleted from the disk copy of the Backup Database after the
75 Backup System dumps the database (a dump's timestamp appears in the
76 <TT>created</TT> field of the output from the <B>backup dumpinfo</B>
77 command). However, if a dump set contains any dump created after the
78 specified date, none of the dump records associated with the dump set are
79 deleted. Dump records for previous dumps of the database (created with
80 the <B>backup savedb</B> command) are never deleted; use the
81 <B>backup deletedump</B> command to remove them.
82 <P>Provide one of two values: 
83 <UL>
84 <P><LI>The string <B>NOW</B> to indicate the current date and time, in which
85 case the Backup System deletes all dump records except those for dumps of the
86 Backup Database itself.
87 <P><LI>A date value in the format <VAR>mm/dd/yyyy</VAR>
88 [<VAR>hh:MM</VAR>]. The month (<VAR>mm</VAR>), day (<VAR>dd</VAR>), and
89 year (<VAR>yyyy</VAR>) are required, and valid values for the year range from
90 <B>1970</B> to <B>2037</B>; higher values are not valid because
91 the latest possible date in the standard UNIX representation is in February
92 2038. The Backup System automatically reduces any later date to the
93 maximum value.
94 <P>The hour and minutes (<VAR>hh</VAR>:<VAR>MM</VAR>) are optional, but if
95 provided must be in 24-hour format (for example, the value
96 <B>14:36</B> represents 2:36 p.m.). If
97 omitted, the time defaults to 59 seconds after midnight (00:00:59
98 hours). Similarly, the <B>backup</B> command interpreter
99 automatically adds 59 seconds to any time value provided. In both
100 cases, adding 59 seconds compensates for how the Backup Database and
101 <B>backup dumpinfo</B> command represent dump creation times in hours and
102 minutes only. That is, the Database records a creation timestamp of
103 <TT>20:55</TT> for any dump created between 20:55:00 and
104 20:55:59. Automatically adding 59 seconds to a time thus
105 includes the records for all dumps created during that minute.
106 </UL>
107 <TABLE><TR><TD ALIGN="LEFT" VALIGN="TOP"><B>Note:</B></TD><TD ALIGN="LEFT" VALIGN="TOP">A plus sign follows this argument in the command's syntax statement
108 because it accepts a multiword value which does not need to be enclosed in
109 double quotes or other delimiters, not because it accepts multiple
110 dates. Provide only one date (and optionally, time) definition.
111 </TD></TR></TABLE>
112 <P><DT><B>-localauth
113 </B><DD>Constructs a server ticket using a key from the local
114 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
115 interpreter presents it to the Backup Server, Volume Server and VL Server
116 during mutual authentication. Do not combine this flag with the
117 <B>-cell</B> argument. For more details, see the introductory
118 <B>backup</B> reference page.
119 <P><DT><B>-cell
120 </B><DD>Names the cell in which to run the command. Do not combine this
121 argument with the <B>-localauth</B> flag. For more details, see the
122 introductory <B>backup</B> reference page.
123 <P><DT><B>-help
124 </B><DD>Prints the online help for this command. All other valid options
125 are ignored.
126 </DL>
127 <P><STRONG>Examples</STRONG>
128 <P>The following example writes a copy of the Backup Database to the tape
129 device controlled by the Tape Coordinator with port offset 1:
130 <PRE>   % <B>backup savedb -portoffset 1</B>
131    
132 </PRE>
133 <P><STRONG>Privilege Required</STRONG>
134 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
135 every machine where the Backup Server is running, or must be logged onto a
136 server machine as the local superuser <B>root</B> if the
137 <B>-localauth</B> flag is included.
138 <P><STRONG>Related Information</STRONG>
139 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
140 <P><A HREF="auarf066.htm#HDRBK_DBVERIFY">backup dbverify</A>
141 <P><A HREF="auarf085.htm#HDRBK_RESTOREDB">backup restoredb</A>
142 <P><A HREF="auarf126.htm#HDRBUTC">butc</A>
143 <P>
144 <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="auarf085.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="auarf087.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> 
145 <!-- Begin Footer Records  ========================================== -->
146 <P><HR><B> 
147 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
148 </B> 
149 <!-- End Footer Records  ============================================ -->
150 <A NAME="Bot_Of_Page"></A>
151 </BODY></HTML>