initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf278.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="auarf277.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="auarf279.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="HDRVOS_UNLOCK" HREF="auarf002.htm#ToC_292">vos unlock</A></H2>
19 <A NAME="IDX5855"></A>
20 <A NAME="IDX5856"></A>
21 <A NAME="IDX5857"></A>
22 <A NAME="IDX5858"></A>
23 <P><STRONG>Purpose</STRONG>
24 <P>Unlocks a single VLDB entry
25 <P><STRONG>Synopsis</STRONG>
26 <PRE><B>vos unlock -id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>] 
27            [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
28     
29 <B>vos unlock -i</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-n</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
30 </PRE>
31 <P><STRONG>Description</STRONG>
32 <P>The <B>vos unlock</B> command releases the lock on the Volume Location
33 Database (VLDB) entry for the indicated volume.
34 <P><STRONG>Cautions</STRONG>
35 <P>Do not user this command under normal circumstances.
36 <P>It is useful if the VLDB entry is locked but there is no reason to suspect
37 inconsistency within the volume or between it and the VLDB. Note that
38 it is possible to list information from locked VLDB entries, even though they
39 cannot be manipulated in other ways.
40 <P>The <B>vos unlockvldb</B> command unlocks several VLDB entries at once,
41 or even the entire VLDB. The <B>vos lock</B> command locks a VLDB
42 entry so that no one else can perform an action that requires writing the
43 VLDB.
44 <P><STRONG>Options</STRONG>
45 <DL>
46 <P><DT><B>-id
47 </B><DD>Specifies either the complete name or volume ID number of a volume of any
48 of the three types.
49 <P><DT><B>-cell
50 </B><DD>Names the cell in which to run the command. Do not combine this
51 argument with the <B>-localauth</B> flag. For more details, see the
52 introductory <B>vos</B> reference page.
53 <P><DT><B>-noauth
54 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
55 issuer. Do not combine this flag with the <B>-localauth</B>
56 flag. For more details, see the introductory <B>vos</B> reference
57 page.
58 <P><DT><B>-localauth
59 </B><DD>Constructs a server ticket using a key from the local
60 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
61 interpreter presents it to the Volume Server and Volume Location Server during
62 mutual authentication. Do not combine this flag with the
63 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
64 see the introductory <B>vos</B> reference page.
65 <P><DT><B>-verbose
66 </B><DD>Produces on the standard output stream a detailed trace of the
67 command's execution. If this argument is omitted, only warnings
68 and error messages appear.
69 <P><DT><B>-help
70 </B><DD>Prints the online help for this command. All other valid options
71 are ignored.
72 </DL>
73 <P><STRONG>Examples</STRONG>
74 <P>The following example unlocks the VLDB entry for the volume
75 <B>user.terry</B>.
76 <PRE>   % <B>vos unlock user.terry</B>
77    
78 </PRE>
79 <P><STRONG>Privilege Required</STRONG>
80 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
81 the machine specified with the <B>-server</B> argument and on each
82 database server machine. If the <B>-localauth</B> flag is included,
83 the issuer must instead be logged on to a server machine as the local
84 superuser <B>root</B>.
85 <P><STRONG>Related Information</STRONG>
86 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
87 <P><A HREF="auarf267.htm#HDRVOS_LOCK">vos lock</A>
88 <P><A HREF="auarf279.htm#HDRVOS_UNLOCKVLDB">vos unlockvldb</A>
89 <P>
90 <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="auarf277.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="auarf279.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> 
91 <!-- Begin Footer Records  ========================================== -->
92 <P><HR><B> 
93 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
94 </B> 
95 <!-- End Footer Records  ============================================ -->
96 <A NAME="Bot_Of_Page"></A>
97 </BODY></HTML>