doc/man-pages/pod1/vos_size.pod

   1 =head1 NAME
   2
   3 vos_size - Computes the size of a volume dump
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos size> S<<< [B<-id>] <I<volume name or id>> >>>
  11     S<<< [B<-partition> <I<partition name>>] >>>
  12     S<<< [B<-server> <I<machine name>>] >>>
  13     [B<-dump>] S<<< [B<-time> <I<dump from time>>] >>>
  14     S<<< [B<-cell> <I<cell name>>] >>>
  15     [B<-noauth>] [B<-localauth>]
  16     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
  17
  18 B<vos si> S<<< [B<-i>] <I<volume name or id>> >>>
  19     S<<< [B<-p> <I<partition name>>] >>>
  20     S<<< [B<-s> <I<machine name>>] >>>
  21     [B<-d>] S<<< [B<-t> <I<dump from time>>] >>>
  22     S<<< [B<-c> <I<cell name>>] >>>
  23     [B<-no>] [B<-l>]
  24     [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
  25
  26 =for html
  27 </div>
  28
  29 =head1 DESCRIPTION
  30
  31 The B<vos size> command shows the size of a volume's dump for backup
  32 purposes. The size of the dump may differ from the volume size as reported
  33 by B<vos examine> or B<fs listquota>. The size is shown in bytes.
  34
  35 This command is intended for use with backup systems that want to size
  36 volume dumps before performing them (to optimize use of tape resources,
  37 for example).
  38
  39 =head1 OPTIONS
  40
  41 =over 4
  42
  43 =item B<-id> <I<volume name or id>>
  44
  45 Specifies either the complete name or volume ID number of the read/write,
  46 read-only, or backup volume to size.
  47
  48 =item B<-partition> <I<partition name>>
  49
  50 Specifies the partition on which the volume resides. Provide the
  51 B<-server> argument along with this one.
  52
  53 =item B<-server> <I<machine name>>
  54
  55 Specifies the file server machine on which the volume resides.  Provide
  56 the B<-partition> argument along with this one.
  57
  58 =item B<-dump>
  59
  60 Show the size of the volume dump for the specified volume. Currently, this
  61 flag should always be given for B<vos size> to give useful information.
  62 It is present to allow this command to provide other size estimates in the
  63 future.
  64
  65 =item B<-time> <I<dump from time>>
  66
  67 Specifies whether the dump is full or incremental. Omit this argument to
  68 size a full dump. See L<vos_dump(1)> for the valid values for this
  69 option.
  70
  71 =item B<-cell> <I<cell name>>
  72
  73 The cell in which the volume resides, if it's not in the current cell.
  74
  75 =item B<-noauth>
  76
  77 Assigns the unprivileged identity anonymous to the issuer. Do not combine
  78 this flag with the B<-localauth> flag. For more details, see L<vos(1)>.
  79
  80 =item B<-localauth>
  81
  82 Constructs a server ticket using a key from the local
  83 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
  84 to the Volume Server and Volume Location Server during mutual
  85 authentication. Do not combine this flag with the B<-cell> argument or
  86 B<-noauth> flag. For more details, see L<vos(1)>.
  87
  88 =item B<-verbose>
  89
  90 Show more output about what's going on.
  91
  92 =item B<-encrypt>
  93
  94 Encrypts the command so that the operation's results are not transmitted
  95 across the network in clear text. This option is available in OpenAFS
  96 versions 1.4.11 or later and 1.5.60 or later.
  97
  98 =item B<-noresolve>
  99
 100 Shows all servers as IP addresses instead of the DNS name. This is very
 101 useful when the server address is registered as 127.0.0.1 or when dealing
 102 with multi-homed servers. This option is available in OpenAFS
 103 versions 1.4.8 or later and 1.5.35 or later.
 104
 105 =item B<-help>
 106
 107 Prints the online help for this command. All other valid options are
 108 ignored.
 109
 110 =back
 111
 112 =head1 OUTPUT
 113
 114 When run without B<-verbose>, the output will be:
 115
 116    Volume: <volume>
 117    dump_size: <size>
 118
 119 where <volume> is the name of the volume and <size> is the size of the
 120 dump in bytes. With B<-verbose>, additional status messages will be
 121 printed between those two lines.
 122
 123 =head1 EXAMPLES
 124
 125 Sizing a single user volume:
 126
 127    % vos size user.thoron -dump
 128    Volume: user.thoron
 129    dump_size: 36430
 130
 131 or, more verbosely:
 132
 133    % vos size user.thoron -dump -verbose
 134    Volume: user.thoron
 135    Starting transaction on volume 2003434023... done
 136    Getting size of volume on volume 2003434023... done
 137    Ending transaction on volume 2003434023... done
 138    dump_size: 36430
 139
 140 Sizing an incremental dump for the same volume:
 141
 142    % vos size -id user.thoron -time '05/04/2007 00:00:00' -dump
 143    Volume: user.thoron
 144    dump_size: 21095
 145
 146 =head1 PRIVILEGE REQUIRED
 147
 148 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 149 machine specified with the B<-server> argument or the machine on which the
 150 volume is located if B<-server> was not given.  If the B<-localauth> flag
 151 is included, the issuer must instead be logged on to a server machine as
 152 the local superuser C<root>.
 153
 154 =head1 SEE ALSO
 155
 156 L<fs_listquota(1)>,
 157 L<vos_dump(1)>,
 158 L<vos_examine(1)>
 159
 160 =head1 COPYRIGHT
 161
 162 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
 163
 164 This documentation is covered by the BSD License as written in the
 165 doc/LICENSE file. This man page was written by Jason Edgecombe for
 166 OpenAFS.