doc/xml/AdminReference/sect1/fs.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="fs1">
   3   <refmeta>
   4     <refentrytitle>fs</refentrytitle>
   5     <manvolnum>1</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>fs</refname>
   9     <refpurpose>Introduction to the fs command suite</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Description</title>
  13     <para>The commands in the <emphasis role="bold">fs</emphasis> command suite constitute the main administrative
  14     interface to the Cache Manager on an AFS client machine, which is
  15     responsible for fetching AFS data from file server machines on behalf of
  16     applications running on the client machine.</para>
  17
  18     <para>There are several categories of commands in the <emphasis role="bold">fs</emphasis> command suite:</para>
  19
  20     <itemizedlist>
  21       <listitem>
  22         <para>Commands to set and report how the Cache Manager interacts with server
  23         machines: <emphasis role="bold">fs checkservers</emphasis>, <emphasis role="bold">fs getcellstatus</emphasis>, <emphasis role="bold">fs getserverprefs</emphasis>,
  24         <emphasis role="bold">fs listcells</emphasis>, <emphasis role="bold">fs newcell</emphasis>, <emphasis role="bold">fs setcell</emphasis>, <emphasis role="bold">fs setserverprefs</emphasis>, <emphasis role="bold">fs
  25         sysname</emphasis>, and <emphasis role="bold">fs wscell</emphasis>.</para>
  26
  27       </listitem>
  28       <listitem>
  29         <para>Commands to administer access control lists (ACLs): <emphasis role="bold">fs cleanacl</emphasis>, <emphasis role="bold">fs
  30         copyacl</emphasis>, <emphasis role="bold">fs listacl</emphasis>, and <emphasis role="bold">fs setacl</emphasis>.</para>
  31
  32       </listitem>
  33       <listitem>
  34         <para>Commands to administer server machines, volumes or partitions that house a
  35         given file or directory: <emphasis role="bold">fs diskfree</emphasis>, <emphasis role="bold">fs examine</emphasis>, <emphasis role="bold">fs listquota</emphasis>,
  36         <emphasis role="bold">fs quota</emphasis>, <emphasis role="bold">fs setquota</emphasis>, <emphasis role="bold">fs setvol</emphasis>, <emphasis role="bold">fs whereis</emphasis>, and <emphasis role="bold">fs
  37         whichcell</emphasis>.</para>
  38
  39       </listitem>
  40       <listitem>
  41         <para>Commands to administer the local client cache and related information:
  42         <emphasis role="bold">fs checkvolumes</emphasis>, <emphasis role="bold">fs flush</emphasis>, <emphasis role="bold">fs flushvolume</emphasis>, <emphasis role="bold">fs getcacheparms</emphasis>,
  43         and <emphasis role="bold">fs setcachesize</emphasis>.</para>
  44
  45       </listitem>
  46       <listitem>
  47         <para>Commands to administer volume mount points: <emphasis role="bold">fs lsmount</emphasis>, <emphasis role="bold">fs mkmount</emphasis>,
  48         and <emphasis role="bold">fs rmmount</emphasis>.</para>
  49
  50       </listitem>
  51       <listitem>
  52         <para>Commands to control monitoring and tracing: <emphasis role="bold">fs debug</emphasis>, and <emphasis role="bold">fs
  53         messages</emphasis>.</para>
  54
  55       </listitem>
  56       <listitem>
  57         <para>A command to administer the Cache Manager's interaction with other
  58         file systems: <emphasis role="bold">fs exportafs</emphasis>.</para>
  59
  60       </listitem>
  61       <listitem>
  62         <para>Commands to obtain help: <emphasis role="bold">fs apropos</emphasis> and <emphasis role="bold">fs help</emphasis>.</para>
  63
  64       </listitem>
  65     </itemizedlist>
  66     <para>The Cache Manager and the fs commands use and maintain the following
  67     configuration files:</para>
  68
  69     <variablelist>
  70       <varlistentry>
  71         <term><replaceable>/usr/vice/etc/CellServDB</replaceable></term>
  72         <listitem>
  73           <para>Lists the database server machines in the local cell and any foreign cell
  74           to which the administrator wishes to enable AFS access for users working
  75           on the machine. The database server machines run the Authentication,
  76           Backup, Protection and Volume Location (VL) Server processes, which
  77           maintain databases of administrative information. For users to access a
  78           cell, its <computeroutput>root.cell</computeroutput> volume must also be mounted in the local cell's AFS
  79           file tree.</para>
  80
  81         </listitem>
  82       </varlistentry>
  83       <varlistentry>
  84         <term><replaceable>/usr/vice/etc/ThisCell</replaceable></term>
  85         <listitem>
  86           <para>Defines the machine's cell membership with respect to the AFS command
  87           suites and Cache Manager access to AFS data.</para>
  88
  89         </listitem>
  90       </varlistentry>
  91       <varlistentry>
  92         <term><replaceable>/usr/vice/etc/cacheinfo</replaceable></term>
  93         <listitem>
  94           <para>Defines configuration parameters for the cache, including its size and
  95           whether it is in memory or on disk.</para>
  96
  97         </listitem>
  98       </varlistentry>
  99     </variablelist>
 100     <para>In addition, the Cache Manager automatically creates files on the cache
 101     partition (by default, <replaceable>/usr/vice/cache</replaceable> for caching and tracking files
 102     fetched from file server machines.</para>
 103
 104     <para>For more details, see the reference page for each file.</para>
 105
 106   </refsect1>
 107   <refsect1>
 108     <title>Options</title>
 109     <para>The following flag is available on every command in the fs suite. The
 110     reference page for each command also lists it, but it is described here in
 111     greater detail.</para>
 112
 113     <variablelist>
 114       <varlistentry>
 115         <term><emphasis role="bold">-help</emphasis></term>
 116         <listitem>
 117           <para>Prints a command's online help message on the standard output stream. Do
 118           not combine this flag with any of the command's other options; when it is
 119           provided, the command interpreter ignores all other options, and only
 120           prints the help message.</para>
 121
 122         </listitem>
 123       </varlistentry>
 124     </variablelist>
 125   </refsect1>
 126   <refsect1>
 127     <title>Privilege Required</title>
 128     <para>The privileges required for fs commands vary more than for other command
 129     suites. Pay special attention to the PRIVILEGE REQUIRED section of each
 130     command description.</para>
 131
 132     <para>The various types of necessary privilege include:</para>
 133
 134     <itemizedlist>
 135       <listitem>
 136         <para>Having permissions on a directory's ACL. For example, creating and
 137         removing mount points requires <computeroutput>a</computeroutput> (administer), <computeroutput>i</computeroutput> (insert), and <computeroutput>d</computeroutput>
 138         (delete) permissions on the ACL of the directory in which the mount point
 139         resides.</para>
 140
 141       </listitem>
 142       <listitem>
 143         <para>Being logged onto the machine as the local superuser <computeroutput>root</computeroutput>. This is
 144         necessary when issuing commands that affect Cache Manager configuration.</para>
 145
 146       </listitem>
 147       <listitem>
 148         <para>Belonging to the system:administrators group in the Protection Database.</para>
 149
 150       </listitem>
 151       <listitem>
 152         <para>No privilege. Many <emphasis role="bold">fs</emphasis> commands simply list information.</para>
 153
 154       </listitem>
 155     </itemizedlist>
 156   </refsect1>
 157   <refsect1>
 158     <title>See Also</title>
 159     <para><link linkend="afs_cache5">afs_cache(5)</link>,
 160     <link linkend="CellServDB5">CellServDB(5)</link>,
 161     <link linkend="ThisCell5">ThisCell(5)</link>
 162     <link linkend="cacheinfo5">cacheinfo(5)</link>,
 163     <link linkend="fs_apropos1">fs_apropos(1)</link>,
 164     <link linkend="fs_checkservers1">fs_checkservers(1)</link>,
 165     <link linkend="fs_checkvolumes1">fs_checkvolumes(1)</link>,
 166     <link linkend="fs_cleanacl1">fs_cleanacl(1)</link>,
 167     <link linkend="fs_copyacl1">fs_copyacl(1)</link>,
 168     <link linkend="fs_diskfree1">fs_diskfree(1)</link>,
 169     <link linkend="fs_examine1">fs_examine(1)</link>,
 170     <link linkend="fs_exportafs1">fs_exportafs(1)</link>,
 171     <link linkend="fs_flush1">fs_flush(1)</link>,
 172     <link linkend="fs_flushmount1">fs_flushmount(1)</link>,
 173     <link linkend="fs_flushvolume1">fs_flushvolume(1)</link>,
 174     <link linkend="fs_getcacheparms1">fs_getcacheparms(1)</link>,
 175     <link linkend="fs_getcellstatus1">fs_getcellstatus(1)</link>,
 176     <link linkend="fs_getclientaddrs1">fs_getclientaddrs(1)</link>,
 177     <link linkend="fs_getserverprefs1">fs_getserverprefs(1)</link>,
 178     <link linkend="fs_help1">fs_help(1)</link>,
 179     <link linkend="fs_listacl1">fs_listacl(1)</link>,
 180     <link linkend="fs_listcells1">fs_listcells(1)</link>,
 181     <link linkend="fs_listquota1">fs_listquota(1)</link>,
 182     <link linkend="fs_lsmount1">fs_lsmount(1)</link>,
 183     <link linkend="fs_messages1">fs_messages(1)</link>,
 184     <link linkend="fs_mkmount1">fs_mkmount(1)</link>,
 185     <link linkend="fs_newcell1">fs_newcell(1)</link>,
 186     <link linkend="fs_quota1">fs_quota(1)</link>,
 187     <link linkend="fs_rmmount1">fs_rmmount(1)</link>,
 188     <link linkend="fs_setacl1">fs_setacl(1)</link>,
 189     <link linkend="fs_setcachesize1">fs_setcachesize(1)</link>,
 190     <link linkend="fs_setcell1">fs_setcell(1)</link>,
 191     <link linkend="fs_setclientaddrs1">fs_setclientaddrs(1)</link>,
 192     <link linkend="fs_setquota1">fs_setquota(1)</link>,
 193     <link linkend="fs_setserverprefs1">fs_setserverprefs(1)</link>,
 194     <link linkend="fs_setvol1">fs_setvol(1)</link>,
 195     <link linkend="fs_storebehind1">fs_storebehind(1)</link>,
 196     <link linkend="fs_sysname1">fs_sysname(1)</link>,
 197     <link linkend="fs_whereis1">fs_whereis(1)</link>,
 198     <link linkend="fs_whichcell1">fs_whichcell(1)</link>,
 199     <link linkend="fs_wscell1">fs_wscell(1)</link></para>
 200
 201   </refsect1>
 202   <refsect1>
 203     <title>Copyright</title>
 204     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 205
 206     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 207     converted from HTML to POD by software written by Chas Williams and Russ
 208     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 209
 210   </refsect1>
 211 </refentry>