initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf064.htm
diff --git a/doc/html/AdminReference/auarf064.htm b/doc/html/AdminReference/auarf064.htm
new file mode 100644 (file)
index 0000000..b6bf0a9
--- /dev/null
@@ -0,0 +1,109 @@
+<!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="auarf063.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="auarf065.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_ADDVOLSET" HREF="auarf002.htm#ToC_78">backup addvolset</A></H2>
+<A NAME="IDX4255"></A>
+<A NAME="IDX4256"></A>
+<A NAME="IDX4257"></A>
+<A NAME="IDX4258"></A>
+<A NAME="IDX4259"></A>
+<A NAME="IDX4260"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Creates a new (empty) volume set
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>backup addvolset -name</B> &lt;<VAR>volume&nbsp;set&nbsp;name</VAR>> [<B>-temporary</B>] 
+                 [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
+   
+<B>backup addvols -n</B> &lt;<VAR>volume&nbsp;set&nbsp;name</VAR>> [<B>-t</B>]  [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell name</VAR>>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>backup addvolset</B> command creates a new volume set, by
+default adding it to the Backup Database. It is best that the volume
+set's name indicate the volume set's contents; for example,
+define the volume entries in the <B>user</B> volume set to match all user
+volumes. The volume set name must be unique within the Backup Database
+of the local cell.
+<P>After issuing this command, issue the <B>backup addvolentry</B> command
+to define the volume entries in the volume set.
+<P>Sometimes it is convenient to create volume sets without recording them
+permanently in the Backup Database, for example when using the <B>backup
+volsetrestore</B> command to restore a group of volumes that were not
+necessarily backed up together. To create a <I>temporary</I> volume
+set, include the <B>-temporary</B> flag. A temporary volume set
+exists only during the lifetime of the current interactive session, so the
+flag is effective only when used during an interactive session (opened by
+issuing the <B>backup interactive</B> command). If it is included
+when the command is issued at the regular command shell prompt, the command
+appears to succeed, but the volume set is not created. As noted, a
+temporary volume set ceases to exist when the current interactive session
+ends, or use the <B>backup delvolset</B> command to delete it before
+that.
+<P>One advantage of temporary volume sets is that the <B>backup
+addvolset</B> command, and any <B>backup addvolentry</B> commands
+subsequently used to add volume entries to it, complete more quickly than for
+regular volume sets, because no records are created in the Backup
+Database.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B>-name
+</B><DD>Names the new volume set. The name can include up to 31 of any
+character other than the period. Avoid other metacharacters as
+well.
+<P><DT><B>-temporary
+</B><DD>Creates a volume set that exists only within the context of the current
+interactive session. It is not added to the Backup Database.
+<P><DT><B>-localauth
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
+interpreter presents it to the Backup Server, Volume Server and VL Server
+during mutual authentication. Do not combine this flag with the
+<B>-cell</B> argument. For more details, see the introductory
+<B>backup</B> reference page.
+<P><DT><B>-cell
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>backup</B> reference page.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Examples</STRONG>
+<P>The following command creates a volume set called <B>sys</B>:
+<PRE>   % <B>backup addvolset sys</B>
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
+every machine where the Backup Server is running, or must be logged onto a
+server machine as the local superuser <B>root</B> if the
+<B>-localauth</B> flag is included.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
+<P><A HREF="auarf063.htm#HDRBK_ADDVOLENTRY">backup addvolentry</A>
+<P><A HREF="auarf070.htm#HDRBK_DELVOLENTRY">backup delvolentry</A>
+<P><A HREF="auarf071.htm#HDRBK_DELVOLSET">backup delvolset</A>
+<P><A HREF="auarf082.htm#HDRBK_LISTVOLSETS">backup listvolsets</A>
+<P><A HREF="auarf092.htm#HDRBK_VOLSETRESTORE">backup volsetrestore</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="auarf063.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="auarf065.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>&#169; <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>