doc/man-pages/pod1/fs_setvol.pod

   1 =head1 NAME
   2
   3 fs_setvol - Set quota and messages for a volume containing a file or directory
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fs setvol> S<<< [B<-path> <I<dir/file path>>+] >>>
  11     S<<< [B<-max> <I<disk space quota in 1K units>>] >>>
  12     S<<< [B<-offlinemsg> <I<offline message>>] >>> [B<-help>]
  13
  14 B<fs setv> S<<< [B<-p> <I<dir/file path>>+] >>>
  15     S<<< [B<-ma> <I<disk space quota in 1K units>>] >>>
  16     S<<< [B<-o> <I<offline message>>] >>> [B<-h>]
  17
  18 B<fs sv> S<<< [B<-p> <I<dir/file path>>+] >>>
  19     S<<< [B<-ma> <I<disk space quota in 1K units>>] >>>
  20     S<<< [B<-o> <I<offline message>>] >>> [B<-h>]
  21
  22 =for html
  23 </div>
  24
  25 =head1 DESCRIPTION
  26
  27 The B<fs setvol> command sets the quota (maximum possible size) of the
  28 read/write volume that contains each directory or file named by the
  29 B<-path> argument. To associate a message with the volume which then
  30 appears in the output of the B<fs examine> command, include the
  31 B<-offlinemsg> argument.
  32
  33 To display all of the settings made with this command, use the B<fs
  34 examine> command. The B<fs listquota> command reports a fileset's quota,
  35 and the B<fs quota> command the percent of quota used.
  36
  37 To set quota on one volume at a time, use the B<fs setquota> command.
  38
  39 =head1 CAUTIONS
  40
  41 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes)
  42 and the maximum size of a /vicepX partition on a fileserver is also 2
  43 terabytes. The fileserver will not report an error when it has access
  44 to a partition larger than 2 terabytes, but it will probably fail if
  45 the administrator attempts to use more than 2 terabytes of space. In
  46 addition, there are reports of erroneous disk usage numbers when
  47 B<vos partinfo> or other OpenAFS disk reporting tools are used with
  48 partitions larger than 2 terabytes.
  49
  50 =head1 OPTIONS
  51
  52 =over 4
  53
  54 =item B<-path> <I<dir/file path>>+
  55
  56 Names each file or directory for which to set the host volume's quota and
  57 offline message. Partial pathnames are interpreted relative to the current
  58 working directory, which is also the default value if this argument is
  59 omitted.
  60
  61 Specify the read/write path to the file or directory, to avoid the failure
  62 that results from attempting to change a read-only volume. By convention,
  63 the read/write path is indicated by placing a period before the cell name
  64 at the pathname's second level (for example, F</afs/.abc.com>). For
  65 further discussion of the concept of read/write and read-only paths
  66 through the filespace, see the B<fs mkmount> reference page.
  67
  68 =item B<-max> <I<disk space quota in 1K units>>
  69
  70 Sets the maximum amount of file server disk space the volume can
  71 occupy. Provide a positive integer to indicate the number of one-kilobyte
  72 blocks (C<1024> is one megabyte). A value of C<0> sets an unlimited quota,
  73 but the size of the disk partition that houses the volume places an
  74 absolute limit on the volume's size.
  75
  76 If the B<-path> argument is omitted (so that the command sets the quota of
  77 the volume housing the current working directory), the B<-max> switch must
  78 be provided.
  79
  80 =item B<-offlinemsg>
  81
  82 Associates a message with the volume which then appears in the output of
  83 the B<fs examine> command. Its intended use is to explain why the volume
  84 is currently offline.
  85
  86 =item B<-help>
  87
  88 Prints the online help for this command. All other valid options are
  89 ignored.
  90
  91 =back
  92
  93 =head1 EXAMPLES
  94
  95 The following command imposes a 6500 kilobyte quota on the volumes mounted
  96 at the home directories F</afs/abc.com/usr/smith> and
  97 F</afs/abc.com/usr/pat>:
  98
  99    % cd /afs/abc.com/usr
 100    % fs setvol -path smith pat -max 6500B<>
 101
 102 =head1 PRIVILEGE REQUIRED
 103
 104 The issuer must belong to the system:administrators group.
 105
 106 =head1 SEE ALSO
 107
 108 L<fs_examine(1)>,
 109 L<fs_listquota(1)>,
 110 L<fs_mkmount(1)>,
 111 L<fs_quota(1)>,
 112 L<fs_setquota(1)>
 113
 114 =head1 COPYRIGHT
 115
 116 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 117
 118 This documentation is covered by the IBM Public License Version 1.0.  It was
 119 converted from HTML to POD by software written by Chas Williams and Russ
 120 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.