doc/man-pages/pod1/vos_setfields.pod

   1 =head1 NAME
   2
   3 vos_setfields - Sets the quota or clear the access counter on a volume.
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos setfields> S<<< B<-id> <I<volume name or ID>> >>>
  11     S<<< B<-maxquota> <I<quota>> >>> [B<-clearuse>]
  12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
  13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  14
  15 B<vos se> S<<< B<-id> <I<volume name or ID>> >>>
  16     S<<< B<-maxquota> <I<quota>> >>> [B<-clearuse>]
  17     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
  18     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  19
  20 =for html
  21 </div>
  22
  23 =head1 DESCRIPTION
  24
  25 The B<vos setfields> command can set the quota on a volume, and it can
  26 clear the access counter on a volume. This command differs from
  27 B<fs setquota> because only the volume name is needed to set the quota,
  28 whereas the path to the volume is needed with B<fs setquota>.
  29
  30 If the B<-maxquota> and B<-clearuse> flags are missing, then no action is
  31 taken.
  32
  33 =head1 CAUTIONS
  34
  35 This command is not effective on read-only or backup volumes.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-id> <I<volume name or id>>
  42
  43 Identifies the volume on which to operate, either by its complete name or
  44 volume ID number.
  45
  46 =item B<-maxquota> <I<quota>>
  47
  48 Sets the maximum amount of file server disk space the volume can occupy.
  49 The quota should be a positive integer followed by an optional suffix:
  50 C<K> for kibibytes (1024 bytes, the default), C<M> for mebibytes (1024
  51 kibibytes), C<G> for gibibytes (1024 mebibytes), and C<T> for tebibytes
  52 (1024 gibibytes).  A value of C<0> sets an unlimited quota, but the size
  53 of the disk partition that houses the volume places an absolute limit on
  54 the volume's size.
  55
  56 =item B<-clearuse>
  57
  58 Clears the access counter on a volumes, which is shown as C<X accesses in
  59 the past day (i.e., vnode references)> in the B<vos examine> output.
  60
  61 =item B<-cell> <I<cell name>>
  62
  63 Names the cell in which to run the command. Do not combine this argument
  64 with the B<-localauth> flag. For more details, see L<vos(1)>.
  65
  66 =item B<-noauth>
  67
  68 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  69 combine this flag with the B<-localauth> flag. For more details, see
  70 L<vos(1)>.
  71
  72 =item B<-localauth>
  73
  74 Constructs a server ticket using a key from the local
  75 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  76 to the Volume Server and Volume Location Server during mutual
  77 authentication. Do not combine this flag with the B<-cell> argument or
  78 B<-noauth> flag. For more details, see L<vos(1)>.
  79
  80 =item B<-encrypt>
  81
  82 Encrypts the command so that the operation's results are not transmitted
  83 across the network in clear text.
  84
  85 =item B<-noresolve>
  86
  87 Shows all servers as IP addresses instead of the DNS name. This is very
  88 useful when the server address is registered as 127.0.0.1 or when dealing
  89 with multi-homed servers. The B<-noresolve> option is available in OpenAFS
  90 versions 1.4.8 or later and 1.5.35 or later.
  91
  92 =item B<-verbose>
  93
  94 Produces on the standard output stream a detailed trace of the command's
  95 execution. If this argument is omitted, only warnings and error messages
  96 appear.
  97
  98 =item B<-help>
  99
 100 Prints the online help for this command. All other valid options are
 101 ignored.
 102
 103 =back
 104
 105 =head1 OUTPUT
 106
 107 This command produces no output other than error messages.
 108
 109 =head1 EXAMPLES
 110
 111 To set a 123KB quota on the root.cell volume, the following command may be
 112 used:
 113
 114    % vos setfields -id root.cell -maxquota 123
 115
 116 To clear the access counter on the root.cell volume, use the following
 117 command:
 118
 119    % vos setfields -id root.cell -clearuse
 120
 121 The above commands may be combined as follows:
 122
 123    % vos setfields -id root.cell -maxquota 123 -clearuse
 124
 125 =head1 PRIVILEGE REQUIRED
 126
 127 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 128 machine specified with the B<-server> argument and on each database server
 129 machine. If the B<-localauth> flag is included, the issuer must instead be
 130 logged on to a server machine as the local superuser C<root>.
 131
 132 =head1 SEE ALSO
 133
 134 L<fs_setquota(1)>,
 135 L<vos(1)>,
 136 L<vos_examine(1)>
 137
 138 =head1 COPYRIGHT
 139
 140 Copyright 2009 Jason Edgecombe <jason@rampaginggeek.com>
 141
 142 This documentation is covered by the BSD License as written in the
 143 doc/LICENSE file. This man page was written by Jason Edgecombe for
 144 OpenAFS.