3 fs - Introduction to the fs command suite
7 The commands in the fs command suite constitute the main
8 administrative interface to the Cache Manager on an AFS client machine, which
9 is responsible for fetching AFS data from file server machines on behalf of
10 applications running on the client machine.
12 There are several categories of commands in the fs command
19 Commands to set and report how the Cache Manager interacts with server
20 machines: B<fs checkservers>, B<fs getcellstatus>,
21 B<fs getserverprefs>, B<fs listcells>, B<fs newcell>,
25 B<fs setserverprefs>, B<fs sysname>, and fs
30 Commands to administer access control lists (ACLs): fs
31 cleanacl, B<fs copyacl>, B<fs listacl>, and B<fs
37 Commands to administer server machines, volumes or partitions that house a
38 given file or directory: B<fs diskfree>, B<fs examine>,
39 B<fs listquota>, B<fs quota>, B<fs setquota>, B<fs
43 B<fs whereis>, and fs whichcell
47 Commands to administer the local client cache and related
48 information: B<fs checkvolumes>, B<fs flush>, B<fs
49 flushvolume>, B<fs getcacheparms>, and B<fs setcachesize>
54 Commands to administer volume mount points: fs lsmount,
55 B<fs mkmount>, and B<fs rmmount>
60 Commands to control monitoring and tracing: fs debug, and
66 A command to administer the Cache Manager's interaction with other
67 file systems: B<fs exportafs>
72 Commands to obtain help: B<fs apropos> and fs
78 The Cache Manager and the fs commands use and maintain the
79 following configuration files:
85 The /usr/vice/etc/CellServDB file lists the database server
86 machines in the local cell and any foreign cell to which the administrator
87 wishes to enable AFS access for users working on the machine. The
88 database server machines run the Authentication, Backup, Protection and Volume
89 Location (VL) Server processes, which maintain databases of administrative
90 information. For users to access a cell, its
91 B<root.cell> volume must also be mounted in the local
97 The /usr/vice/etc/ThisCell file defines the machine's cell
98 membership with respect to the AFS command suites and Cache Manager access to
104 The /usr/vice/etc/cacheinfo file defines configuration
105 parameters for the cache, including its size and whether it is in memory or on
111 In addition, the Cache Manager automatically creates files on the cache
112 partition (by default, B</usr/vice/cache> for caching and tracking
113 files fetched from file server machines.
115 For more details, see the reference page for each file.
119 The following flag is available on every command in the fs
120 suite. The reference page for each command also lists it, but it is
121 described here in greater detail.
130 Prints a command's online help message on the standard output
131 stream. Do not combine this flag with any of the command's other
132 options; when it is provided, the command interpreter ignores all other
133 options, and only prints the help message.
137 =head1 PRIVILEGE REQUIRED
139 The privileges required for fs commands vary more than for other
140 command suites. Pay special attention to the B<Privilege
141 Required> section of each command description.
143 The various types of necessary privilege include:
149 Having permissions on a directory's ACL. For example, creating
150 and removing mount points requires B<a> (B<administer>),
151 B<i> (B<insert>), and B<d> (B<delete>)
152 permissions on the ACL of the directory in which the mount point
158 Being logged onto the machine as the local superuser
159 B<root>. This is necessary when issuing commands that affect
160 Cache Manager configuration.
165 Belonging to the system:administrators group in the
171 No privilege. Many fs commands simply list
180 L<CellServDB (client version)(1)>
182 L<ThisCell (client version)(1)>
188 L<fs_checkservers(1)>,
189 L<fs_checkvolumes(1)>,
197 L<fs_flushvolume(1)>,
198 L<fs_getcacheparms(1)>,
199 L<fs_getcellstatus(1)>,
200 L<fs_getclientaddrs(1)>,
201 L<fs_getserverprefs(1)>,
213 L<fs_setcachesize(1)>,
215 L<fs_setclientaddrs(1)>,
217 L<fs_setserverprefs(1)>,
219 L<fs_storebehind(1)>,
227 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
229 This documentation is covered by the IBM Public License Version 1.0. It was
230 converted from HTML to POD by software written by Chas Williams and Russ
231 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.