venus: Remove dedebug
[openafs.git] / AdminReference / auarf131.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="auarf130.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="auarf132.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="HDRFS_INTRO" HREF="auarf002.htm#ToC_145">fs</A></H2>
19 <A NAME="IDX4715"></A>
20 <A NAME="IDX4716"></A>
21 <A NAME="IDX4717"></A>
22 <A NAME="IDX4718"></A>
23 <A NAME="IDX4719"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Introduction to the <B>fs</B> command suite
26 <P><STRONG>Description</STRONG>
27 <P>The commands in the <B>fs</B> command suite constitute the main
28 administrative interface to the Cache Manager on an AFS client machine, which
29 is responsible for fetching AFS data from file server machines on behalf of
30 applications running on the client machine.
31 <P>There are several categories of commands in the <B>fs</B> command
32 suite:
33 <UL>
34 <P><LI>Commands to set and report how the Cache Manager interacts with server
35 machines: <B>fs checkservers</B>, <B>fs getcellstatus</B>,
36 <B>fs getserverprefs</B>, <B>fs listcells</B>, <B>fs newcell</B>,
37 <B>fs setcell</B>, 
38 <P><B>fs setserverprefs</B>, <B>fs sysname</B>, and <B>fs
39 wscell</B>
40 <P><LI>Commands to administer access control lists (ACLs): <B>fs
41 cleanacl</B>, <B>fs copyacl</B>, <B>fs listacl</B>, and <B>fs
42 setacl</B>
43 <P><LI>Commands to administer server machines, volumes or partitions that house a
44 given file or directory: <B>fs diskfree</B>, <B>fs examine</B>,
45 <B>fs listquota</B>, <B>fs quota</B>, <B>fs setquota</B>, <B>fs
46 setvol</B>, 
47 <P><B>fs whereis</B>, and <B>fs whichcell</B>
48 <P><LI>Commands to administer the local client cache and related
49 information: <B>fs checkvolumes</B>, <B>fs flush</B>, <B>fs
50 flushvolume</B>, <B>fs getcacheparms</B>, and <B>fs setcachesize</B>
51 <P><LI>Commands to administer volume mount points: <B>fs lsmount</B>,
52 <B>fs mkmount</B>, and <B>fs rmmount</B>
53 <P><LI>Commands to control monitoring and tracing: <B>fs debug</B>, and
54 <B>fs messages</B>
55 <P><LI>A command to administer the Cache Manager's interaction with other
56 file systems: <B>fs exportafs</B>
57 <P><LI>Commands to obtain help: <B>fs apropos</B> and <B>fs
58 help</B>
59 </UL>
60 <P>The Cache Manager and the <B>fs</B> commands use and maintain the
61 following configuration files:
62 <UL>
63 <P><LI>The <B>/usr/vice/etc/CellServDB</B> file lists the database server
64 machines in the local cell and any foreign cell to which the administrator
65 wishes to enable AFS access for users working on the machine. The
66 database server machines run the Authentication, Backup, Protection and Volume
67 Location (VL) Server processes, which maintain databases of administrative
68 information. For users to access a cell, its
69 <B>root.cell</B> volume must also be mounted in the local
70 cell's AFS file tree.
71 <P><LI>The <B>/usr/vice/etc/ThisCell</B> file defines the machine's cell
72 membership with respect to the AFS command suites and Cache Manager access to
73 AFS data.
74 <P><LI>The <B>/usr/vice/etc/cacheinfo</B> file defines configuration
75 parameters for the cache, including its size and whether it is in memory or on
76 disk.
77 </UL>
78 <P>In addition, the Cache Manager automatically creates files on the cache
79 partition (by default, <B>/usr/vice/cache</B> for caching and tracking
80 files fetched from file server machines.
81 <P>For more details, see the reference page for each file.
82 <P><STRONG>Options</STRONG>
83 <P>The following flag is available on every command in the <B>fs</B>
84 suite. The reference page for each command also lists it, but it is
85 described here in greater detail.
86 <A NAME="IDX4720"></A>
87 <A NAME="IDX4721"></A>
88 <A NAME="IDX4722"></A>
89 <DL>
90 <P><DT><B>-help
91 </B><DD>Prints a command's online help message on the standard output
92 stream. Do not combine this flag with any of the command's other
93 options; when it is provided, the command interpreter ignores all other
94 options, and only prints the help message.
95 </DL>
96 <P><STRONG>Privilege Required</STRONG>
97 <A NAME="IDX4723"></A>
98 <A NAME="IDX4724"></A>
99 <P>The privileges required for <B>fs</B> commands vary more than for other
100 command suites. Pay special attention to the <B>Privilege
101 Required</B> section of each command description.
102 <P>The various types of necessary privilege include:
103 <UL>
104 <P><LI>Having permissions on a directory's ACL. For example, creating
105 and removing mount points requires <B>a</B> (<B>administer</B>),
106 <B>i</B> (<B>insert</B>), and <B>d</B> (<B>delete</B>)
107 permissions on the ACL of the directory in which the mount point
108 resides.
109 <P><LI>Being logged onto the machine as the local superuser
110 <B>root</B>. This is necessary when issuing commands that affect
111 Cache Manager configuration.
112 <P><LI>Belonging to the <B>system:administrators</B> group in the
113 Protection Database.
114 <P><LI>No privilege. Many <B>fs</B> commands simply list
115 information.
116 </UL>
117 <P><STRONG>Related Information</STRONG>
118 <P><A HREF="auarf017.htm#HDRCACHEITEMS">CacheItems</A>
119 <P><A HREF="auarf019.htm#HDRCLI_CSDB">CellServDB (client version)</A>
120 <P><A HREF="auarf032.htm#HDRCLI_THISCELL">ThisCell (client version)</A>
121 <P><A HREF="auarf036.htm#HDRVN">V<I>n</I></A>
122 <P><A HREF="auarf040.htm#HDRVOLUMEITEMS">VolumeItems</A>
123 <P><A HREF="auarf043.htm#HDRCACHEINFO">cacheinfo</A>
124 <P><A HREF="auarf132.htm#HDRFS_APROPOS">fs apropos</A>
125 <P><A HREF="auarf133.htm#HDRFS_CHECKSERVERS">fs checkservers</A>
126 <P><A HREF="auarf134.htm#HDRFS_CHECKVOLUMES">fs checkvolumes</A>
127 <P><A HREF="auarf135.htm#HDRFS_CLEANACL">fs cleanacl</A>
128 <P><A HREF="auarf136.htm#HDRFS_COPYACL">fs copyacl</A>
129 <P><A HREF="auarf137.htm#HDRFS_DISKFREE">fs diskfree</A>
130 <P><A HREF="auarf138.htm#HDRFS_EXAMINE">fs examine</A>
131 <P><A HREF="auarf139.htm#HDRFS_EXPORTAFS">fs exportafs</A>
132 <P><A HREF="auarf140.htm#HDRFS_FLUSH">fs flush</A>
133 <P><A HREF="auarf141.htm#HDRFS_FLUSHMOUNT">fs flushmount</A>
134 <P><A HREF="auarf142.htm#HDRFS_FLUSHVOLUME">fs flushvolume</A>
135 <P><A HREF="auarf143.htm#HDRFS_GETCACHEPARMS">fs getcacheparms</A>
136 <P><A HREF="auarf144.htm#HDRFS_GETCELLSTATUS">fs getcellstatus</A>
137 <P><A HREF="auarf145.htm#HDRFS_GETCLIENTADDRS">fs getclientaddrs</A>
138 <P><A HREF="auarf146.htm#HDRFS_GETSERVERPREFS">fs getserverprefs</A>
139 <P><A HREF="auarf147.htm#HDRFS_HELP">fs help</A>
140 <P><A HREF="auarf148.htm#HDRFS_LISTACL">fs listacl</A>
141 <P><A HREF="auarf149.htm#HDRFS_LISTCELLS">fs listcells</A>
142 <P><A HREF="auarf150.htm#HDRFS_LISTQUOTA">fs listquota</A>
143 <P><A HREF="auarf151.htm#HDRFS_LSMOUNT">fs lsmount</A>
144 <P><A HREF="auarf152.htm#HDRFS_MESSAGES">fs messages</A>
145 <P><A HREF="auarf153.htm#HDRFS_MKMOUNT">fs mkmount</A>
146 <P><A HREF="auarf154.htm#HDRFS_NEWCELL">fs newcell</A>
147 <P><A HREF="auarf155.htm#HDRFS_QUOTA">fs quota</A>
148 <P><A HREF="auarf156.htm#HDRFS_RMMOUNT">fs rmmount</A>
149 <P><A HREF="auarf157.htm#HDRFS_SETACL">fs setacl</A>
150 <P><A HREF="auarf158.htm#HDRFS_SETCACHESIZE">fs setcachesize</A>
151 <P><A HREF="auarf159.htm#HDRFS_SETCELL">fs setcell</A>
152 <P><A HREF="auarf160.htm#HDRFS_SETCLIENTADDRS">fs setclientaddrs</A>
153 <P><A HREF="auarf161.htm#HDRFS_SETQUOTA">fs setquota</A>
154 <P><A HREF="auarf162.htm#HDRFS_SETSERVERPREFS">fs setserverprefs</A>
155 <P><A HREF="auarf163.htm#HDRFS_SETVOL">fs setvol</A>
156 <P><A HREF="auarf164.htm#HDRFS_STOREBEHIND">fs storebehind</A>
157 <P><A HREF="auarf165.htm#HDRFS_SYSNAME">fs sysname</A>
158 <P><A HREF="auarf166.htm#HDRFS_WHEREIS">fs whereis</A>
159 <P><A HREF="auarf167.htm#HDRFS_WHICHCELL">fs whichcell</A>
160 <P><A HREF="auarf168.htm#HDRFS_WSCELL">fs wscell</A>
161 <P>
162 <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="auarf130.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="auarf132.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> 
163 <!-- Begin Footer Records  ========================================== -->
164 <P><HR><B> 
165 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
166 </B> 
167 <!-- End Footer Records  ============================================ -->
168 <A NAME="Bot_Of_Page"></A>
169 </BODY></HTML>