src/WINNT/doc/install/Documentation/en_US/html/CmdRef/auarf164.htm

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN">
   2 <HTML><HEAD>
   3 <TITLE>Administration Reference</TITLE>
   4 <!-- Begin Header Records  ========================================== -->
   5 <!-- /tmp/idwt3190/auarf000.scr converted by idb2h R4.2 (359) ID      -->
   6 <!-- Workbench Version (AIX) on 5 Nov 1999 at 13:58:29                -->
   7 <META HTTP-EQUIV="updated" CONTENT="Fri, 05 Nov 1999 13:58:29">
   8 <META HTTP-EQUIV="review" CONTENT="Sun, 05 Nov 2000 13:58:29">
   9 <META HTTP-EQUIV="expires" CONTENT="Mon, 05 Nov 2001 13:58: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="auarf163.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="auarf165.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_STOREBEHIND" HREF="auarf002.htm#ToC_178">fs storebehind</A></H2>
  19 <A NAME="IDX4985"></A>
  20 <A NAME="IDX4986"></A>
  21 <P><STRONG>Purpose</STRONG>
  22 <P>Enables asynchronous writes to the file server
  23 <P><STRONG>Synopsis</STRONG>
  24 <PRE><B>fs storebehind</B> [<B>-kbytes</B> &lt;<VAR>asynchrony&nbsp;for&nbsp;specified&nbsp;names</VAR>>]
  25                [<B>-files</B> &lt;<VAR>specific&nbsp;pathnames</VAR>><SUP>+</SUP>]
  26                [<B>-allfiles</B> &lt;<VAR>new&nbsp;default&nbsp;(KB)</VAR>>]  [<B>-verbose</B>]  [<B>-help</B>]
  27
  28 <B>fs st</B> [<B>-k</B> &lt;<VAR>asynchrony&nbsp;for&nbsp;specified&nbsp;names</VAR>>]  [<B>-f</B> &lt;<VAR>specific&nbsp;pathnames</VAR>><SUP>+</SUP>]
  29       [<B>-a</B> &lt;<VAR>new&nbsp;default&nbsp;(KB)</VAR>>]  [<B>-v</B>]  [<B>-h</B>]
  30 </PRE>
  31 <P><STRONG>Description</STRONG>
  32 <P>The <B>fs storebehind</B> command enables the Cache Manager to perform
  33 a delayed asynchronous write to the File Server when an application closes a
  34 file. By default, the Cache Manager writes all data to the File Server
  35 immediately and synchronously when an application program closes a
  36 file--that is, the <B>close</B> system call does not return until the
  37 Cache Manager has actually transferred the final chunk of the file to the File
  38 Server. This command specifies the number of kilobytes of a file that
  39 can still remain to be written to the File Server when the Cache Manager
  40 returns control to the application. It is useful if users working on
  41 the machine commonly work with very large files, but also introduces the
  42 complications discussed in the <B>Cautions</B> section.
  43 <P>Set either or both of the following in a single command&#58;
  44 <UL>
  45 <P><LI>To set a value that applies to all AFS files manipulated by applications
  46 running on the machine, use the <B>-allfiles</B> argument. This
  47 value is termed the <I>default store asynchrony</I> for the machine, and
  48 persists until the machine reboots. If it is not set, the default value
  49 is zero, indicating that the Cache Manager performs synchronous writes.
  50 <P>
  51 <P>As an example, the following setting means that when an application closes
  52 a file, the Cache Manager can return control to the application as soon as no
  53 more than 10 kilobytes of the file remain to be written to the File
  54 Server.
  55 <PRE>   <B>-allfiles 10</B>
  56
  57 </PRE>
  58 <P><LI>To set a value that applies to one or more individual files, and overrides
  59 the value of the <B>-allfiles</B> argument for them, combine the
  60 <B>-kbytes</B> and <B>-files</B> arguments. The setting
  61 persists as long as there is an entry for the file in the kernel table that
  62 the Cache Manager uses to track certain information about files. In
  63 general, such an entry persists at least until an application closes the file
  64 or exits, but the Cache Manager is free to recycle the entry if the file is
  65 inactive and it needs to free up slots in the table. To increase the
  66 certainty that there is an entry for the file in the table, issue the <B>fs
  67 storebehind</B> command shortly before closing the file.
  68 <P>As an example, the following setting means that when an application closes
  69 either of the files <B>bigfile</B> and <B>biggerfile</B>, the Cache
  70 Manager can return control to the application as soon as no more than a
  71 megabyte of the file remains to be written to the File Server.
  72 <PRE>   <B>-kbytes 1024 -files bigfile biggerfile</B>
  73
  74 </PRE>
  75 <P>Note that once an explicit value has been set for a file, the only way to
  76 make it subject to the default store asynchrony once again is to set
  77 <B>-kbytes</B> to that value. In other words, there is no
  78 combination of arguments that automatically makes a file subject to the
  79 default store asynchrony once another value has been set for the file.
  80 </UL>
  81 <P>To display the settings that currently apply to individual files or to all
  82 files, provide the command&#39;s arguments in certain combinations as
  83 specified in the <B>Output</B> section of this reference page.
  84 <P><STRONG>Cautions</STRONG>
  85 <P>For the following reasons, use of this command is not recommended in most
  86 cases.
  87 <P>In normal circumstances, an asynchronous setting results in the Cache
  88 Manager returning control to applications earlier than it otherwise does, but
  89 this is not guaranteed.
  90 <P>If a delayed write fails, there is no way to notify the application, since
  91 the <B>close</B> system call has already returned with a code indicating
  92 success.
  93 <P>Writing asynchronously increases the possibility that the user will not
  94 notice if a write operation makes the volume that houses the file exceed its
  95 quota. As always, the portion of the file that exceeds the
  96 volume&#39;s quota is lost, which prompts a message such as the
  97 following&#58;
  98 <PRE>   No space left on device
  99
 100 </PRE>
 101 <P>To avoid losing data, it is advisable to verify that the volume housing the
 102 file has space available for the amount of data anticipated to be
 103 written.
 104 <P><STRONG>Options</STRONG>
 105 <DL>
 106 <P><DT><B>-kbytes
 107 </B><DD>Specifies the number of kilobytes of data from each file named by the
 108 <B>-files</B> argument that can remain to be written to the file server
 109 when the Cache Manager returns control to an application program that closed
 110 the file. The <B>-files</B> argument is required along with this
 111 argument. Provide an integer from the range <B>0</B> (which
 112 reinstates the Cache Manager&#39;s default behavior or writing synchronously)
 113 to the maximum AFS file size.
 114 <P><DT><B>-files
 115 </B><DD>Names each file to which the value set with the <B>-kbytes</B>
 116 argument applies. The setting persists as long as there is an entry for
 117 the file in the kernel table that the Cache Manager uses to track certain
 118 information about files. Because closing a file generally erases the
 119 entry, when reopening a file the only way to guarantee that the setting still
 120 applies is to reissue the command. If this argument is provided without
 121 the <B>-kbytes</B> argument, the command reports the current setting for
 122 the specified files, and the default store asynchrony.
 123 <P><DT><B>-allfiles
 124 </B><DD>Sets the default store asynchrony for the local machine, which is the
 125 number of kilobytes of data that can remain to be written to the file server
 126 when the Cache Manager returns control to the application program that closed
 127 a file. The value applies to all AFS files manipulated by applications
 128 running on the machine, except those for which settings have been made with
 129 the <B>-kbytes</B> and <B>-files</B> arguments. Provide an
 130 integer from the range <B>0</B> (which indicates the default of
 131 synchronous writes) to the maximum AFS file size.
 132 <P><DT><B>-verbose
 133 </B><DD>Produces output confirming the settings made with the accompanying
 134 <B>-kbytes</B> and <B>-files</B> arguments, the <B>-allfiles</B>
 135 argument, or all three. If provided by itself, reports the current
 136 default store asynchrony.
 137 <P><DT><B>-help
 138 </B><DD>Prints the online help for this command. All other valid options
 139 are ignored.
 140 </DL>
 141 <P><STRONG>Output</STRONG>
 142 <P>If none of the command&#39;s options are included, or if only the
 143 <B>-verbose</B> flag is included, the following message reports the
 144 default store asynchrony (the setting that applies to all files manipulated by
 145 applications running on the local machine and for which not more specific
 146 asynchrony is set).
 147 <PRE>   Default store asynchrony is <VAR>x</VAR> kbytes.
 148
 149 </PRE>
 150 <P>A value of <TT>0</TT> (zero) indicates synchronous writes and is the
 151 default if no one has included the <B>-allfiles</B> argument on this
 152 command since the machine last rebooted.
 153 <P>If the <B>-files</B> argument is provided without the
 154 <B>-kbytes</B> argument, the output reports the value that applies to each
 155 specified file along with the default store asynchrony. If a particular
 156 value has previously been set for a file, the following message reports
 157 it&#58;
 158 <PRE>   Will store up to <VAR>y</VAR> kbytes of <VAR>file</VAR> asynchronously.
 159    Default store asynchrony is <VAR>x</VAR> kbytes.
 160
 161 </PRE>
 162 <P>If the default store asynchrony applies to a file because no explicit
 163 <B>-kbytes</B> value has been set for it, the message is instead as
 164 follows&#58;
 165 <PRE>   Will store <VAR>file</VAR> according to default.
 166    Default store asynchrony is <VAR>x</VAR> kbytes.
 167
 168 </PRE>
 169 <P>If the <B>-verbose</B> flag is combined with arguments that set values
 170 (<B>-files</B> and <B>-kbytes</B>, or <B>-allfiles</B>, or all
 171 three), there is a message that confirms immediately that the setting has
 172 taken effect. When included without other arguments or flags, the
 173 <B>-verbose</B> flag reports the default store asynchrony only.
 174 <P><STRONG>Examples</STRONG>
 175 <P>The following command enables the Cache Manager to return control to the
 176 application program that closed the file <B>test.data</B> when 100
 177 kilobytes still remain to be written to the File Server. The
 178 <B>-verbose</B> flag produces output that confirms the new setting, and
 179 that the default store asynchrony is zero.
 180 <PRE>   % <B>fs storebehind -kbytes 100 -files test.data -verbose</B>
 181    Will store up to 100 kbytes of test.data asynchronously.
 182    Default store asynchrony is 0 kbytes.
 183
 184 </PRE>
 185 <P><STRONG>Privilege Required</STRONG>
 186 <P>To include the <B>-allfiles</B> argument, the issuer must be logged in
 187 as the local superuser <B>root</B>.
 188 <P>To include the <B>-kbytes</B> and <B>-files</B> arguments, the
 189 issuer must either be logged in as the local superuser <B>root</B> or have
 190 the <B>w</B> (<B>write</B>) permission on the ACL of each file&#39;s
 191 directory.
 192 <P>To view the current settings (by including no arguments, the
 193 <B>-file</B> argument alone, or the <B>-verbose</B> argument alone),
 194 no privilege is required.
 195 <P><STRONG>Related Information</STRONG>
 196 <P><A HREF="auarf058.htm#HDRAFSD">afsd</A>
 197 <P>
 198 <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="auarf163.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="auarf165.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>
 199 <!-- Begin Footer Records  ========================================== -->
 200 <P><HR><B>
 201 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved
 202 </B>
 203 <!-- End Footer Records  ============================================ -->
 204 <A NAME="Bot_Of_Page"></A>
 205 </BODY></HTML>