admin-doc-sysname-20040713
[openafs.git] / doc / html / AdminReference / auarf163.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="auarf162.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="auarf164.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_SETVOL" HREF="auarf002.htm#ToC_177">fs setvol</A></H2>
19 <A NAME="IDX4978"></A>
20 <A NAME="IDX4979"></A>
21 <A NAME="IDX4980"></A>
22 <A NAME="IDX4981"></A>
23 <A NAME="IDX4982"></A>
24 <A NAME="IDX4983"></A>
25 <A NAME="IDX4984"></A>
26 <P><STRONG>Purpose</STRONG>
27 <P>Set maximum quota and messages for the volume containing a file or
28 directory
29 <P><STRONG>Synopsis</STRONG>
30 <PRE><B>fs setvol</B> [<B>-path</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-max</B> &lt;<VAR>disk&nbsp;space&nbsp;quota&nbsp;in&nbsp;1K&nbsp;units</VAR>>]
31           [<B>-offlinemsg</B> &lt;<VAR>offline&nbsp;message</VAR>>]  [<B>-help</B>]
32    
33 <B>fs setv</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-ma</B> &lt;<VAR>disk&nbsp;space&nbsp;quota&nbsp;in&nbsp;1K&nbsp; units</VAR>>] 
34         [<B>-o</B> &lt;<VAR>offline&nbsp;message</VAR>>]  [<B>-h</B>]
35     
36 <B>fs sv</B> [<B>-p</B> &lt;<VAR>dir/file&nbsp;path</VAR>><SUP>+</SUP>]  [<B>-ma</B> &lt;<VAR>disk&nbsp;space&nbsp;quota&nbsp;in&nbsp;1K&nbsp;units</VAR>>] 
37       [<B>-o</B> &lt;<VAR>offline&nbsp;message</VAR>>]  [<B>-h</B>]
38 </PRE>
39 <P><STRONG>Description</STRONG>
40 <P>The <B>fs setvol</B> command sets the quota (maximum possible size) of
41 the read/write volume that contains each directory or file named by the
42 <B>-path</B> argument. To associate a message with the volume which
43 then appears in the output of the <B>fs examine</B> command, include the
44 <B>-offlinemsg</B> argument.
45 <P>To display all of the settings made with this command, use the <B>fs
46 examine</B> command. The <B>fs listquota</B> command reports a
47 fileset's quota, and the <B>fs quota</B> command the percent of quota
48 used.
49 <P>To set quota on one volume at a time, use the <B>fs setquota</B>
50 command.
51 <P><STRONG>Options</STRONG>
52 <DL>
53 <P><DT><B>-path
54 </B><DD>Names each file or directory for which to set the host volume's quota
55 and offline message. Partial pathnames are interpreted relative to the
56 current working directory, which is also the default value if this argument is
57 omitted.
58 <P>Specify the read/write path to the file or directory, to avoid the failure
59 that results from attempting to change a read-only volume. By
60 convention, the read/write path is indicated by placing a period before the
61 cell name at the pathname's second level (for example,
62 <B>/afs/.abc.com</B>). For further discussion of the
63 concept of read/write and read-only paths through the filespace, see the
64 <B>fs mkmount</B> reference page.
65 <P><DT><B>-max
66 </B><DD>Sets the maximum amount of file server disk space the volume can
67 occupy. Provide a positive integer to indicate the number of
68 one-kilobyte blocks (<B>1024</B> is one megabyte). A value of
69 <B>0</B> sets an unlimited quota, but the size of the disk partition that
70 houses the volume places an absolute limit on the volume's size.
71 <P>If the <B>-path</B> argument is omitted (so that the command sets the
72 quota of the volume housing the current working directory), the
73 <B>-max</B> switch must be provided.
74 <P><DT><B><B>-offlinemsg</B>
75 </B><DD>Associates a message with the volume which then appears in the output of
76 the <B>fs examine</B> command. Its intended use is to explain why
77 the volume is currently offline.
78 <P><DT><B>-help
79 </B><DD>Prints the online help for this command. All other valid options
80 are ignored.
81 </DL>
82 <P><STRONG>Examples</STRONG>
83 <P>The following command imposes a 6500 kilobyte quota on the volumes mounted
84 at the home directories <B>/afs/abc.com/usr/smith</B> and
85 <B>/afs/abc.com/usr/pat</B>:
86 <PRE>   % <B>cd /afs/abc.com/usr</B>
87     
88    % <B>fs setvol -path smith pat -max 6500</B><B></B>
89    
90 </PRE>
91 <P><STRONG>Privilege Required</STRONG>
92 <P>The issuer must belong to the <B>system:administrators</B>
93 group.
94 <P><STRONG>Related Information</STRONG>
95 <P><A HREF="auarf138.htm#HDRFS_EXAMINE">fs examine</A>
96 <P><A HREF="auarf150.htm#HDRFS_LISTQUOTA">fs listquota</A>
97 <P><A HREF="auarf153.htm#HDRFS_MKMOUNT">fs mkmount</A>
98 <P><A HREF="auarf155.htm#HDRFS_QUOTA">fs quota</A>
99 <P><A HREF="auarf161.htm#HDRFS_SETQUOTA">fs setquota</A>
100 <P>
101 <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="auarf162.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="auarf164.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> 
102 <!-- Begin Footer Records  ========================================== -->
103 <P><HR><B> 
104 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
105 </B> 
106 <!-- End Footer Records  ============================================ -->
107 <A NAME="Bot_Of_Page"></A>
108 </BODY></HTML>