added button GIF's to the HTML docs
[openafs.git] / doc / html / AdminReference / auarf082.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="auarf081.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="auarf083.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_LISTVOLSETS" HREF="auarf002.htm#ToC_96">backup listvolsets</A></H2>
19 <A NAME="IDX4374"></A>
20 <A NAME="IDX4375"></A>
21 <A NAME="IDX4376"></A>
22 <A NAME="IDX4377"></A>
23 <A NAME="IDX4378"></A>
24 <A NAME="IDX4379"></A>
25 <P><STRONG>Purpose</STRONG>
26 <P>Lists volume set entries from the Backup Database
27 <P><STRONG>Synopsis</STRONG>
28 <PRE><B>backup listvolsets</B> [<B>-name</B> &lt;<VAR>volume&nbsp;set&nbsp;name</VAR>>]
29                    [<B>-localauth</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-help</B>]
30    
31 <B>backup listv</B> [<B>-n</B> &lt;<VAR>volume&nbsp;set&nbsp;name</VAR>>]  [<B>-l</B>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-h</B>]
32 </PRE>
33 <P><STRONG>Description</STRONG>
34 <P>The <B>backup listvolsets</B> command displays the Backup Database
35 records for either
36 <UL>
37 <P><LI>All volume sets and their volume entries, if the <B>-name</B> argument
38 is omitted
39 <P><LI>The volume set specified by the <B>-name</B> argument, along with its
40 volume entries
41 </UL>
42 <P><STRONG>Options</STRONG>
43 <DL>
44 <P><DT><B>-name
45 </B><DD>Names the volume set to display. If this argument is omitted, the
46 output lists all volume sets defined in the Backup Database.
47 <P><DT><B>-localauth
48 </B><DD>Constructs a server ticket using a key from the local
49 <B>/usr/afs/etc/KeyFile</B> file. The <B>backup</B> command
50 interpreter presents it to the Backup Server, Volume Server and VL Server
51 during mutual authentication. Do not combine this flag with the
52 <B>-cell</B> argument. For more details, see the introductory
53 <B>backup</B> reference page.
54 <P><DT><B>-cell
55 </B><DD>Names the cell in which to run the command. Do not combine this
56 argument with the <B>-localauth</B> flag. For more details, see the
57 introductory <B>backup</B> reference page.
58 <P><DT><B>-help
59 </B><DD>Prints the online help for this command. All other valid options
60 are ignored.
61 </DL>
62 <P><STRONG>Output</STRONG>
63 <P>The entry for each volume set begins with the <TT>Volume set</TT> header
64 and the volume set's name. A temporary volume set's name is
65 followed by the string <TT> (temporary)</TT>. Each volume entry
66 follows on a separate line, indicating the entry's index number and the
67 server, partition, and volume names it matches. The output uses the
68 metacharacter notation described on the <B>backup addvolentry</B>
69 reference page. Use the index number to identify volume entries when
70 deleting them with the <B>backup delvolentry</B> command.
71 <P><STRONG>Examples</STRONG>
72 <P>The following example shows the volume entries in the three volume sets
73 currently defined in the Backup Database:
74 <PRE>   % <B>backup listvolsets</B>
75    Volume set user:
76        Entry   1: server .*, partition .*, volumes: user.*\.backup
77    Volume set sun
78        Entry   1: server .*, partition .*, volumes: sun4x_55\..*
79        Entry   2: server .*, partition .*, volumes: sun4x_56\..*
80    Volume set rs
81        Entry   1: server .*, partition .*, volumes: rs_aix42\..*
82    
83 </PRE>
84 <P><STRONG>Privilege Required</STRONG>
85 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
86 every machine where the Backup Server is running, or must be logged onto a
87 server machine as the local superuser <B>root</B> if the
88 <B>-localauth</B> flag is included.
89 <P><STRONG>Related Information</STRONG>
90 <P><A HREF="auarf060.htm#HDRBK_INTRO">backup</A>
91 <P><A HREF="auarf063.htm#HDRBK_ADDVOLENTRY">backup addvolentry</A>
92 <P><A HREF="auarf064.htm#HDRBK_ADDVOLSET">backup addvolset</A>
93 <P><A HREF="auarf070.htm#HDRBK_DELVOLENTRY">backup delvolentry</A>
94 <P><A HREF="auarf071.htm#HDRBK_DELVOLSET">backup delvolset</A>
95 <P>
96 <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="auarf081.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="auarf083.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> 
97 <!-- Begin Footer Records  ========================================== -->
98 <P><HR><B> 
99 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
100 </B> 
101 <!-- End Footer Records  ============================================ -->
102 <A NAME="Bot_Of_Page"></A>
103 </BODY></HTML>