afs-web-interface-enhancements-20010623
[openafs.git] / doc / html / AdminReference / auarf246.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="auarf245.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="auarf247.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="HDRUSS_DELETE" HREF="auarf002.htm#ToC_260">uss delete</A></H2>
19 <A NAME="IDX5544"></A>
20 <A NAME="IDX5545"></A>
21 <A NAME="IDX5546"></A>
22 <A NAME="IDX5547"></A>
23 <A NAME="IDX5548"></A>
24 <A NAME="IDX5549"></A>
25 <A NAME="IDX5550"></A>
26 <A NAME="IDX5551"></A>
27 <A NAME="IDX5552"></A>
28 <A NAME="IDX5553"></A>
29 <P><STRONG>Purpose</STRONG>
30 <P>Deletes a user account
31 <P><STRONG>Synopsis</STRONG>
32 <PRE><B>uss delete -user</B> &lt;<VAR>login name</VAR>>  [<B>-mountpoint</B> &lt;<VAR>mountpoint for user's volume</VAR>>] 
33            [<B>-savevolume</B>]  [<B>-verbose</B>]  [<B>-cell</B> &lt;<VAR>cell name</VAR>>]  
34            [<B>-admin</B> &lt;<VAR>administrator to authenticate</VAR>>]  [<B>-dryrun</B>]  
35            [<B>-skipauth</B>]  [<B>-help</B>]
36     
37 <B>uss d -u</B> &lt;<VAR>login name</VAR>>  [<B>-m</B> &lt;<VAR>mountpoint for user's volume</VAR>>]  [<B>-sa</B>]  [<B>-v</B>]
38       [<B>-c</B> &lt;<VAR>cell name</VAR>>]  <B>-a</B> &lt;<VAR>administrator to authenticate</VAR>>]  
39       [<B>-d</B>]  [<B>-sk</B>]  [<B>-h</B>]
40 </PRE>
41 <P><STRONG>Description</STRONG>
42 <P>The <B>uss delete</B> command removes the Authentication Database and
43 Protection Database entries for the user named by <B>-user</B>
44 argument. In addition, it can remove the user's home volume and
45 associated VLDB entry, a mount point for the volume or both, depending on
46 whether the <B>-mountpoint</B> and <B>-savevolume</B> options are
47 provided.
48 <UL>
49 <P><LI>To remove both the volume and mount point, use the <B>-mountpoint</B>
50 argument to name the user's home directory. It is best to create a
51 tape backup of a volume before deleting it. Note that other mount
52 points for the volume are not removed, if they exist.
53 <P><LI>To remove the mount point only, provide both the <B>-mountpoint</B>
54 and <B>-savevolume</B> options.
55 <P><LI>To preserve both the volume and mount point, omit the
56 <B>-mountpoint</B> argument (or both it and the <B>-savevolume</B>
57 flag).
58 </UL>
59 <P><STRONG>Options</STRONG>
60 <DL>
61 <P><DT><B>-user
62 </B><DD>Names the entry to delete from the Protection and Authentication
63 Databases.
64 <P><DT><B>-mountpoint
65 </B><DD>Specifies the pathname to the user's home directory, which is deleted
66 from the filespace. By default, the volume referenced by the mount
67 point is also removed from the file server machine that houses it, along with
68 its Volume Location Database (VLDB) entry. To retain the volume and
69 VLDB entry, include the <B>-savevolume</B> flag. Partial pathnames
70 are interpreted relative to the current working directory. 
71 <P>Specify the read/write path to the mount point, to avoid the failure that
72 results from attempting to remove a mount point from a read-only
73 volume. By convention, the read/write path is indicated by placing a
74 period before the cell name at the pathname's second level (for example,
75 <B>/afs/.abc.com</B>). For further discussion of the
76 concept of read/write and read-only paths through the filespace, see the
77 <B>fs mkmount</B> reference page.
78 <P><DT><B>-savevolume
79 </B><DD>Preserves the user's volume and VLDB entry.
80 <P><DT><B>-verbose
81 </B><DD>Produces on the standard output stream a detailed trace of the
82 command's execution. If this argument is omitted, only warnings
83 and error messages appear.
84 <P><DT><B>-cell
85 </B><DD>Specifies the cell in which to run the command. For more details,
86 see the introductory <B>uss</B> reference page.
87 <P><DT><B>-admin
88 </B><DD>Specifies the AFS user name under which to establish authenticated
89 connections to the AFS server processes that maintain the various components
90 of a user account. For more details, see the introductory
91 <B>uss</B> reference page.
92 <P><DT><B>-dryrun
93 </B><DD>Reports actions that the command interpreter needs to perform while
94 executing the command, without actually performing them. For more
95 details, see the introductory <B>uss</B> reference page.
96 <P><DT><B>-skipauth
97 </B><DD>Prevents authentication with the AFS Authentication Server, allowing a
98 site using Kerberos to substitute that form of authentication.
99 <P><DT><B>-help
100 </B><DD>Prints the online help for this command. All other valid options
101 are ignored.
102 </DL>
103 <P><STRONG>Examples</STRONG>
104 <P>The following command removes <B>smith</B>'s user account from the
105 <B>abc.com</B> cell. The <B>-savevolume</B> argument
106 retains the <TT>user.smith</TT> volume on its file server
107 machine.
108 <PRE>   % <B>uss delete smith -mountpoint /afs/abc.com/usr/smith -savevolume</B>
109    
110 </PRE>
111 <P><STRONG>Privilege Required</STRONG>
112 <P>The issuer (or the user named by <B>-admin</B> argument) must belong to
113 the <B>system:administrators</B> group in the Protection Database,
114 must have the <TT>ADMIN</TT> flag turned on in his or her Authentication
115 Database entry, and must have at least <B>a</B> (<B>administer</B>)
116 and <B>d</B> (<B>delete</B>) permissions on the access control list
117 (ACL) of the mount point's parent directory. If the
118 <B>-savevolume</B> flag is not included, the issuer must also be listed in
119 the <B>/usr/afs/etc/UserList</B> file.
120 <P><STRONG>Related Information</STRONG>
121 <P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
122 <P><A HREF="auarf153.htm#HDRFS_MKMOUNT">fs mkmount</A>
123 <P><A HREF="auarf242.htm#HDRUSS_INTRO">uss</A>
124 <P>
125 <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="auarf245.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="auarf247.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> 
126 <!-- Begin Footer Records  ========================================== -->
127 <P><HR><B> 
128 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
129 </B> 
130 <!-- End Footer Records  ============================================ -->
131 <A NAME="Bot_Of_Page"></A>
132 </BODY></HTML>