openafs/doc/html/AdminReference/auarf131.htm
Derrick Brashear d7da1acc31 initial-html-documentation-20010606
pull in all documentation from IBM
2001-06-06 19:09:07 +00:00

170 lines
9.0 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
<HTML><HEAD>
<TITLE>Administration Reference</TITLE>
<!-- Begin Header Records ========================================== -->
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
</HEAD><BODY>
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
<BODY bgcolor="ffffff">
<!-- End Header Records ============================================ -->
<A NAME="Top_Of_Page"></A>
<H1>Administration Reference</H1>
<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>
<P>
<H2><A NAME="HDRFS_INTRO" HREF="auarf002.htm#ToC_145">fs</A></H2>
<A NAME="IDX4715"></A>
<A NAME="IDX4716"></A>
<A NAME="IDX4717"></A>
<A NAME="IDX4718"></A>
<A NAME="IDX4719"></A>
<P><STRONG>Purpose</STRONG>
<P>Introduction to the <B>fs</B> command suite
<P><STRONG>Description</STRONG>
<P>The commands in the <B>fs</B> command suite constitute the main
administrative interface to the Cache Manager on an AFS client machine, which
is responsible for fetching AFS data from file server machines on behalf of
applications running on the client machine.
<P>There are several categories of commands in the <B>fs</B> command
suite:
<UL>
<P><LI>Commands to set and report how the Cache Manager interacts with server
machines: <B>fs checkservers</B>, <B>fs getcellstatus</B>,
<B>fs getserverprefs</B>, <B>fs listcells</B>, <B>fs newcell</B>,
<B>fs setcell</B>,
<P><B>fs setserverprefs</B>, <B>fs sysname</B>, and <B>fs
wscell</B>
<P><LI>Commands to administer access control lists (ACLs): <B>fs
cleanacl</B>, <B>fs copyacl</B>, <B>fs listacl</B>, and <B>fs
setacl</B>
<P><LI>Commands to administer server machines, volumes or partitions that house a
given file or directory: <B>fs diskfree</B>, <B>fs examine</B>,
<B>fs listquota</B>, <B>fs quota</B>, <B>fs setquota</B>, <B>fs
setvol</B>,
<P><B>fs whereis</B>, and <B>fs whichcell</B>
<P><LI>Commands to administer the local client cache and related
information: <B>fs checkvolumes</B>, <B>fs flush</B>, <B>fs
flushvolume</B>, <B>fs getcacheparms</B>, and <B>fs setcachesize</B>
<P><LI>Commands to administer volume mount points: <B>fs lsmount</B>,
<B>fs mkmount</B>, and <B>fs rmmount</B>
<P><LI>Commands to control monitoring and tracing: <B>fs debug</B>, and
<B>fs messages</B>
<P><LI>A command to administer the Cache Manager's interaction with other
file systems: <B>fs exportafs</B>
<P><LI>Commands to obtain help: <B>fs apropos</B> and <B>fs
help</B>
</UL>
<P>The Cache Manager and the <B>fs</B> commands use and maintain the
following configuration files:
<UL>
<P><LI>The <B>/usr/vice/etc/CellServDB</B> file lists the database server
machines in the local cell and any foreign cell to which the administrator
wishes to enable AFS access for users working on the machine. The
database server machines run the Authentication, Backup, Protection and Volume
Location (VL) Server processes, which maintain databases of administrative
information. For users to access a cell, its
<B>root.cell</B> volume must also be mounted in the local
cell's AFS file tree.
<P><LI>The <B>/usr/vice/etc/ThisCell</B> file defines the machine's cell
membership with respect to the AFS command suites and Cache Manager access to
AFS data.
<P><LI>The <B>/usr/vice/etc/cacheinfo</B> file defines configuration
parameters for the cache, including its size and whether it is in memory or on
disk.
</UL>
<P>In addition, the Cache Manager automatically creates files on the cache
partition (by default, <B>/usr/vice/cache</B> for caching and tracking
files fetched from file server machines.
<P>For more details, see the reference page for each file.
<P><STRONG>Options</STRONG>
<P>The following flag is available on every command in the <B>fs</B>
suite. The reference page for each command also lists it, but it is
described here in greater detail.
<A NAME="IDX4720"></A>
<A NAME="IDX4721"></A>
<A NAME="IDX4722"></A>
<DL>
<P><DT><B>-help
</B><DD>Prints a command's online help message on the standard output
stream. Do not combine this flag with any of the command's other
options; when it is provided, the command interpreter ignores all other
options, and only prints the help message.
</DL>
<P><STRONG>Privilege Required</STRONG>
<A NAME="IDX4723"></A>
<A NAME="IDX4724"></A>
<P>The privileges required for <B>fs</B> commands vary more than for other
command suites. Pay special attention to the <B>Privilege
Required</B> section of each command description.
<P>The various types of necessary privilege include:
<UL>
<P><LI>Having permissions on a directory's ACL. For example, creating
and removing mount points requires <B>a</B> (<B>administer</B>),
<B>i</B> (<B>insert</B>), and <B>d</B> (<B>delete</B>)
permissions on the ACL of the directory in which the mount point
resides.
<P><LI>Being logged onto the machine as the local superuser
<B>root</B>. This is necessary when issuing commands that affect
Cache Manager configuration.
<P><LI>Belonging to the <B>system:administrators</B> group in the
Protection Database.
<P><LI>No privilege. Many <B>fs</B> commands simply list
information.
</UL>
<P><STRONG>Related Information</STRONG>
<P><A HREF="auarf017.htm#HDRCACHEITEMS">CacheItems</A>
<P><A HREF="auarf019.htm#HDRCLI_CSDB">CellServDB (client version)</A>
<P><A HREF="auarf032.htm#HDRCLI_THISCELL">ThisCell (client version)</A>
<P><A HREF="auarf036.htm#HDRVN">V<I>n</I></A>
<P><A HREF="auarf040.htm#HDRVOLUMEITEMS">VolumeItems</A>
<P><A HREF="auarf043.htm#HDRCACHEINFO">cacheinfo</A>
<P><A HREF="auarf132.htm#HDRFS_APROPOS">fs apropos</A>
<P><A HREF="auarf133.htm#HDRFS_CHECKSERVERS">fs checkservers</A>
<P><A HREF="auarf134.htm#HDRFS_CHECKVOLUMES">fs checkvolumes</A>
<P><A HREF="auarf135.htm#HDRFS_CLEANACL">fs cleanacl</A>
<P><A HREF="auarf136.htm#HDRFS_COPYACL">fs copyacl</A>
<P><A HREF="auarf137.htm#HDRFS_DISKFREE">fs diskfree</A>
<P><A HREF="auarf138.htm#HDRFS_EXAMINE">fs examine</A>
<P><A HREF="auarf139.htm#HDRFS_EXPORTAFS">fs exportafs</A>
<P><A HREF="auarf140.htm#HDRFS_FLUSH">fs flush</A>
<P><A HREF="auarf141.htm#HDRFS_FLUSHMOUNT">fs flushmount</A>
<P><A HREF="auarf142.htm#HDRFS_FLUSHVOLUME">fs flushvolume</A>
<P><A HREF="auarf143.htm#HDRFS_GETCACHEPARMS">fs getcacheparms</A>
<P><A HREF="auarf144.htm#HDRFS_GETCELLSTATUS">fs getcellstatus</A>
<P><A HREF="auarf145.htm#HDRFS_GETCLIENTADDRS">fs getclientaddrs</A>
<P><A HREF="auarf146.htm#HDRFS_GETSERVERPREFS">fs getserverprefs</A>
<P><A HREF="auarf147.htm#HDRFS_HELP">fs help</A>
<P><A HREF="auarf148.htm#HDRFS_LISTACL">fs listacl</A>
<P><A HREF="auarf149.htm#HDRFS_LISTCELLS">fs listcells</A>
<P><A HREF="auarf150.htm#HDRFS_LISTQUOTA">fs listquota</A>
<P><A HREF="auarf151.htm#HDRFS_LSMOUNT">fs lsmount</A>
<P><A HREF="auarf152.htm#HDRFS_MESSAGES">fs messages</A>
<P><A HREF="auarf153.htm#HDRFS_MKMOUNT">fs mkmount</A>
<P><A HREF="auarf154.htm#HDRFS_NEWCELL">fs newcell</A>
<P><A HREF="auarf155.htm#HDRFS_QUOTA">fs quota</A>
<P><A HREF="auarf156.htm#HDRFS_RMMOUNT">fs rmmount</A>
<P><A HREF="auarf157.htm#HDRFS_SETACL">fs setacl</A>
<P><A HREF="auarf158.htm#HDRFS_SETCACHESIZE">fs setcachesize</A>
<P><A HREF="auarf159.htm#HDRFS_SETCELL">fs setcell</A>
<P><A HREF="auarf160.htm#HDRFS_SETCLIENTADDRS">fs setclientaddrs</A>
<P><A HREF="auarf161.htm#HDRFS_SETQUOTA">fs setquota</A>
<P><A HREF="auarf162.htm#HDRFS_SETSERVERPREFS">fs setserverprefs</A>
<P><A HREF="auarf163.htm#HDRFS_SETVOL">fs setvol</A>
<P><A HREF="auarf164.htm#HDRFS_STOREBEHIND">fs storebehind</A>
<P><A HREF="auarf165.htm#HDRFS_SYSNAME">fs sysname</A>
<P><A HREF="auarf166.htm#HDRFS_WHEREIS">fs whereis</A>
<P><A HREF="auarf167.htm#HDRFS_WHICHCELL">fs whichcell</A>
<P><A HREF="auarf168.htm#HDRFS_WSCELL">fs wscell</A>
<P>
<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>
<!-- Begin Footer Records ========================================== -->
<P><HR><B>
<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
</B>
<!-- End Footer Records ============================================ -->
<A NAME="Bot_Of_Page"></A>
</BODY></HTML>