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