linux-osi-module-proc-csdb-sprintf-bug-20050423
[openafs.git] / doc / html / AdminReference / auarf267.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="auarf266.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="auarf268.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_LOCK" HREF="auarf002.htm#ToC_281">vos lock</A></H2>
19 <A NAME="IDX5761"></A>
20 <A NAME="IDX5762"></A>
21 <A NAME="IDX5763"></A>
22 <A NAME="IDX5764"></A>
23 <A NAME="IDX5765"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Locks a VLDB volume entry
26 <P><STRONG>Synopsis</STRONG>
27 <PRE><B>vos lock -id</B> &lt;<VAR>volume&nbsp;name&nbsp;or&nbsp;ID</VAR>>  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>] 
28          [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
29    
30 <B>vos lo -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>]
31 </PRE>
32 <P><STRONG>Description</STRONG>
33 <P>The <B>vos lock</B> command locks the Volume Location Database (VLDB)
34 entry for the indicated volume, blocking any operation that requires a write
35 to that entry. The lock applies to all of the volume versions
36 associated with the entry, not just the one specified with the <B>-id</B>
37 argument.
38 <P>To unlock a single VLDB entry, use the <B>vos unlock</B>
39 command. To unlock several entries, or all locked entries in the VLDB,
40 use the <B>vos unlockvldb</B> command.
41 <P><STRONG>Cautions</STRONG>
42 <P>Do not use this command in normal circumstances. It is useful for
43 guaranteeing that the volume stays unchanged when there is reason to believe
44 that volume operations cannot properly lock VLDB volume entries as they
45 normally do to synchronize with one another.
46 <P><STRONG>Options</STRONG>
47 <DL>
48 <P><DT><B>-id
49 </B><DD>Specifies either the complete name or volume ID number of a volume of the
50 any of the three types.
51 <P><DT><B>-cell
52 </B><DD>Names the cell in which to run the command. Do not combine this
53 argument with the <B>-localauth</B> flag. For more details, see the
54 introductory <B>vos</B> reference page.
55 <P><DT><B>-noauth
56 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
57 issuer. Do not combine this flag with the <B>-localauth</B>
58 flag. For more details, see the introductory <B>vos</B> reference
59 page.
60 <P><DT><B>-localauth
61 </B><DD>Constructs a server ticket using a key from the local
62 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
63 interpreter presents it to the Volume Server and Volume Location Server during
64 mutual authentication. Do not combine this flag with the
65 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
66 see the introductory <B>vos</B> reference page.
67 <P><DT><B>-verbose
68 </B><DD>Produces on the standard output stream a detailed trace of the
69 command's execution. If this argument is omitted, only warnings
70 and error messages appear.
71 <P><DT><B>-help
72 </B><DD>Prints the online help for this command. All other valid options
73 are ignored.
74 </DL>
75 <P><STRONG>Examples</STRONG>
76 <P>The following command locks the VLDB entry for
77 <B>user.terry</B>.
78 <PRE>   % <B>vos lock user.terry</B>
79     
80 </PRE>
81 <P><STRONG>Privilege Required</STRONG>
82 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
83 the machine specified with the <B>-server</B> argument and on each
84 database server machine. If the <B>-localauth</B> flag is included,
85 the issuer must instead be logged on to a server machine as the local
86 superuser <B>root</B>.
87 <P><STRONG>Related Information</STRONG>
88 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
89 <P><A HREF="auarf278.htm#HDRVOS_UNLOCK">vos unlock</A>
90 <P><A HREF="auarf279.htm#HDRVOS_UNLOCKVLDB">vos unlockvldb</A>
91 <P>
92 <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="auarf266.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="auarf268.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> 
93 <!-- Begin Footer Records  ========================================== -->
94 <P><HR><B> 
95 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
96 </B> 
97 <!-- End Footer Records  ============================================ -->
98 <A NAME="Bot_Of_Page"></A>
99 </BODY></HTML>